org.optaplanner.benchmark.impl.result

Class ProblemBenchmarkResult

java.lang.Object

org.optaplanner.benchmark.impl.result.ProblemBenchmarkResult

public class ProblemBenchmarkResult
extends Object

Represents 1 problem instance (data set) benchmarked on multiple Solver configurations.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description
ProblemBenchmarkResult(PlannerBenchmarkResult plannerBenchmarkResult)

Method Summary

Methods

Modifier and Type	Method and Description
void	accumulateResults(BenchmarkReport benchmarkReport)
protected static Map<ProblemBenchmarkResult,ProblemBenchmarkResult>	createMergeMap(PlannerBenchmarkResult newPlannerBenchmarkResult, List<SingleBenchmarkResult> singleBenchmarkResultList)
boolean	equals(Object o) Used by ProblemBenchmarksConfig.buildProblemBenchmarkList(SolverBenchmarkResult).
List<PureSubSingleStatistic>	extractPureSubSingleStatisticList(SingleStatisticType singleStatisticType)
Collection<SingleStatisticType>	extractSingleStatisticTypeList()
String	getAnchorId()
Long	getAverageUsedMemoryAfterInputSolution()
File	getBenchmarkReportDirectory()
Long	getEntityCount()
Integer	getFailureCount()
File	getInputSolutionFile()
Integer	getMaximumSubSingleCount()
String	getName()
PlannerBenchmarkResult	getPlannerBenchmarkResult()
File	getProblemReportDirectory()
String	getProblemReportDirectoryPath()
Long	getProblemScale()
List<ProblemStatistic>	getProblemStatisticList()
List<SingleBenchmarkResult>	getSingleBenchmarkResultList()
org.optaplanner.persistence.common.api.domain.solution.SolutionFileIO	getSolutionFileIO()
int	getTotalSubSingleCount()
Long	getVariableCount()
SingleBenchmarkResult	getWinningSingleBenchmarkResult()
SingleBenchmarkResult	getWorstSingleBenchmarkResult()
boolean	hasAnyFailure()
boolean	hasAnyStatistic()
boolean	hasAnySuccess()
int	hashCode()
boolean	hasProblemStatisticType(ProblemStatisticType problemStatisticType)
boolean	isWriteOutputSolutionEnabled()
void	makeDirs()
Solution	readPlanningProblem()
void	registerScale(long registeringEntityCount, long registeringVariableCount, long registeringProblemScale) HACK to avoid loading the planningProblem just to extract it's problemScale.
void	setInputSolutionFile(File inputSolutionFile)
void	setName(String name)
void	setPlannerBenchmarkResult(PlannerBenchmarkResult plannerBenchmarkResult)
void	setProblemStatisticList(List<ProblemStatistic> problemStatisticList)
void	setSingleBenchmarkResultList(List<SingleBenchmarkResult> singleBenchmarkResultList)
void	setSolutionFileIO(org.optaplanner.persistence.common.api.domain.solution.SolutionFileIO solutionFileIO)
void	setWriteOutputSolutionEnabled(boolean writeOutputSolutionEnabled)
String	toString()
void	writeOutputSolution(SubSingleBenchmarkResult subSingleBenchmarkResult, Solution outputSolution)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected final transient org.slf4j.Logger logger

Constructor Detail

ProblemBenchmarkResult

public ProblemBenchmarkResult(PlannerBenchmarkResult plannerBenchmarkResult)

Method Detail

getPlannerBenchmarkResult

public PlannerBenchmarkResult getPlannerBenchmarkResult()

setPlannerBenchmarkResult

public void setPlannerBenchmarkResult(PlannerBenchmarkResult plannerBenchmarkResult)

getName

public String getName()

Returns:

never null, filename safe

setName

public void setName(String name)

getSolutionFileIO

public org.optaplanner.persistence.common.api.domain.solution.SolutionFileIO getSolutionFileIO()

setSolutionFileIO

public void setSolutionFileIO(org.optaplanner.persistence.common.api.domain.solution.SolutionFileIO solutionFileIO)

isWriteOutputSolutionEnabled

public boolean isWriteOutputSolutionEnabled()

setWriteOutputSolutionEnabled

public void setWriteOutputSolutionEnabled(boolean writeOutputSolutionEnabled)

getInputSolutionFile

public File getInputSolutionFile()

setInputSolutionFile

public void setInputSolutionFile(File inputSolutionFile)

getProblemStatisticList

public List<ProblemStatistic> getProblemStatisticList()

setProblemStatisticList

public void setProblemStatisticList(List<ProblemStatistic> problemStatisticList)

getSingleBenchmarkResultList

public List<SingleBenchmarkResult> getSingleBenchmarkResultList()

setSingleBenchmarkResultList

public void setSingleBenchmarkResultList(List<SingleBenchmarkResult> singleBenchmarkResultList)

getEntityCount

public Long getEntityCount()

getVariableCount

public Long getVariableCount()

getProblemScale

public Long getProblemScale()

getMaximumSubSingleCount

public Integer getMaximumSubSingleCount()

getAverageUsedMemoryAfterInputSolution

public Long getAverageUsedMemoryAfterInputSolution()

getFailureCount

public Integer getFailureCount()

getWinningSingleBenchmarkResult

public SingleBenchmarkResult getWinningSingleBenchmarkResult()

getWorstSingleBenchmarkResult

public SingleBenchmarkResult getWorstSingleBenchmarkResult()

getAnchorId

public String getAnchorId()

getBenchmarkReportDirectory

public File getBenchmarkReportDirectory()

hasAnyFailure

public boolean hasAnyFailure()

hasAnySuccess

public boolean hasAnySuccess()

hasAnyStatistic

public boolean hasAnyStatistic()

hasProblemStatisticType

public boolean hasProblemStatisticType(ProblemStatisticType problemStatisticType)

extractSingleStatisticTypeList

public Collection<SingleStatisticType> extractSingleStatisticTypeList()

extractPureSubSingleStatisticList

public List<PureSubSingleStatistic> extractPureSubSingleStatisticList(SingleStatisticType singleStatisticType)

getProblemReportDirectoryPath

public String getProblemReportDirectoryPath()

getProblemReportDirectory

public File getProblemReportDirectory()

makeDirs

public void makeDirs()

getTotalSubSingleCount

public int getTotalSubSingleCount()

readPlanningProblem

public Solution readPlanningProblem()

writeOutputSolution

public void writeOutputSolution(SubSingleBenchmarkResult subSingleBenchmarkResult,
                       Solution outputSolution)

accumulateResults

public void accumulateResults(BenchmarkReport benchmarkReport)

registerScale

public void registerScale(long registeringEntityCount,
                 long registeringVariableCount,
                 long registeringProblemScale)

HACK to avoid loading the planningProblem just to extract it's problemScale. Called multiple times, for every SingleBenchmarkResult of this ProblemBenchmarkResult.

Parameters:

registeringEntityCount - >= 0

registeringVariableCount - >= 0

registeringProblemScale - >= 0

equals

public boolean equals(Object o)

Used by ProblemBenchmarksConfig.buildProblemBenchmarkList(SolverBenchmarkResult).

Overrides:

equals in class Object

Parameters:

o - sometimes null

Returns:

true if equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createMergeMap

protected static Map<ProblemBenchmarkResult,ProblemBenchmarkResult> createMergeMap(PlannerBenchmarkResult newPlannerBenchmarkResult,
                                                                List<SingleBenchmarkResult> singleBenchmarkResultList)

toString

public String toString()

Overrides:

toString in class Object