org.jamesframework.ext.analysis

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

java.lang.Object

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

Type Parameters:

SolutionType - solution type of the analyzed problems

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

Groups results of an analysis performed by an Analysis object. The results can be accessed directly or written to a JSON file (see writeJSON(String) and writeJSON(String, JsonConverter)) that can then be loaded into R to be inspected and visualized using the james-analysis R package.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
AnalysisResults() Create an empty results object.

Method Summary

Modifier and Type	Method and Description
int	getNumProblems() Get the number of analyzed problems.
int	getNumRuns(String problemID, String searchID) Get the number of performed runs of the given search when solving the given problem.
int	getNumSearches(String problemID) Get the number of different searches that have been applied to solve the problem with the given ID.
Set<String>	getProblemIDs() Get the IDs of the analyzed problems (unmodifiable view).
SearchRunResults<SolutionType>	getRun(String problemID, String searchID, int i) Get the results of the i-th performed run of the given search when solving the given problem.
Set<String>	getSearchIDs(String problemID) Get the IDs of the different searches that have been applied to solve the problem with the given ID (unmodifiable view).
AnalysisResults<SolutionType>	merge(AnalysisResults<SolutionType> otherResults) Merge the given results into this results object.
void	registerSearchRun(String problemID, String searchID, SearchRunResults<SolutionType> run) Register results of a search run, specifying the IDs of the problem being solved and the applied search.
void	writeJSON(String filePath) Write the results to a JSON file that can be loaded into R to be inspected and visualized using the james-analysis R package.
void	writeJSON(String filePath, JsonConverter<SolutionType> solutionJsonConverter) Write the results to a JSON file that can be loaded into R to be inspected and visualized using the james-analysis R package.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalysisResults

public AnalysisResults()

Create an empty results object.

Method Detail

merge

public AnalysisResults<SolutionType> merge(AnalysisResults<SolutionType> otherResults)

Merge the given results into this results object. A copy of the newly added search runs is made.

Parameters:

otherResults - other results to be merged into this results object

Returns:

a reference to the updated results object

registerSearchRun

public void registerSearchRun(String problemID,
                              String searchID,
                              SearchRunResults<SolutionType> run)

Register results of a search run, specifying the IDs of the problem being solved and the applied search. If no runs have been registered before for this combination of problem and search, new entries are created. Else, this run is appended to the existing runs.

Parameters:

problemID - ID of the problem being solved

searchID - ID of the applied search

run - results of the search run

getNumProblems

public int getNumProblems()

Get the number of analyzed problems.

Returns:

number of analyzed problems

getProblemIDs

public Set<String> getProblemIDs()

Get the IDs of the analyzed problems (unmodifiable view).

Returns:

IDs of analyzed problems

getNumSearches

public int getNumSearches(String problemID)

Get the number of different searches that have been applied to solve the problem with the given ID.

Parameters:

problemID - ID of the problem

Returns:

number of different searches applied to solve the problem

Throws:

UnknownIDException - if an unknown problem ID is given

getSearchIDs

public Set<String> getSearchIDs(String problemID)

Get the IDs of the different searches that have been applied to solve the problem with the given ID (unmodifiable view).

Parameters:

problemID - ID of the problem

Returns:

IDs of different searches applied to solve the problem

Throws:

UnknownIDException - if an unknown problem ID is given

getNumRuns

public int getNumRuns(String problemID,
                      String searchID)

Get the number of performed runs of the given search when solving the given problem.

Parameters:

problemID - ID of the problem

searchID - ID of the applied search

Returns:

number of performed runs of the given search when solving the given problem

Throws:

UnknownIDException - if an unknown problem or search ID is given

getRun

public SearchRunResults<SolutionType> getRun(String problemID,
                                             String searchID,
                                             int i)

Get the results of the i-th performed run of the given search when solving the given problem.

Parameters:

problemID - ID of the problem

searchID - ID of the applied search

i - search run index

Returns:

results of i-th run of the given search when solving the given problem

Throws:

UnknownIDException - if an unknown problem or search ID is given

IndexOutOfBoundsException - if there is no i-th run for this search and problem

writeJSON

public void writeJSON(String filePath)
               throws IOException

Write the results to a JSON file that can be loaded into R to be inspected and visualized using the james-analysis R package. If the specified file already exists, it is overwritten. This method only stores the evaluation values and update times for each search run, skipping the actual best found solutions. If desired to store the solutions as well use writeJSON(String, JsonConverter).

Parameters:

filePath - path of the file to which the JSON output is written

Throws:

IOException - if an I/O error occurs when writing to the file

writeJSON

public void writeJSON(String filePath,
                      JsonConverter<SolutionType> solutionJsonConverter)
               throws IOException

Write the results to a JSON file that can be loaded into R to be inspected and visualized using the james-analysis R package. If the specified file already exists, it is overwritten. This method stores the evaluation values, the update times and the actual best found solution for each search run. The solutions are converted to a JSON representation using the given converter. If the latter is null, the actual solutions are not stored in the output file.

Parameters:

filePath - path of the file to which the JSON output is written

solutionJsonConverter - converts solutions to a JSON representation

Throws:

IOException - if an I/O error occurs when writing to the file