ilog.cp

Class IloCPEngine

java.lang.Object

ilog.cp.IloCPEngine

public class IloCPEngine
extends java.lang.Object

An instance of this class represents a backtracking search engine for CP Optimizer.

You never need to create an instance of this class. The master IloCP object will create instances of this class which you can then use in your own CP Optimizer extensions code in Java if you need to define subclasses of one of IloCustomXXX classes.

See Also:

IloCustomConstraint, IloCustomIntValueChooser, IloCustomIntValueEval, IloCustomIntVarChooser, IloCustomIntVarEval

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IloCPEngine.IntInfo Symbolc names for integer information of IloCPEngine.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDomainSize(IloNumVar var) This member function returns the size of the domain of variable var as maintained in the invoking instance of IloCPEngine.
ilog.cp.cppimpl.IloCPEngine	getImpl()
int	getInfo(IloCPEngine.IntInfo which) This method returns the value of the integer information which in the invoked IloCPEngine instance.
IloCP	getMasterCP() This method returns the master IloCP class which created the invoking IloCPEngine object.
double	getMax(IloNumVar var) This member function returns the maximum value of the variable var in the invoking instance of IloCPEngine.
double	getMin(IloNumVar var) This member function returns the minimum value of the variable var in the invoking instance of IloCPEngine.
boolean	isFixed(IloNumVar var) This member function indicates if the domain of var takes on a particular value as maintained by the invoking IloCPEngine instance.
boolean	isInDomain(IloNumVar var, int value) This member function indicates whether value is contained in the current domain of var as maintained by the invoking IloCPEngine instance.
java.util.Iterator	iterator(IloIntVar var) This member function returns an iterator to iterate over the domain of var, as maintained by the invoking IloCPEngine.

Methods inherited from class java.lang.Object

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

Method Detail

getImpl

public ilog.cp.cppimpl.IloCPEngine getImpl()

getMasterCP

public IloCP getMasterCP()

This method returns the master IloCP class which created the invoking IloCPEngine object.

getMin

public double getMin(IloNumVar var)

This member function returns the minimum value of the variable var in the invoking instance of IloCPEngine.

getMax

public double getMax(IloNumVar var)

This member function returns the maximum value of the variable var in the invoking instance of IloCPEngine.

isInDomain

public boolean isInDomain(IloNumVar var,
                 int value)

This member function indicates whether value is contained in the current domain of var as maintained by the invoking IloCPEngine instance. An assertion is violated if var is not of integral type.

getDomainSize

public int getDomainSize(IloNumVar var)

This member function returns the size of the domain of variable var as maintained in the invoking instance of IloCPEngine. An assertion is violated if var is not of integral type.

isFixed

public boolean isFixed(IloNumVar var)

This member function indicates if the domain of var takes on a particular value as maintained by the invoking IloCPEngine instance.

iterator

public java.util.Iterator iterator(IloIntVar var)

This member function returns an iterator to iterate over the domain of var, as maintained by the invoking IloCPEngine.

getInfo

public int getInfo(IloCPEngine.IntInfo which)
            throws IloException

This method returns the value of the integer information which in the invoked IloCPEngine instance. The information is with respect to this local worker, and not globally over the whole search process.

Throws:

IloException