IMeasures (org.choco-solver-choco-solver 3.3.1-j7 API)

All Superinterfaces:

Cloneable, ISearchMonitor, Serializable

All Known Implementing Classes:

MeasuresRecorder
```
public interface IMeasures
extends ISearchMonitor, Serializable, Cloneable
```
Interface for providing resolution statistics

Author:

Charles Prud'Homme, Jean-Guillaume Fages

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`declareObjective()` indicates an objective variable
`IMeasures`	`duplicate()` Clones the IMeasure object (copy every measure)
`long`	`getBackTrackCount()`
`Number`	`getBestSolutionValue()`
`long`	`getCurrentDepth()`
`long`	`getEventsCount()` Deprecated.
`long`	`getFailCount()`
`float`	`getInitialisationTimeCount()`
`float`	`getInitialPropagationTimeCount()`
`long`	`getMaxDepth()`
`long`	`getNodeCount()`
`long`	`getPropagationsCount()` Deprecated.
`float`	`getReadingTimeCount()`
`long`	`getRestartCount()`
`long`	`getSolutionCount()`
`float`	`getTimeCount()`
`long`	`getUsedMemory()`
`boolean`	`hasObjective()`
`boolean`	`isObjectiveOptimal()`
`void`	`reset()` Reset every measure to its default value (mostly 0)
`void`	`setObjectiveOptimal(boolean objectiveOptimal)` indicates whether or not the optimum has been found and proved
`void`	`setReadingTimeCount(long time)` set the reading time count
`long`	`timestamp()`
`Number[]`	`toArray()`
`String`	`toCSV()`
`String`	`toOneLineString()`
`String`	`toOneShortLineString()`
`String`	`toString()`
`void`	`updateMemoryUsed()` updates the memory usage count
`void`	`updatePropagationCount()` Deprecated.
`void`	`updateTimeCount()` Updates the time recorder

- Method Detail
  - duplicate
```
IMeasures duplicate()
```
    Clones the IMeasure object (copy every measure)
    
    Returns:
    a new instance of IMeasure
  - reset
```
void reset()
```
    Reset every measure to its default value (mostly 0)
  - toOneLineString
```
String toOneLineString()
```
    Returns:
    a summary of recorded statistics
  - toOneShortLineString
```
String toOneShortLineString()
```
    Returns:
    a short summary of recorded statistics
  - toString
```
String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    statistics
  - toCSV
```
String toCSV()
```
    Returns:
    statistics in a CSV format
  - toArray
```
Number[] toArray()
```
    Returns:
    statistic values only
  - timestamp
```
long timestamp()
```
    Returns:
    the current world unique id
  - getTimeCount
```
float getTimeCount()
```
    Returns:
    the time count (in sec), including initial propagation time count
  - getReadingTimeCount
```
float getReadingTimeCount()
```
    Returns:
    the reading time count (in sec)
  - getInitialisationTimeCount
```
float getInitialisationTimeCount()
```
    Returns:
    the initialization time count (in sec)
  - getInitialPropagationTimeCount
```
float getInitialPropagationTimeCount()
```
    Returns:
    the initial propagation time count (in sec)
  - setReadingTimeCount
```
void setReadingTimeCount(long time)
```
    set the reading time count
  - updateTimeCount
```
void updateTimeCount()
```
    Updates the time recorder
  - getNodeCount
```
long getNodeCount()
```
    Returns:
    the node count
  - getBackTrackCount
```
long getBackTrackCount()
```
    Returns:
    the backtrack count
  - getFailCount
```
long getFailCount()
```
    Returns:
    the fail count
  - getRestartCount
```
long getRestartCount()
```
    Returns:
    the restart count
  - getMaxDepth
```
long getMaxDepth()
```
    Returns:
    the maximum depth of the search tree
  - getCurrentDepth
```
long getCurrentDepth()
```
    Returns:
    the current depth in the search tree
  - getPropagationsCount
```
@Deprecated
long getPropagationsCount()
```
    Deprecated.
    
    Returns:
    the number of call to event recorder execution
  - updatePropagationCount
```
@Deprecated
void updatePropagationCount()
```
    Deprecated.
    
    Updates the propagation recorder
  - getEventsCount
```
@Deprecated
long getEventsCount()
```
    Deprecated.
    
    Returns:
    the fine event count (incremental propagations)
  - getUsedMemory
```
long getUsedMemory()
```
    Returns:
    the used memory
  - updateMemoryUsed
```
void updateMemoryUsed()
```
    updates the memory usage count
  - getSolutionCount
```
long getSolutionCount()
```
    Returns:
    the solution count of the measure
  - declareObjective
```
void declareObjective()
```
    indicates an objective variable
  - hasObjective
```
boolean hasObjective()
```
    Returns:
    true iff the problem has an objective variable (i.e. optimization problem)
  - setObjectiveOptimal
```
void setObjectiveOptimal(boolean objectiveOptimal)
```
    indicates whether or not the optimum has been found and proved
  - isObjectiveOptimal
```
boolean isObjectiveOptimal()
```
    Returns:
    true iff the optimum has been found and proved
  - getBestSolutionValue
```
Number getBestSolutionValue()
```
    Returns:
    the objective value of the best solution found (can be Integer or Double)

Interface IMeasures

Method Summary

Method Detail

duplicate

reset

toOneLineString

toOneShortLineString

toString

toCSV

toArray

timestamp

getTimeCount

getReadingTimeCount

getInitialisationTimeCount

getInitialPropagationTimeCount

setReadingTimeCount

updateTimeCount

getNodeCount

getBackTrackCount

getFailCount

getRestartCount

getMaxDepth

getCurrentDepth

getPropagationsCount

updatePropagationCount

getEventsCount

getUsedMemory

updateMemoryUsed

getSolutionCount

declareObjective

hasObjective

setObjectiveOptimal

isObjectiveOptimal

getBestSolutionValue