org.jamesframework.ext.analysis

Class SearchRunResults<SolutionType extends org.jamesframework.core.problems.Solution>

java.lang.Object

org.jamesframework.ext.analysis.SearchRunResults<SolutionType>

Type Parameters:

SolutionType - solution type of the analyzed problem

public class SearchRunResults<SolutionType extends org.jamesframework.core.problems.Solution>
extends Object

Contains results of a search run. For every point in time during search when a new best solution had been found, the elapsed runtime (in milliseconds) and value of the newly obtained best solution are stored. The final best solution itself is stored as well.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
SearchRunResults() Create an empty instance.
SearchRunResults(SearchRunResults<SolutionType> run) Copy constructor.

Method Summary

Modifier and Type	Method and Description
SolutionType	getBestSolution() Get the best solution found during this search run
long	getNumUpdates() Get the number of registered best solution updates.
List<Long>	getTimes() Get a list of the update times (unmodifiable view).
List<Double>	getValues() Get a list of the values of the newly found best solutions (unmodifiable view).
void	updateBestSolution(long time, double value, SolutionType newBestSolution) Update the best found solution.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchRunResults

public SearchRunResults()

Create an empty instance.

SearchRunResults

public SearchRunResults(SearchRunResults<SolutionType> run)

Copy constructor. A deep copy is made of the lists of update times and values. The final best solution is not copied; i.e. a reference to the same object is stored.

Parameters:

run - search run results to be copied

Method Detail

updateBestSolution

public void updateBestSolution(long time,
                               double value,
                               SolutionType newBestSolution)

Update the best found solution. The update time and newly obtained value are added to the list of updates and the final best solution is overwritten.

Parameters:

time - time at which the solution was found (milliseconds)

value - value of the solution

newBestSolution - newly found best solution

getNumUpdates

public long getNumUpdates()

Get the number of registered best solution updates.

Returns:

number of updates

getBestSolution

public SolutionType getBestSolution()

Get the best solution found during this search run

Returns:

best found solution

getTimes

public List<Long> getTimes()

Get a list of the update times (unmodifiable view).

Returns:

list of update times

getValues

public List<Double> getValues()

Get a list of the values of the newly found best solutions (unmodifiable view).

Returns:

list of values of newly found best solutions