choco.kernel.solver.branch
Class AbstractIntBranching

java.lang.Object
  extended by choco.kernel.solver.branch.AbstractBranchingStrategy
      extended by choco.kernel.solver.branch.AbstractIntBranchingStrategy
          extended by choco.kernel.solver.branch.AbstractIntBranching
All Implemented Interfaces:
BranchingStrategy, IntBranching
Direct Known Subclasses:
AbstractBinIntBranching, AbstractLargeIntBranching

Deprecated.

@Deprecated
public abstract class AbstractIntBranching
extends AbstractIntBranchingStrategy


Field Summary
 String[] LOG_DECISION_MSG
          Deprecated.  
static String LOG_DOWN_MSG
          Deprecated.  
static String LOG_UP_MSG
          Deprecated.  
protected static Logger logger
          Deprecated. an object for logging trace statements
protected  AbstractGlobalSearchStrategy manager
          Deprecated. the main control object (responsible for the whole exploration, while the branching object is responsible only at the choice point level
protected  AbstractBranchingStrategy nextBranching
          Deprecated. a link towards the next branching object (once this one is exhausted)
 
Fields inherited from class choco.kernel.solver.branch.AbstractBranchingStrategy
LOG_DECISION_MSG_ASSIGN, LOG_DECISION_MSG_REMOVE
 
Fields inherited from interface choco.kernel.solver.branch.BranchingStrategy
LOGGER
 
Constructor Summary
AbstractIntBranching()
          Deprecated.  
 
Method Summary
 boolean finishedBranching(IntBranchingDecision decision)
          Deprecated. Checks whether all branches have already been explored at the current choice point.
abstract  boolean finishedBranching(Object x, int i)
          Deprecated. Checks whether all branches have already been explored at the current choice point.
 String getDecisionLogMessage(IntBranchingDecision decision)
          Deprecated. The logging message associated with the current decision.
abstract  String getDecisionLogMsg(int branchIndex)
          Deprecated. used for logging messages related to the search tree
abstract  int getFirstBranch(Object x)
          Deprecated. Computes the search index of the first branch of the choice point.
abstract  int getNextBranch(Object x, int i)
          Deprecated. Computes the search index of the next branch of the choice point.
 void goDownBranch(IntBranchingDecision decision)
          Deprecated. Performs the action, so that we go down a branch from the current choice point.
abstract  void goDownBranch(Object x, int i)
          Deprecated. Performs the action, so that we go down a branch from the current choice point.
 void goUpBranch(IntBranchingDecision decision)
          Deprecated. Performs the action, so that we go up the current branch to the father choice point.
abstract  void goUpBranch(Object x, int i)
          Deprecated. Performs the action, so that we go up the current branch to the father choice point.
 void initBranching()
          Deprecated. This method is called before launching the search. it may be used to intialiaze data structures or counters for instance.
 void initConstraintForBranching(SConstraint c)
          Deprecated. this method is used to build the data structure in the branching for the given constraint.
abstract  Object selectBranchingObject()
          Deprecated. selecting the object under scrutiny (that object on which an alternative will be set)
 void setFirstBranch(IntBranchingDecision decision)
          Deprecated. compute the first decision by setting a branching value or modifying the branching object
 void setNextBranch(IntBranchingDecision decision)
          Deprecated. compute the next decision by setting a branching value or modifying the branching object
 void setSolver(AbstractGlobalSearchStrategy s)
          Deprecated.  
 
Methods inherited from class choco.kernel.solver.branch.AbstractIntBranchingStrategy
getDefaultAssignMsg, getDefaultAssignOrForbidMsg
 
Methods inherited from class choco.kernel.solver.branch.AbstractBranchingStrategy
getManager, getNextBranching, setNextBranching
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

manager

protected AbstractGlobalSearchStrategy manager
Deprecated. 
the main control object (responsible for the whole exploration, while the branching object is responsible only at the choice point level


nextBranching

protected AbstractBranchingStrategy nextBranching
Deprecated. 
a link towards the next branching object (once this one is exhausted)


logger

protected static Logger logger
Deprecated. 
an object for logging trace statements


LOG_DOWN_MSG

public static String LOG_DOWN_MSG
Deprecated. 

LOG_UP_MSG

public static String LOG_UP_MSG
Deprecated. 

LOG_DECISION_MSG

public String[] LOG_DECISION_MSG
Deprecated. 
Constructor Detail

AbstractIntBranching

public AbstractIntBranching()
Deprecated. 
Method Detail

setSolver

public void setSolver(AbstractGlobalSearchStrategy s)
Deprecated. 
Overrides:
setSolver in class AbstractBranchingStrategy

getDecisionLogMsg

public abstract String getDecisionLogMsg(int branchIndex)
Deprecated. 
used for logging messages related to the search tree

Parameters:
branchIndex - is the index of the branching
Returns:
an string that will be printed between the branching object and the branch index Suggested implementations return LOG_DECISION_MSG[0] or LOG_DECISION_MSG[branchIndex]

initBranching

public void initBranching()
Deprecated. 
This method is called before launching the search. it may be used to intialiaze data structures or counters for instance.

Overrides:
initBranching in class AbstractBranchingStrategy

initConstraintForBranching

public void initConstraintForBranching(SConstraint c)
Deprecated. 
this method is used to build the data structure in the branching for the given constraint. This is used when the constraint was not present at the initialization of the branching, for example a cut

Overrides:
initConstraintForBranching in class AbstractBranchingStrategy
Parameters:
c -

selectBranchingObject

public abstract Object selectBranchingObject()
                                      throws ContradictionException
Deprecated. 
selecting the object under scrutiny (that object on which an alternative will be set)

Returns:
the object on which an alternative will be set (often a variable)
Throws:
ContradictionException

goDownBranch

public abstract void goDownBranch(Object x,
                                  int i)
                           throws ContradictionException
Deprecated. 
Performs the action, so that we go down a branch from the current choice point.

Parameters:
x - the object on which the alternative is set
i - the label of the branch that we want to go down
Throws:
ContradictionException - if a domain empties or a contradiction is infered

goUpBranch

public abstract void goUpBranch(Object x,
                                int i)
                         throws ContradictionException
Deprecated. 
Performs the action, so that we go up the current branch to the father choice point.

Parameters:
x - the object on which the alternative has been set at the father choice point
i - the label of the branch that has been travelled down from the father choice point
Throws:
ContradictionException - if a domain empties or a contradiction is infered

getFirstBranch

public abstract int getFirstBranch(Object x)
Deprecated. 
Computes the search index of the first branch of the choice point.

Parameters:
x - the object on which the alternative is set
Returns:
the index of the first branch

getNextBranch

public abstract int getNextBranch(Object x,
                                  int i)
Deprecated. 
Computes the search index of the next branch of the choice point.

Parameters:
x - the object on which the alternative is set
i - the index of the current branch
Returns:
the index of the next branch

finishedBranching

public abstract boolean finishedBranching(Object x,
                                          int i)
Deprecated. 
Checks whether all branches have already been explored at the current choice point.

Parameters:
x - the object on which the alternative is set
i - the index of the last branch
Returns:
true if no more branches can be generated

goDownBranch

public final void goDownBranch(IntBranchingDecision decision)
                        throws ContradictionException
Deprecated. 
Performs the action, so that we go down a branch from the current choice point.

Parameters:
decision - the decision to apply.
Throws:
ContradictionException - if a domain empties or a contradiction is infered

goUpBranch

public final void goUpBranch(IntBranchingDecision decision)
                      throws ContradictionException
Deprecated. 
Performs the action, so that we go up the current branch to the father choice point.

Parameters:
decision - the decision that has been set at the father choice point
Throws:
ContradictionException - if a domain empties or a contradiction is infered

setFirstBranch

public final void setFirstBranch(IntBranchingDecision decision)
Deprecated. 
compute the first decision by setting a branching value or modifying the branching object

Parameters:
decision - the current decision

setNextBranch

public final void setNextBranch(IntBranchingDecision decision)
Deprecated. 
compute the next decision by setting a branching value or modifying the branching object

Parameters:
decision - the current decision

finishedBranching

public final boolean finishedBranching(IntBranchingDecision decision)
Deprecated. 
Checks whether all branches have already been explored at the current choice point.

Parameters:
decision - the last decision applied
Returns:
true if no more branches can be generated

getDecisionLogMessage

public final String getDecisionLogMessage(IntBranchingDecision decision)
Deprecated. 
The logging message associated with the current decision.

Parameters:
decision - current decision
Returns:
logging message.


Copyright © 2012. All Rights Reserved.