Detailed Description

The class IntVar is a subset of IntExpr.

In addition to the IntExpr protocol, it offers persistence, removing values from the domains, and a finer model for events.

Definition at line 4040 of file constraint_solver.h.

Public Member Functions
	IntVar (Solver *const s)

	IntVar (Solver *const s, const std::string &name)

	~IntVar () override

bool	IsVar () const override
	Returns true if the expression is indeed a variable. More...

IntVar *	Var () override
	Creates a variable from the expression. More...

virtual int64_t	Value () const =0
	This method returns the value of the variable. More...

virtual void	RemoveValue (int64_t v)=0
	This method removes the value 'v' from the domain of the variable. More...

virtual void	RemoveInterval (int64_t l, int64_t u)=0
	This method removes the interval 'l' . More...

virtual void	RemoveValues (const std::vector< int64_t > &values)
	This method remove the values from the domain of the variable. More...

virtual void	SetValues (const std::vector< int64_t > &values)
	This method intersects the current domain with the values in the array. More...

virtual void	WhenBound (Demon *d)=0
	This method attaches a demon that will be awakened when the variable is bound. More...

void	WhenBound (Solver::Closure closure)
	This method attaches a closure that will be awakened when the variable is bound. More...

void	WhenBound (Solver::Action action)
	This method attaches an action that will be awakened when the variable is bound. More...

virtual void	WhenDomain (Demon *d)=0
	This method attaches a demon that will watch any domain modification of the domain of the variable. More...

void	WhenDomain (Solver::Closure closure)
	This method attaches a closure that will watch any domain modification of the domain of the variable. More...

void	WhenDomain (Solver::Action action)
	This method attaches an action that will watch any domain modification of the domain of the variable. More...

virtual uint64_t	Size () const =0
	This method returns the number of values in the domain of the variable. More...

virtual bool	Contains (int64_t v) const =0
	This method returns whether the value 'v' is in the domain of the variable. More...

virtual IntVarIterator *	MakeHoleIterator (bool reversible) const =0
	Creates a hole iterator. More...

virtual IntVarIterator *	MakeDomainIterator (bool reversible) const =0
	Creates a domain iterator. More...

virtual int64_t	OldMin () const =0
	Returns the previous min. More...

virtual int64_t	OldMax () const =0
	Returns the previous max. More...

virtual int	VarType () const

void	Accept (ModelVisitor *const visitor) const override
	Accepts the given visitor. More...

virtual IntVar *	IsEqual (int64_t constant)=0
	IsEqual. More...

virtual IntVar *	IsDifferent (int64_t constant)=0

virtual IntVar *	IsGreaterOrEqual (int64_t constant)=0

virtual IntVar *	IsLessOrEqual (int64_t constant)=0

int	index () const
	Returns the index of the variable. More...

virtual int64_t	Min () const =0

virtual void	SetMin (int64_t m)=0

virtual int64_t	Max () const =0

virtual void	SetMax (int64_t m)=0

virtual void	Range (int64_t l, int64_t u)
	By default calls Min() and Max(), but can be redefined when Min and Max code can be factorized. More...

virtual void	SetRange (int64_t l, int64_t u)
	This method sets both the min and the max of the expression. More...

virtual void	SetValue (int64_t v)
	This method sets the value of the expression. More...

virtual bool	Bound () const
	Returns true if the min and the max of the expression are equal. More...

IntVar *	VarWithName (const std::string &name)
	Creates a variable from the expression and set the name of the resulting var. More...

virtual void	WhenRange (Demon *d)=0
	Attach a demon that will watch the min or the max of the expression. More...

void	WhenRange (Solver::Closure closure)
	Attach a demon that will watch the min or the max of the expression. More...

void	WhenRange (Solver::Action action)
	Attach a demon that will watch the min or the max of the expression. More...

std::string	DebugString () const override

Solver *	solver () const

void	FreezeQueue ()
	This method freezes the propagation queue. More...

void	UnfreezeQueue ()
	This method unfreezes the propagation queue. More...

void	EnqueueDelayedDemon (Demon *const d)
	This method pushes the demon onto the propagation queue. More...

void	EnqueueVar (Demon *const d)

void	ExecuteAll (const SimpleRevFIFO< Demon * > &demons)

void	EnqueueAll (const SimpleRevFIFO< Demon * > &demons)

void	set_action_on_fail (Solver::Action a)

void	reset_action_on_fail ()
	This method clears the failure callback. More...

void	set_variable_to_clean_on_fail (IntVar *v)
	Shortcut for variable cleaner. More...

virtual std::string	name () const
	Object naming. More...

void	set_name (const std::string &name)

bool	HasName () const
	Returns whether the object has been named or not. More...

virtual std::string	BaseName () const
	Returns a base name for automatic naming. More...

Constructor & Destructor Documentation

◆ IntVar() [1/2]

IntVar ( Solver *const s )

explicit

Definition at line 59 of file expressions.cc.

◆ IntVar() [2/2]

IntVar	(	Solver *const	s,
		const std::string &	name
	)

Definition at line 61 of file expressions.cc.

◆ ~IntVar()

~IntVar ( )

inlineoverride

Definition at line 4044 of file constraint_solver.h.

Member Function Documentation

◆ Accept()

void Accept ( ModelVisitor *const visitor ) const

overridevirtual

Accepts the given visitor.

Reimplemented from IntExpr.

Definition at line 7351 of file expressions.cc.

◆ BaseName()

std::string BaseName ( ) const

virtualinherited

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 2521 of file constraint_solver.cc.

◆ Bound()

virtual bool Bound ( ) const

inlinevirtualinherited

Returns true if the min and the max of the expression are equal.

Reimplemented in BooleanVar.

Definition at line 3904 of file constraint_solver.h.

◆ Contains()

virtual bool Contains ( int64_t v ) const

pure virtual

This method returns whether the value 'v' is in the domain of the variable.

Implemented in BooleanVar.

◆ DebugString()

std::string DebugString ( ) const

inlineoverridevirtualinherited

Reimplemented from BaseObject.

Reimplemented in Constraint, SequenceVar, Assignment, Pack, BooleanVar, IfThenElseCt, PiecewiseLinearExpr, and GlobalVehicleBreaksConstraint.

Definition at line 3189 of file constraint_solver.h.

◆ EnqueueAll()

void EnqueueAll ( const SimpleRevFIFO< Demon * > & demons )

inherited

Definition at line 2527 of file constraint_solver.cc.

◆ EnqueueDelayedDemon()

void EnqueueDelayedDemon ( Demon *const d )

inlineinherited

This method pushes the demon onto the propagation queue.

It will be processed directly if the queue is empty. It will be enqueued according to its priority otherwise.

Definition at line 3209 of file constraint_solver.h.

◆ EnqueueVar()

void EnqueueVar ( Demon *const d )

inlineinherited

Definition at line 3210 of file constraint_solver.h.

◆ ExecuteAll()

void ExecuteAll ( const SimpleRevFIFO< Demon * > & demons )

inherited

Definition at line 2523 of file constraint_solver.cc.

◆ FreezeQueue()

void FreezeQueue ( )

inlineinherited

This method freezes the propagation queue.

It is useful when you need to apply multiple modifications at once.

Definition at line 3200 of file constraint_solver.h.

◆ HasName()

bool HasName ( ) const

inherited

Returns whether the object has been named or not.

Definition at line 2519 of file constraint_solver.cc.

◆ index()

int index ( ) const

inline

Returns the index of the variable.

Definition at line 4134 of file constraint_solver.h.

◆ IsDifferent()

virtual IntVar * IsDifferent ( int64_t constant )

pure virtual

Implemented in BooleanVar.

◆ IsEqual()

virtual IntVar * IsEqual ( int64_t constant )

pure virtual

IsEqual.

Implemented in BooleanVar.

◆ IsGreaterOrEqual()

virtual IntVar * IsGreaterOrEqual ( int64_t constant )

pure virtual

Implemented in BooleanVar.

◆ IsLessOrEqual()

virtual IntVar * IsLessOrEqual ( int64_t constant )

pure virtual

Implemented in BooleanVar.

◆ IsVar()

bool IsVar ( ) const

inlineoverridevirtual

Returns true if the expression is indeed a variable.

Reimplemented from IntExpr.

Definition at line 4046 of file constraint_solver.h.

◆ MakeDomainIterator()

virtual IntVarIterator * MakeDomainIterator ( bool reversible ) const

pure virtual

Creates a domain iterator.

When 'reversible' is false, the returned object is created on the normal C++ heap and the solver does NOT take ownership of the object.

Implemented in BooleanVar.

◆ MakeHoleIterator()

virtual IntVarIterator * MakeHoleIterator ( bool reversible ) const

pure virtual

Creates a hole iterator.

When 'reversible' is false, the returned object is created on the normal C++ heap and the solver does NOT take ownership of the object.

Implemented in BooleanVar.

◆ Max()

virtual int64_t Max ( ) const

pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ Min()

virtual int64_t Min ( ) const

pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ name()

std::string name ( ) const

virtualinherited

Object naming.

Reimplemented in PiecewiseLinearExpr.

Definition at line 2511 of file constraint_solver.cc.

◆ OldMax()

virtual int64_t OldMax ( ) const

pure virtual

Returns the previous max.

◆ OldMin()

virtual int64_t OldMin ( ) const

pure virtual

Returns the previous min.

◆ Range()

virtual void Range	(	int64_t *	l,
		int64_t *	u
	)

inlinevirtualinherited

By default calls Min() and Max(), but can be redefined when Min and Max code can be factorized.

Definition at line 3890 of file constraint_solver.h.

◆ RemoveInterval()

virtual void RemoveInterval	(	int64_t	l,
		int64_t	u
	)

pure virtual

This method removes the interval 'l' .

. 'u' from the domain of the variable. It assumes that 'l' <= 'u'.

Implemented in BooleanVar.

◆ RemoveValue()

virtual void RemoveValue ( int64_t v )

pure virtual

This method removes the value 'v' from the domain of the variable.

Implemented in BooleanVar.

◆ RemoveValues()

void RemoveValues ( const std::vector< int64_t > & values )

virtual

This method remove the values from the domain of the variable.

Definition at line 7299 of file expressions.cc.

◆ reset_action_on_fail()

void reset_action_on_fail ( )

inlineinherited

This method clears the failure callback.

Definition at line 3223 of file constraint_solver.h.

◆ set_action_on_fail()

void set_action_on_fail ( Solver::Action a )

inlineinherited

Definition at line 3217 of file constraint_solver.h.

◆ set_name()

void set_name ( const std::string & name )

inherited

Definition at line 2515 of file constraint_solver.cc.

◆ set_variable_to_clean_on_fail()

void set_variable_to_clean_on_fail ( IntVar * v )

inlineinherited

Shortcut for variable cleaner.

Definition at line 3226 of file constraint_solver.h.

◆ SetMax()

virtual void SetMax ( int64_t m )

pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ SetMin()

virtual void SetMin ( int64_t m )

pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ SetRange()

virtual void SetRange	(	int64_t	l,
		int64_t	u
	)

inlinevirtualinherited

This method sets both the min and the max of the expression.

Reimplemented in PiecewiseLinearExpr, and BooleanVar.

Definition at line 3895 of file constraint_solver.h.

◆ SetValue()

virtual void SetValue ( int64_t v )

inlinevirtualinherited

This method sets the value of the expression.

Definition at line 3901 of file constraint_solver.h.

◆ SetValues()

void SetValues ( const std::vector< int64_t > & values )

virtual

This method intersects the current domain with the values in the array.

Definition at line 7356 of file expressions.cc.

◆ Size()

virtual uint64_t Size ( ) const

pure virtual

This method returns the number of values in the domain of the variable.

Implemented in BooleanVar.

◆ solver()

Solver * solver ( ) const

inlineinherited

Definition at line 3196 of file constraint_solver.h.

◆ UnfreezeQueue()

void UnfreezeQueue ( )

inlineinherited

This method unfreezes the propagation queue.

All modifications that happened when the queue was frozen will be processed.

Definition at line 3204 of file constraint_solver.h.

◆ Value()

virtual int64_t Value ( ) const

pure virtual

This method returns the value of the variable.

This method checks before that the variable is bound.

Implemented in BooleanVar.

◆ Var()

IntVar * Var ( )

inlineoverridevirtual

Creates a variable from the expression.

Implements IntExpr.

Definition at line 4047 of file constraint_solver.h.

◆ VarType()

int VarType ( ) const

virtual

Reimplemented in BooleanVar.

Definition at line 7297 of file expressions.cc.

◆ VarWithName()

IntVar * VarWithName ( const std::string & name )

inherited

Creates a variable from the expression and set the name of the resulting var.

If the expression is already a variable, then it will set the name of the expression, possibly overwriting it. This is just a shortcut to Var() followed by set_name().

Definition at line 51 of file expressions.cc.

◆ WhenBound() [1/3]

virtual void WhenBound ( Demon * d )

pure virtual

This method attaches a demon that will be awakened when the variable is bound.

Implemented in BooleanVar.

◆ WhenBound() [2/3]

void WhenBound ( Solver::Action action )

inline

This method attaches an action that will be awakened when the variable is bound.

Definition at line 4078 of file constraint_solver.h.

◆ WhenBound() [3/3]

void WhenBound ( Solver::Closure closure )

inline

This method attaches a closure that will be awakened when the variable is bound.

Definition at line 4071 of file constraint_solver.h.

◆ WhenDomain() [1/3]

virtual void WhenDomain ( Demon * d )

pure virtual

This method attaches a demon that will watch any domain modification of the domain of the variable.

Implemented in BooleanVar.

◆ WhenDomain() [2/3]

void WhenDomain ( Solver::Action action )

inline

This method attaches an action that will watch any domain modification of the domain of the variable.

Definition at line 4094 of file constraint_solver.h.

◆ WhenDomain() [3/3]

void WhenDomain ( Solver::Closure closure )

inline

This method attaches a closure that will watch any domain modification of the domain of the variable.

Definition at line 4088 of file constraint_solver.h.

◆ WhenRange() [1/3]

virtual void WhenRange ( Demon * d )

pure virtualinherited

Attach a demon that will watch the min or the max of the expression.

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ WhenRange() [2/3]

void WhenRange ( Solver::Action action )

inlineinherited

Attach a demon that will watch the min or the max of the expression.

Definition at line 3927 of file constraint_solver.h.

◆ WhenRange() [3/3]

void WhenRange ( Solver::Closure closure )

inlineinherited

Attach a demon that will watch the min or the max of the expression.

Definition at line 3921 of file constraint_solver.h.

The documentation for this class was generated from the following files:

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ IntVar() [1/2]

◆ IntVar() [2/2]

◆ ~IntVar()

Member Function Documentation

◆ Accept()

◆ BaseName()

◆ Bound()

◆ Contains()

◆ DebugString()

◆ EnqueueAll()

◆ EnqueueDelayedDemon()

◆ EnqueueVar()

◆ ExecuteAll()

◆ FreezeQueue()

◆ HasName()

◆ index()

◆ IsDifferent()

◆ IsEqual()

◆ IsGreaterOrEqual()

◆ IsLessOrEqual()

◆ IsVar()

◆ MakeDomainIterator()

◆ MakeHoleIterator()

◆ Max()

◆ Min()

◆ name()

◆ OldMax()

◆ OldMin()

◆ Range()

◆ RemoveInterval()

◆ RemoveValue()

◆ RemoveValues()

◆ reset_action_on_fail()

◆ set_action_on_fail()

◆ set_name()

◆ set_variable_to_clean_on_fail()

◆ SetMax()

◆ SetMin()

◆ SetRange()

◆ SetValue()

◆ SetValues()

◆ Size()

◆ solver()

◆ UnfreezeQueue()

◆ Value()

◆ Var()

◆ VarType()

◆ VarWithName()

◆ WhenBound() [1/3]

◆ WhenBound() [2/3]

◆ WhenBound() [3/3]

◆ WhenDomain() [1/3]

◆ WhenDomain() [2/3]

◆ WhenDomain() [3/3]

◆ WhenRange() [1/3]

◆ WhenRange() [2/3]

◆ WhenRange() [3/3]