LSStatistics Class

class localsolver.LSStatistics

Statistics of the search.

Summary

Attributes
running_time Running time in seconds.
nb_iterations Number of iterations.
nb_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
nb_accepted_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
nb_improving_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
nb_rejected_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
nb_infeasible_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
percent_accepted_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
percent_improving_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
percent_rejected_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
percent_infeasible_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
Methods
get_running_time Gets the running time in seconds.
get_nb_iterations Gets the number of iterations.
get_nb_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_nb_accepted_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_nb_improving_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_nb_rejected_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_nb_infeasible_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_percent_accepted_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_percent_improving_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_percent_rejected_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
get_percent_infeasible_moves Deprecated since version 9.0: This parameter gives an inaccurate view of LocalSolver search.
Special methods
__str__ Returns a string representation of the statistics.

Instance methods

LSStatistics.get_running_time()

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.

You can also use the shortcut member running_time

Returns:Running time in seconds
Return type:int
LSStatistics.get_nb_iterations()

Gets the number of iterations. Only allowed in states LSState.PAUSED or LSState.STOPPED.

You can also use the shortcut member nb_iterations

Returns:Number of iterations.
Return type:int
LSStatistics.get_nb_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Number of (attempted) moves.
Return type:int
LSStatistics.get_nb_accepted_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Number of accepted moves.
Return type:int
LSStatistics.get_nb_improving_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Number of improving moves.
Return type:int
LSStatistics.get_nb_rejected_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Number of rejected moves.
Return type:int
LSStatistics.get_nb_infeasible_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Number of infeasible moves.
Return type:int
LSStatistics.get_percent_accepted_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Percentage of accepted moves.
Return type:double
LSStatistics.get_percent_improving_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Percentage of improving moves.
Return type:double
LSStatistics.get_percent_rejected_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Percentage of rejected moves.
Return type:double
LSStatistics.get_percent_infeasible_moves()

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

Only allowed in states LSState.PAUSED or LSState.STOPPED.

Returns:Percentage of infeasible moves.
Return type:double

Instance attributes

All get/set methods have their attribute counterpart. You can use them as shortcuts to improve the readability or your models and codes.

LSStatistics.running_time

Running time in seconds. This attribute is read-only. It is a shortcut for get_running_time().

LSStatistics.nb_iterations

Number of iterations. This attribute is read-only. It is a shortcut for get_nb_iterations().

LSStatistics.nb_moves

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

This attribute is read-only.

LSStatistics.nb_accepted_moves

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

This attribute is read-only.

LSStatistics.nb_improving_moves

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

This attribute is read-only.

LSStatistics.nb_rejected_moves

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

This attribute is read-only.

LSStatistics.nb_infeasible_moves

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

This attribute is read-only.

LSStatistics.percent_accepted_moves

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

This attribute is read-only.

LSStatistics.percent_improving_moves

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

This attribute is read-only.

LSStatistics.percent_rejected_moves

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

This attribute is read-only.

LSStatistics.percent_infeasible_moves

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

This attribute is read-only.

Special operators and methods

LSStatistics.__str__()

Returns a string representation of the statistics. Only allowed in states LSState.PAUSED or LSState.STOPPED. Useful for debugging or logging purposes.

Returns:String representation.
Return type:str