OR-Tools  8.2
IntVarabstract

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 3997 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...
 
IntVarVar () override
 Creates a variable from the expression. More...
 
virtual int64 Value () const =0
 This method returns the value of the variable. More...
 
virtual void RemoveValue (int64 v)=0
 This method removes the value 'v' from the domain of the variable. More...
 
virtual void RemoveInterval (int64 l, int64 u)=0
 This method removes the interval 'l' . More...
 
virtual void RemoveValues (const std::vector< int64 > &values)
 This method remove the values from the domain of the variable. More...
 
virtual void SetValues (const std::vector< int64 > &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 Size () const =0
 This method returns the number of values in the domain of the variable. More...
 
virtual bool Contains (int64 v) const =0
 This method returns whether the value 'v' is in the domain of the variable. More...
 
virtual IntVarIteratorMakeHoleIterator (bool reversible) const =0
 Creates a hole iterator. More...
 
virtual IntVarIteratorMakeDomainIterator (bool reversible) const =0
 Creates a domain iterator. More...
 
virtual int64 OldMin () const =0
 Returns the previous min. More...
 
virtual int64 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 IntVarIsEqual (int64 constant)=0
 IsEqual. More...
 
virtual IntVarIsDifferent (int64 constant)=0
 
virtual IntVarIsGreaterOrEqual (int64 constant)=0
 
virtual IntVarIsLessOrEqual (int64 constant)=0
 
int index () const
 Returns the index of the variable. More...
 
virtual int64 Min () const =0
 
virtual void SetMin (int64 m)=0
 
virtual int64 Max () const =0
 
virtual void SetMax (int64 m)=0
 
virtual void Range (int64 *l, int64 *u)
 By default calls Min() and Max(), but can be redefined when Min and Max code can be factorized. More...
 
virtual void SetRange (int64 l, int64 u)
 This method sets both the min and the max of the expression. More...
 
virtual void SetValue (int64 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...
 
IntVarVarWithName (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
 
Solversolver () 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 57 of file expressions.cc.

◆ IntVar() [2/2]

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

Definition at line 59 of file expressions.cc.

◆ ~IntVar()

~IntVar ( )
inlineoverride

Definition at line 4001 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 7318 of file expressions.cc.

◆ BaseName()

std::string BaseName ( ) const
virtualinherited

Returns a base name for automatic naming.

Reimplemented in BooleanVar.

Definition at line 2515 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 3862 of file constraint_solver.h.

◆ Contains()

virtual bool Contains ( int64  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

◆ EnqueueAll()

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

Definition at line 2521 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 3192 of file constraint_solver.h.

◆ EnqueueVar()

void EnqueueVar ( Demon *const  d)
inlineinherited

Definition at line 3193 of file constraint_solver.h.

◆ ExecuteAll()

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

Definition at line 2517 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 3183 of file constraint_solver.h.

◆ HasName()

bool HasName ( ) const
inherited

Returns whether the object has been named or not.

Definition at line 2513 of file constraint_solver.cc.

◆ index()

int index ( ) const
inline

Returns the index of the variable.

Definition at line 4091 of file constraint_solver.h.

◆ IsDifferent()

virtual IntVar * IsDifferent ( int64  constant)
pure virtual

Implemented in BooleanVar.

◆ IsEqual()

virtual IntVar * IsEqual ( int64  constant)
pure virtual

IsEqual.

Implemented in BooleanVar.

◆ IsGreaterOrEqual()

virtual IntVar * IsGreaterOrEqual ( int64  constant)
pure virtual

Implemented in BooleanVar.

◆ IsLessOrEqual()

virtual IntVar * IsLessOrEqual ( int64  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 4003 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 Max ( ) const
pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ Min()

virtual int64 Min ( ) const
pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ name()

std::string name ( ) const
virtualinherited

Object naming.

Reimplemented in PiecewiseLinearExpr.

Definition at line 2505 of file constraint_solver.cc.

◆ OldMax()

virtual int64 OldMax ( ) const
pure virtual

Returns the previous max.

◆ OldMin()

virtual int64 OldMin ( ) const
pure virtual

Returns the previous min.

◆ Range()

virtual void Range ( int64 l,
int64 u 
)
inlinevirtualinherited

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

Definition at line 3848 of file constraint_solver.h.

◆ RemoveInterval()

virtual void RemoveInterval ( int64  l,
int64  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  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 > &  values)
virtual

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

Definition at line 7266 of file expressions.cc.

◆ reset_action_on_fail()

void reset_action_on_fail ( )
inlineinherited

This method clears the failure callback.

Definition at line 3206 of file constraint_solver.h.

◆ set_action_on_fail()

void set_action_on_fail ( Solver::Action  a)
inlineinherited

Definition at line 3200 of file constraint_solver.h.

◆ set_name()

void set_name ( const std::string &  name)
inherited

Definition at line 2509 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 3209 of file constraint_solver.h.

◆ SetMax()

virtual void SetMax ( int64  m)
pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ SetMin()

virtual void SetMin ( int64  m)
pure virtualinherited

Implemented in BooleanVar, and PiecewiseLinearExpr.

◆ SetRange()

virtual void SetRange ( int64  l,
int64  u 
)
inlinevirtualinherited

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

Reimplemented in PiecewiseLinearExpr, and BooleanVar.

Definition at line 3853 of file constraint_solver.h.

◆ SetValue()

virtual void SetValue ( int64  v)
inlinevirtualinherited

This method sets the value of the expression.

Definition at line 3859 of file constraint_solver.h.

◆ SetValues()

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

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

Definition at line 7323 of file expressions.cc.

◆ Size()

virtual uint64 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 3179 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 3187 of file constraint_solver.h.

◆ Value()

virtual int64 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 4004 of file constraint_solver.h.

◆ VarType()

int VarType ( ) const
virtual

Reimplemented in BooleanVar.

Definition at line 7264 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 49 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 4035 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 4028 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 4051 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 4045 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 3885 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 3879 of file constraint_solver.h.


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