TraceGenerator (jacop 4.2.0 API)

java.lang.Object
- org.jacop.search.TraceGenerator<T>

All Implemented Interfaces:

ConsistencyListener, ExitChildListener<T>, ExitListener, SelectChoicePoint<T>
```
public class TraceGenerator<T extends Var>
extends Object
implements SelectChoicePoint<T>, ConsistencyListener, ExitChildListener<T>, ExitListener
```
TODO TraceGenerator should accept as input to constructor a Search object. It should get all the previous listeners and establish itself as the parent of those listeners and substitute them for itself in the search provided. It should ask them to get the proper return value for listener functions which are returning a code. It should later act as suggested by those listeners. This way there may be no need for checking/informing trace if we search for all solutions or just one. However, on safety side before TraceGenerator object is created and search object passed to it maybe search object should be already properly set. Can we wrap one TraceGenerator within another TraceGenerator? It should be possible. getChoiceVariable in TraceGenerator assumes that the internal select choice point does not return choice point as primitive constraint. It incorrectly assumes that if no variable is given by getChoiceVariable then the search is finished. We need all check that getChoiceConstraint returns false. Can CPviz handle search for Set variables handle correctly 100%? If not maybe we should just make TraceGenerator? FilterDom should not use string representation of the domain just use Enumeration to get values within domain and create required String. It should be more or less the same what toString() of domain is doing.

Field Summary

Fields
Modifier and Type	Field and Description
`ArrayList<Var>`	`tracedVar` It specifies the list of variables that are being traced.
`String`	`treeFilename` The file containing information about tree for CPviz format.
`HashMap<Var,Integer>`	`varIndex`
`String`	`visFilename` The file containing visualisation information.

Constructor Summary

Constructors
Constructor and Description
`TraceGenerator(Search<T> search, SelectChoicePoint<T> select)` It creates a CPviz trace generator around proper select choice point object.
`TraceGenerator(Search<T> search, SelectChoicePoint<T> select, String treeFilename, String visFilename)` It creates a CPviz trace generator around proper select choice point object.
`TraceGenerator(Search<T> search, SelectChoicePoint<T> select, Var[] vars)` It creates a CPviz trace generator around proper select choice point object.
`TraceGenerator(Search<T> search, SelectChoicePoint<T> select, Var[] vars, String treeFilename, String visFilename)` It creates a CPviz trace generator around proper select choice point object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTracedVar(Var v)`
`boolean`	`executeAfterConsistency(boolean consistent)` It is executed right after consistency of the current search node.
`void`	`executedAtExit(Store store, int solutionsNo)` It is executed right after time out is determined.
`PrimitiveConstraint`	`getChoiceConstraint(int index)` It returns the constraint which is the base of the choice point.
`int`	`getChoiceValue()` It returns a value which is the base of the next choice point.
`T`	`getChoiceVariable(int index)` It returns the variable which is the base on the next choice point.
`int`	`getIndex()` It returns the current index.
`IdentityHashMap<T,Integer>`	`getVariablesMapping()` It specifies the position of variables as given when variables of this select object were supplied.
`boolean`	`leftChild(PrimitiveConstraint choice, boolean status)` It is executed after exiting the left child.
`boolean`	`leftChild(T var, int value, boolean status)` It is executed after exiting the left child.
`void`	`rightChild(PrimitiveConstraint choice, boolean status)` It is executed after exiting the right child.
`void`	`rightChild(T var, int value, boolean status)` It is executed after exiting the right child.
`void`	`setChildrenListeners(ConsistencyListener child)` Setting one child listener.
`void`	`setChildrenListeners(ConsistencyListener[] children)` Each of the child listeners will be called and the return code from them will be combined (taken into account) by a parent).
`void`	`setChildrenListeners(ExitChildListener<T> child)` It adds one child listener.
`void`	`setChildrenListeners(ExitChildListener<T>[] children)` It sets the children listeners for the current listener.
`void`	`setChildrenListeners(ExitListener child)` It sets one child listener.
`void`	`setChildrenListeners(ExitListener[] children)` It sets the children of this exit listener.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - treeFilename
```
public final String treeFilename
```
    The file containing information about tree for CPviz format.
  - visFilename
```
public final String visFilename
```
    The file containing visualisation information.
  - tracedVar
```
public ArrayList<Var> tracedVar
```
    It specifies the list of variables that are being traced.
  - varIndex
```
public HashMap<Var,Integer> varIndex
```
- Constructor Detail
  - TraceGenerator
```
public TraceGenerator(Search<T> search,
                      SelectChoicePoint<T> select)
```
    It creates a CPviz trace generator around proper select choice point object.
    
    Parameters:
    
    search - it specifies search method used for depth-first-search.
    
    select - it specifies how the select choice points are being generated.
  - TraceGenerator
```
public TraceGenerator(Search<T> search,
                      SelectChoicePoint<T> select,
                      String treeFilename,
                      String visFilename)
```
    It creates a CPviz trace generator around proper select choice point object.
    
    Parameters:
    
    search - it specifies search method used for depth-first-search.
    
    select - it specifies how the select choice points are being generated.
    
    treeFilename - it specifies the file name for search tree trace (default tree.xml).
    
    visFilename - it specifies the file name for variable trace (default vis.xml).
  - TraceGenerator
```
public TraceGenerator(Search<T> search,
                      SelectChoicePoint<T> select,
                      Var[] vars)
```
    It creates a CPviz trace generator around proper select choice point object.
    
    Parameters:
    
    search - it specifies search method used for depth-first-search.
    
    select - it specifies how the select choice points are being generated.
    
    vars - it specifies variables which are being traced.
  - TraceGenerator
```
public TraceGenerator(Search<T> search,
                      SelectChoicePoint<T> select,
                      Var[] vars,
                      String treeFilename,
                      String visFilename)
```
    It creates a CPviz trace generator around proper select choice point object.
    
    Parameters:
    
    search - it specifies search method used for depth-first-search.
    
    select - it specifies how the select choice points are being generated.
    
    vars - it specifies variables which are being traced.
    
    treeFilename - it specifies the file name for search tree trace (default tree.xml).
    
    visFilename - it specifies the file name for variable trace (default vis.xml).
- Method Detail
  - getChoiceVariable
```
public T getChoiceVariable(int index)
```
    Description copied from interface: SelectChoicePoint
    
    It returns the variable which is the base on the next choice point. Only if choice is of an X = C type. This function returns null if all variables have a value assigned or a choice point based on other type of constraint is being selected. The parameter index is the last variable which have been return by this SelectChoicePoint object which has not been backtracked upon yet.
    
    Specified by:
    
    getChoiceVariable in interface SelectChoicePoint<T extends Var>
    
    Parameters:
    
    index - the position of the last variable in selection choice point heuristic.
    
    Returns:
    
    variable based on which the choice needs to be created.
  - getChoiceValue
```
public int getChoiceValue()
```
    Description copied from interface: SelectChoicePoint
    
    It returns a value which is the base of the next choice point. Only if choice is of an getChoiceVariable() = getChoiceValue() type.
    
    Specified by:
    
    getChoiceValue in interface SelectChoicePoint<T extends Var>
    
    Returns:
    
    value used in the choice point (value).
  - getChoiceConstraint
```
public PrimitiveConstraint getChoiceConstraint(int index)
```
    Description copied from interface: SelectChoicePoint
    
    It returns the constraint which is the base of the choice point. If the return value is equal to null and choice point is also not based on X = C type of constraint then all variables have been assigned a value.
    
    Specified by:
    
    getChoiceConstraint in interface SelectChoicePoint<T extends Var>
    
    Parameters:
    
    index - the position of the last variable returned by selection choice point heuristic.
    
    Returns:
    
    primitive constraint which is a base of a choice point.
  - getVariablesMapping
```
public IdentityHashMap<T,Integer> getVariablesMapping()
```
    Description copied from interface: SelectChoicePoint
    
    It specifies the position of variables as given when variables of this select object were supplied.
    
    Specified by:
    
    getVariablesMapping in interface SelectChoicePoint<T extends Var>
    
    Returns:
    
    mapping of variables to the positions in the variables array.
  - getIndex
```
public int getIndex()
```
    Description copied from interface: SelectChoicePoint
    
    It returns the current index. Supplying this value in the next invocation of select will make search for next variable faster without compromising efficiency.
    
    Specified by:
    
    getIndex in interface SelectChoicePoint<T extends Var>
    
    Returns:
    
    internal position of the last variable chosen to be the base of the choice point.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setChildrenListeners
```
public void setChildrenListeners(ConsistencyListener[] children)
```
    Description copied from interface: ConsistencyListener
    
    Each of the child listeners will be called and the return code from them will be combined (taken into account) by a parent).
    
    Specified by:
    
    setChildrenListeners in interface ConsistencyListener
    
    Parameters:
    
    children - the children listeners attached to this listener.
  - setChildrenListeners
```
public void setChildrenListeners(ConsistencyListener child)
```
    Description copied from interface: ConsistencyListener
    
    Setting one child listener.
    
    Specified by:
    
    setChildrenListeners in interface ConsistencyListener
    
    Parameters:
    
    child - the only child listener added to this consistency listener.
  - executeAfterConsistency
```
public boolean executeAfterConsistency(boolean consistent)
```
    Description copied from interface: ConsistencyListener
    
    It is executed right after consistency of the current search node. Returning true when the parameter was false is not advised as things like invalid solutions can be found.
    
    Specified by:
    
    executeAfterConsistency in interface ConsistencyListener
    
    Parameters:
    
    consistent - specifies if the consistency call returned true or false.
    
    Returns:
    
    true if the search should continue, false if the search should act as the consistency returned false.
  - setChildrenListeners
```
public void setChildrenListeners(ExitChildListener<T>[] children)
```
    Description copied from interface: ExitChildListener
    
    It sets the children listeners for the current listener.
    
    Specified by:
    
    setChildrenListeners in interface ExitChildListener<T extends Var>
    
    Parameters:
    
    children - array containing children listeners.
  - setChildrenListeners
```
public void setChildrenListeners(ExitListener[] children)
```
    Description copied from interface: ExitListener
    
    It sets the children of this exit listener.
    
    Specified by:
    
    setChildrenListeners in interface ExitListener
    
    Parameters:
    
    children - an array containing the children.
  - leftChild
```
public boolean leftChild(T var,
                         int value,
                         boolean status)
```
    Description copied from interface: ExitChildListener
    
    It is executed after exiting the left child.
    
    Specified by:
    
    leftChild in interface ExitChildListener<T extends Var>
    
    Parameters:
    
    var - variable used in the choice point.
    
    value - value used in the choice point.
    
    status - true if the solution was found in the child subtree, false otherwise.
    
    Returns:
    
    true if the search should continue undisturbed, false if it should exit the current node with false
  - leftChild
```
public boolean leftChild(PrimitiveConstraint choice,
                         boolean status)
```
    Description copied from interface: ExitChildListener
    
    It is executed after exiting the left child.
    
    Specified by:
    
    leftChild in interface ExitChildListener<T extends Var>
    
    Parameters:
    
    choice - primitive constraint used as the base of the choice point.
    
    status - true if the solution was found in the child subtree, false otherwise.
    
    Returns:
    
    true if the search should continue undisturbed to the right node, false if it should exit the current node with false
  - rightChild
```
public void rightChild(T var,
                       int value,
                       boolean status)
```
    Description copied from interface: ExitChildListener
    
    It is executed after exiting the right child.
    
    Specified by:
    
    rightChild in interface ExitChildListener<T extends Var>
    
    Parameters:
    
    var - variable used in the choice point.
    
    value - value used in the choice point.
    
    status - true if the solution was found in the child subtree, false otherwise. exit the current node with false
  - rightChild
```
public void rightChild(PrimitiveConstraint choice,
                       boolean status)
```
    Description copied from interface: ExitChildListener
    
    It is executed after exiting the right child.
    
    Specified by:
    
    rightChild in interface ExitChildListener<T extends Var>
    
    Parameters:
    
    choice - primitive constraint used as the base of the choice point.
    
    status - true if the solution was found in the child subtree, false otherwise. exit the current node with false
  - setChildrenListeners
```
public void setChildrenListeners(ExitChildListener<T> child)
```
    Description copied from interface: ExitChildListener
    
    It adds one child listener.
    
    Specified by:
    
    setChildrenListeners in interface ExitChildListener<T extends Var>
    
    Parameters:
    
    child - added child listener.
  - setChildrenListeners
```
public void setChildrenListeners(ExitListener child)
```
    Description copied from interface: ExitListener
    
    It sets one child listener.
    
    Specified by:
    
    setChildrenListeners in interface ExitListener
    
    Parameters:
    
    child - the only child listener used by this listener.
  - executedAtExit
```
public void executedAtExit(Store store,
                           int solutionsNo)
```
    Description copied from interface: ExitListener
    
    It is executed right after time out is determined.
    
    Specified by:
    
    executedAtExit in interface ExitListener
    
    Parameters:
    
    store - store in the context of which the search took place.
    
    solutionsNo - the number of solutions found.
  - addTracedVar
```
public void addTracedVar(Var v)
```

Class TraceGenerator<T extends Var>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

treeFilename

visFilename

tracedVar

varIndex

Constructor Detail

TraceGenerator

TraceGenerator

TraceGenerator

TraceGenerator

Method Detail

getChoiceVariable

getChoiceValue

getChoiceConstraint

getVariablesMapping

getIndex

toString

setChildrenListeners

setChildrenListeners

executeAfterConsistency

setChildrenListeners

setChildrenListeners

leftChild

leftChild

rightChild

rightChild

setChildrenListeners

setChildrenListeners

executedAtExit

addTracedVar