localsolver

Class LSStatistics

java.lang.Object

localsolver.LSStatistics

public class LSStatistics
extends java.lang.Object

Statistics of the search. The statistics are useful for evaluating the quality of your model. Indeed, your model is suited for LocalSolver (and more generally for local search) if the percentage of accepted moves is larger than 1 % with an annealing level equal to 0. Larger is the percentage of accepted moves, larger is the diversification of the search, better is the convergence toward high-quality solutions. If the number of accepted moves is too low, we suggests you to relax some constraints of the model (goal programming) or to augment the annealing level. A fine modeling is much preferable to a fine tuning of the search, both for effectiveness and for robustness.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getInfo() Returns useful info about the search while running.
LocalSolver	getLocalSolver() Returns the LocalSolver object associated to these statistics.
long	getNbAcceptedMoves() Gets the number of accepted moves.
long	getNbImprovingMoves() Gets the number of accepted moves having improved the cost of the current solution.
long	getNbInfeasibleMoves() Gets the number of moves leading to infeasible solutions.
long	getNbIterations() Gets the number of iterations.
long	getNbMoves() Gets the number of (attempted) moves.
long	getNbRejectedMoves() Gets the number of rejected moves.
double	getPercentAcceptedMoves() Gives the percentage of accepted moves relative to the number of moves.
double	getPercentImprovingMoves() Gives the percentage of improving moves relative to the number of moves.
double	getPercentInfeasibleMoves() Gives the percentage of infeasible moves relative to the number of moves.
double	getPercentRejectedMoves() Gives the percentage of rejected moves relative to the number of moves.
int	getRunningTime() Gets the running time in seconds.
int	hashCode()
java.lang.String	toString() Returns a String representation of the statistics.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getLocalSolver

public LocalSolver getLocalSolver()

Returns the LocalSolver object associated to these statistics.

Returns:

LocalSolver object.

getRunningTime

public int getRunningTime()

Gets the running time in seconds. Note that is the "real" time spent (and not only the CPU or system time). Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Running time in seconds.

getNbIterations

public long getNbIterations()

Gets the number of iterations. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Number of iterations.

getNbMoves

public long getNbMoves()

Gets the number of (attempted) moves. This corresponds to the number of explored solutions (feasible or infeasible). Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Number of (attempted) moves.

getNbAcceptedMoves

public long getNbAcceptedMoves()

Gets the number of accepted moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Number of accepted moves.

getNbImprovingMoves

public long getNbImprovingMoves()

Gets the number of accepted moves having improved the cost of the current solution. Improving moves are a part of accepted moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Number of improving moves.

getNbRejectedMoves

public long getNbRejectedMoves()

Gets the number of rejected moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Number of rejected moves.

getNbInfeasibleMoves

public long getNbInfeasibleMoves()

Gets the number of moves leading to infeasible solutions. Infeasible moves are a part of rejected moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Number of infeasible moves.

getPercentAcceptedMoves

public double getPercentAcceptedMoves()

Gives the percentage of accepted moves relative to the number of moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Percentage of accepted moves.

getPercentImprovingMoves

public double getPercentImprovingMoves()

Gives the percentage of improving moves relative to the number of moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Percentage of improving moves.

getPercentRejectedMoves

public double getPercentRejectedMoves()

Gives the percentage of rejected moves relative to the number of moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Percentage of rejected moves.

getPercentInfeasibleMoves

public double getPercentInfeasibleMoves()

Gives the percentage of infeasible moves relative to the number of moves. Only allowed in states LSState.Paused or LSState.Stopped.

Returns:

Percentage of infeasible moves.

toString

public java.lang.String toString()

Returns a String representation of the statistics. Only allowed in states LSState.Paused or LSState.Stopped. Useful for debugging or logging purposes.

Overrides:

toString in class java.lang.Object

Returns:

String representation.

getInfo

public java.lang.String getInfo()

Returns useful info about the search while running. Only allowed if the solver has been started at least once. Only allowed in states LSState.Paused or LSState.Stopped. Useful for debugging or logging purposes. Here are some explanations about the output string:

• "mov" corresponds to the number of moves performed.
• "inf" corresponds to the percentage of infeasible moves.
• "acc" corresponds to the percentage of accepted moves.
• "imp" corresponds to the number of improving moves.

Returns:

Info about the search while running.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object