HxStatistics Class¶
- class hexaly.optimizer.HxStatistics¶
Statistics of the search.
Summary¶
Running time in seconds. |
|
Number of iterations. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
Gets the running time in seconds. |
|
Gets the number of iterations. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
|
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search. |
Returns a string representation of the statistics. |
Instance methods¶
- HxStatistics.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
HxState.PAUSED
orHxState.STOPPED
.You can also use the shortcut member
running_time
- Returns:
Running time in seconds
- Return type:
int
- HxStatistics.get_nb_iterations()¶
Gets the number of iterations. Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.You can also use the shortcut member
nb_iterations
- Returns:
Number of iterations.
- Return type:
int
- HxStatistics.get_nb_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Number of (attempted) moves.
- Return type:
int
- HxStatistics.get_nb_accepted_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Number of accepted moves.
- Return type:
int
- HxStatistics.get_nb_improving_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Number of improving moves.
- Return type:
int
- HxStatistics.get_nb_rejected_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Number of rejected moves.
- Return type:
int
- HxStatistics.get_nb_infeasible_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Number of infeasible moves.
- Return type:
int
- HxStatistics.get_percent_accepted_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Percentage of accepted moves.
- Return type:
double
- HxStatistics.get_percent_improving_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Percentage of improving moves.
- Return type:
double
- HxStatistics.get_percent_rejected_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.STOPPED
.- Returns:
Percentage of rejected moves.
- Return type:
double
- HxStatistics.get_percent_infeasible_moves()¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
Only allowed in states
HxState.PAUSED
orHxState.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.
- HxStatistics.running_time¶
Running time in seconds. This attribute is read-only. It is a shortcut for
get_running_time()
.
- HxStatistics.nb_iterations¶
Number of iterations. This attribute is read-only. It is a shortcut for
get_nb_iterations()
.
- HxStatistics.nb_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.nb_accepted_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.nb_improving_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.nb_rejected_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.nb_infeasible_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.percent_accepted_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.percent_improving_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.percent_rejected_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
- HxStatistics.percent_infeasible_moves¶
Deprecated since version 9.0: This parameter gives an inaccurate view of Hexaly Optimizer search.
This attribute is read-only.
Special operators and methods¶
- HxStatistics.__str__()¶
Returns a string representation of the statistics. Only allowed in states
HxState.PAUSED
orHxState.STOPPED
. Useful for debugging or logging purposes.- Returns:
String representation.
- Return type:
str