Skip to main content
FRAMES NO FRAMES

Class IlcRevInt

Definition file: ilcp/cpext.h
Include file: <ilcp/cpext.h>
Map of IlcRevIntIlcRevIntIlcRevInt
The reversible class for integer values.

IlcRevInt is a reversible version of the basic predefined type, IlcInt. The reversible version makes it easier to restore a previous state. This class has a value data member corresponding to IlcInt. This value data member is automatically restored when CP Optimizer backtracks.

This class is not a handle class. Objects of this class should be used directly, that is, not through pointers to them. Do not create instances of IlcRevInt as automatic objects (that is, as objects allocated on the C++ stack). Do not pass them by value.

An object of the class IlcRevInt is automatically cast to the basic type IlcInt, if needed. Instances of this reversible class can be used as data members. However, do not use them as types for automatic variables, where “automatic” has its usual C++ meaning, as this practice would create memory-access errors. Do not pass them as arguments.

An instance of IlcRevInt behaves very much like an instance of IlcInt; the difference in their behavior has to do with assignments. Indeed, all reversible assignments are undone when CP Optimizer backtracks.

For more information, see the concepts State in CP Optimizer and Reversibility in CP Optimizer.

See Also:

Method Summary
public IlcIntgetValue() const
public IlcRevInt(IlcCPEngine solver, IlcInt initValue=0)
public operator IlcInt() const
public voidsetValue(IlcCPEngine solver, IlcInt value)
Method Detail

IlcRevInt

public IlcRevInt(IlcCPEngine solver, IlcInt initValue=0)

The constructor creates a new object, an instance of IlcRevInt.


getValue

public IlcInt getValue() const

This member function accesses the value of the instance of IlcRevInt.


operator IlcInt

public operator IlcInt() const

This operator returns the value of the instance of IlcRevInt. In other words, this operator automatically casts an instance of IlcRevInt into an instance of IlcInt.


setValue

public void setValue(IlcCPEngine solver, IlcInt value)

This member function modifies the value of the invoking object by reversibly assigning value to it. When CP Optimizer backtracks, this reversible modification will be undone.