Package org.optaplanner.core.config.solver.monitoring

Enum SolverMetric

java.lang.Object

java.lang.Enum<SolverMetric>

org.optaplanner.core.config.solver.monitoring.SolverMetric

All Implemented Interfaces:

Serializable, Comparable<SolverMetric>

public enum SolverMetric
extends Enum<SolverMetric>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BEST_SCORE
BEST_SOLUTION_MUTATION
CONSTRAINT_MATCH_TOTAL_BEST_SCORE
CONSTRAINT_MATCH_TOTAL_STEP_SCORE
ERROR_COUNT
MEMORY_USE
MOVE_COUNT_PER_STEP
PICKED_MOVE_TYPE_BEST_SCORE_DIFF
PICKED_MOVE_TYPE_STEP_SCORE_DIFF
SCORE_CALCULATION_COUNT
SOLVE_DURATION
STEP_SCORE

Method Summary

Modifier and Type	Method	Description
String	getMeterId()
boolean	isMetricBestSolutionBased()
void	register(Solver<?> solver)
static void	registerScoreMetrics(SolverMetric metric, io.micrometer.core.instrument.Tags tags, ScoreDefinition<?> scoreDefinition, Map<io.micrometer.core.instrument.Tags,List<AtomicReference<Number>>> tagToScoreLevels, Score<?> score)
void	unregister(Solver<?> solver)
static SolverMetric	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SolverMetric[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SOLVE_DURATION

public static final SolverMetric SOLVE_DURATION

ERROR_COUNT

public static final SolverMetric ERROR_COUNT

BEST_SCORE

public static final SolverMetric BEST_SCORE

STEP_SCORE

public static final SolverMetric STEP_SCORE

SCORE_CALCULATION_COUNT

public static final SolverMetric SCORE_CALCULATION_COUNT

BEST_SOLUTION_MUTATION

public static final SolverMetric BEST_SOLUTION_MUTATION

MOVE_COUNT_PER_STEP

public static final SolverMetric MOVE_COUNT_PER_STEP

MEMORY_USE

public static final SolverMetric MEMORY_USE

CONSTRAINT_MATCH_TOTAL_BEST_SCORE

public static final SolverMetric CONSTRAINT_MATCH_TOTAL_BEST_SCORE

CONSTRAINT_MATCH_TOTAL_STEP_SCORE

public static final SolverMetric CONSTRAINT_MATCH_TOTAL_STEP_SCORE

PICKED_MOVE_TYPE_BEST_SCORE_DIFF

public static final SolverMetric PICKED_MOVE_TYPE_BEST_SCORE_DIFF

PICKED_MOVE_TYPE_STEP_SCORE_DIFF

public static final SolverMetric PICKED_MOVE_TYPE_STEP_SCORE_DIFF

Method Detail

values

public static SolverMetric[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SolverMetric c : SolverMetric.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SolverMetric valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getMeterId

public String getMeterId()

registerScoreMetrics

public static void registerScoreMetrics(SolverMetric metric,
                                        io.micrometer.core.instrument.Tags tags,
                                        ScoreDefinition<?> scoreDefinition,
                                        Map<io.micrometer.core.instrument.Tags,List<AtomicReference<Number>>> tagToScoreLevels,
                                        Score<?> score)

isMetricBestSolutionBased

public boolean isMetricBestSolutionBased()

register

public void register(Solver<?> solver)

unregister

public void unregister(Solver<?> solver)