LocalSolver logo
is now
Hexaly logo

We're excited to share that we are moving forward. We're leaving behind the LocalSolver brand and transitioning to our new identity: Hexaly. This represents a leap forward in our mission to enable every organization to make better decisions faster when faced with operational and strategic challenges.

This page is for an old version of Hexaly Optimizer. We recommend that you update your version and read the documentation for the latest stable release.

LSStatistics Class

class localsolver.LSStatistics

Statistics of the search.

Summary

Methods
GetLocalSolver Returns the LocalSolver object associated to these statistics.
GetRunningTime Gets the running time in seconds.
GetNbIterations Gets the number of iterations.
GetNbMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetNbAcceptedMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetNbImprovingMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetNbRejectedMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetNbInfeasibleMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetPercentAcceptedMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetPercentImprovingMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetPercentRejectedMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetPercentInfeasibleMoves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
GetInfo Returns useful info about the search while running.
ToString Returns a string representation of the statistics.

Instance methods

LocalSolver GetLocalSolver()

Returns the LocalSolver object associated to these statistics.

Returns:LocalSolver object
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 Plaused or Stopped.

Returns:Running time in seconds.
long GetNbIterations()

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

long GetNbMoves()

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

Only allowed in states Paused or Stopped.

Returns:Number of (attempted) moves.
long GetNbAcceptedMoves()

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

Only allowed in states Paused or Stopped.

Returns:Number of accepted moves.
long GetNbImprovingMoves()

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

Only allowed in states Paused or Stopped.

Returns:Number of improving moves.
long GetNbRejectedMoves()

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

Only allowed in states Paused or Stopped.

Returns:Number of rejected moves.
long GetNbInfeasibleMoves()

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

Only allowed in states

Paused or Stopped.

return:Number of infeasible moves.
double GetPercentAcceptedMoves()

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

Only allowed in states Paused or Stopped.

Returns:Percentage of accepted moves.
double GetPercentImprovingMoves()

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

Only allowed in states Paused or Stopped.

Returns:Percentage of improving moves.
double GetPercentRejectedMoves()

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

Only allowed in states Paused or Stopped.

Returns:Percentage of rejected moves.
double GetPercentInfeasibleMoves()

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

Only allowed in states Paused or Stopped.

Returns:Percentage of infeasible moves.
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 Paused or Stopped. Useful for debugging or logging purposes.

Returns:Info about the search while running.
string ToString()

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

Returns:String representation.