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.
`info`	Useful info about the 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.
`get_info`	Returns useful info about the search while running.

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.

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.

You can also use the shortcut member nb_moves

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.

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

You can also use the shortcut member nb_accepted_moves

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.

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.
Return type:	`int`

LSStatistics.get_nb_rejected_moves()¶

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

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

You can also use the shortcut member nb_rejected_moves

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.

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.

You can also use the shortcut member nb_infeasible_moves

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.

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

You can also use the shortcut member percent_accepted_moves

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.

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

You can also use the shortcut member percent_improving_moves

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.

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

You can also use the shortcut member percent_rejected_moves

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.

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

You can also use the shortcut member percent_infeasible_moves

Returns:	Percentage of infeasible moves.
Return type:	`double`

LSStatistics.get_info()¶

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.

Returns:	Info about the search while running.
Return type:	`str`

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.

Number of attempted moves. This attribute is read-only. It is a shortcut for get_nb_moves().

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

Number of accepted moves. This attribute is read-only. It is a shortcut for get_nb_accepted_moves().

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

Number of improving moves. This attribute is read-only. It is a shortcut for get_nb_improving_moves().

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

Number of rejected moves. This attribute is read-only. It is a shortcut for get_nb_rejected_moves().

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

Number of infeasible moves. This attribute is read-only. It is a shortcut for get_nb_infeasible_moves().

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

Percentage of accepted moves relative to the number of moves. This attribute is read-only. It is a shortcut for get_percent_accepted_moves().

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

Percentage of improving moves relative to the number of moves. This attribute is read-only. It is a shortcut for get_percent_improving_moves().

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

Percentage of rejected moves relative to the number of moves. This attribute is read-only. It is a shortcut for get_percent_rejected_moves().

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

Percentage of infeasible moves relative to the number of moves. This attribute is read-only. It is a shortcut for get_percent_infeasible_moves().

LSStatistics.info¶: Useful info about the search. This attribute is read-only. It is a shortcut for get_info().

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`