org.chocosolver.solver.search.strategy.decision

Class Decision<V extends Variable>

java.lang.Object

org.chocosolver.solver.search.strategy.decision.Decision<V>

All Implemented Interfaces:

Serializable, Comparable<Decision<V>>, ICause, Identity

Direct Known Subclasses:

FastDecision, FastDecisionReal, FastDecisionSet, RootDecision

public abstract class Decision<V extends Variable>
extends Object
implements Identity, ICause, Comparable<Decision<V>>

Since:

2 juil. 2010

Author:

Charles Prud'homme

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	_ID
protected int	branch
protected boolean	once
protected Decision	previous
protected V	var

Constructor Summary

Constructors

Constructor and Description
Decision()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	apply() Apply the current decision
void	buildNext() Build the refutation, hasNext() must be called before
int	compareTo(Decision<V> o)
Decision<V>	duplicate()
abstract void	free() Free the decision, ie, it can be reused
abstract DecisionOperator<V>	getDecisionOperator()
abstract Object	getDecisionValue() Return the value object involves in the decision
V	getDecisionVariable() Return the variable object involves in the decision
int	getId()
Decision	getPrevious() Return the previous decision applied in the tree search
int	getWorldIndex()
boolean	hasNext() Return true if the decision can be refuted
void	once(boolean once) Should this decision be a one-shot decision, non refutable.
void	reverse() Reverse the decision operator
void	rewind() Force the decision to be in its creation state.
protected void	set(V var)
void	setPrevious(Decision decision) Set the previous decision applied in the tree search
void	setWorldIndex(int wi)
int	triesLeft() Return the number of branches left to try

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.chocosolver.solver.ICause

why

Field Detail

_ID

public static int _ID

var

protected V extends Variable var

branch

protected int branch

previous

protected Decision previous

once

protected boolean once

Constructor Detail

Decision

public Decision()

Method Detail

getId

public final int getId()

Specified by:

getId in interface Identity

setPrevious

public void setPrevious(Decision decision)

Set the previous decision applied in the tree search

Parameters:

decision - previous decision

getPrevious

public Decision getPrevious()

Return the previous decision applied in the tree search

Returns:

the previous decision

setWorldIndex

public void setWorldIndex(int wi)

getWorldIndex

public int getWorldIndex()

hasNext

public boolean hasNext()

Return true if the decision can be refuted

Returns:

true if the decision can be refuted, false otherwise

buildNext

public void buildNext()

Build the refutation, hasNext() must be called before

triesLeft

public int triesLeft()

Return the number of branches left to try

Returns:

number of tries left

once

public void once(boolean once)

Should this decision be a one-shot decision, non refutable.

Parameters:

once - a boolean

set

protected void set(V var)

apply

public abstract void apply()
                    throws ContradictionException

Apply the current decision

Throws:

ContradictionException

rewind

public void rewind()

Force the decision to be in its creation state.

getDecisionVariable

public V getDecisionVariable()

Return the variable object involves in the decision

Returns:

a variable V

getDecisionValue

public abstract Object getDecisionValue()

Return the value object involves in the decision

Returns:

a value object

getDecisionOperator

public abstract DecisionOperator<V> getDecisionOperator()

free

public abstract void free()

Free the decision, ie, it can be reused

reverse

public void reverse()

Reverse the decision operator

duplicate

public Decision<V> duplicate()

compareTo

public int compareTo(Decision<V> o)

Specified by:

compareTo in interface Comparable<Decision<V extends Variable>>