LSStatistics Class

class localsolver::LSStatistics

Statistics of the search.

Summary

Functions
getRunningTime Gets the running time in seconds.
getNbIterations Gets the number of iterations.
getNbMoves DEPRECATED since 9.
getNbAcceptedMoves DEPRECATED since 9.
getNbImprovingMoves DEPRECATED since 9.
getNbRejectedMoves DEPRECATED since 9.
getNbInfeasibleMoves DEPRECATED since 9.
getPercentAcceptedMoves DEPRECATED since 9.
getPercentImprovingMoves DEPRECATED since 9.
getPercentRejectedMoves DEPRECATED since 9.
getPercentInfeasibleMoves DEPRECATED since 9.
toString Returns a string representation of the statistics.
getInfo Returns useful info about the search while running.

Functions

int getRunningTime() const

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 S_Paused or S_Stopped.

Return:Running time in seconds.

long long getNbIterations() const

Gets the number of iterations.

Only allowed in states S_Paused or S_Stopped.

Return:Number of iterations.

long long getNbMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Number of (attempted) moves.

long long getNbAcceptedMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Number of accepted moves.

long long getNbImprovingMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Number of improving moves.

long long getNbRejectedMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Number of rejected moves.

long long getNbInfeasibleMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Number of infeasible moves.

double getPercentAcceptedMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Percentage of accepted moves.

double getPercentImprovingMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Percentage of improving moves.

double getPercentRejectedMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Percentage of rejected moves.

double getPercentInfeasibleMoves() const

DEPRECATED since 9.0: This parameter gives an inaccurate view of LocalSolver search.

Only allowed in states S_Paused or S_Stopped.

Return:Percentage of infeasible moves.

std::string toString() const

Returns a string representation of the statistics.

Only allowed in states S_Paused or S_Stopped. Useful for debugging or logging purposes.

Return:String representation.

std::string getInfo() const

Returns useful info about the search while running.

Only allowed if the solver has been started at least once. Only allowed in states S_Paused or S_Stopped. Useful for debugging or logging purposes.

  • “sec” stands for the number of seconds.
  • “itr” stands for the number of iterations.
  • “infeas” corresponds to the infeasibility score of the best solution found, if infeasible.
  • “obj” corresponds to the objective values of the best solution found, if feasible.

Return:Info about the search while running.