Generated on for Gecode by doxygen 1.17.0

Topics

 Integer variables
 Argument arrays
 Variable arrays
 Domain constraints
 Simple relation constraints over integer variables
 Simple relation constraints over Boolean variables
 Value precedence constraints over integer variables
 Membership constraints
 Element constraints
 Inter-distance constraint
 Distinct constraints
 Channel constraints
 Sorted constraints
 Counting constraints
 Number of values constraints
 Sequence constraints
 Extensional constraints
 Minimum distance constraints
 Arithmetic constraints
 Linear constraints over integer variables
 Linear constraints over Boolean variables
 Bin packing constraints
 Geometrical packing constraints
 Scheduling constraints
 Graph constraints
 Synchronized execution
 Unsharing variables
 Branching

Classes

class  Gecode::OpenVarList< Var >
 Space-local list of variables with an open length. More...
class  Gecode::OpenIntVarList
 Open list of integer variables. More...
class  Gecode::OpenBoolVarList
 Open list of Boolean variables. More...
class  Gecode::Reify
 Reification specification. More...

Typedefs

typedef ArgArray< TaskType > Gecode::TaskTypeArgs
 Argument arrays for passing task type arguments.

Enumerations

enum  Gecode::ReifyMode { Gecode::RM_EQV , Gecode::RM_IMP , Gecode::RM_PMI }
 Mode for reification. More...
enum  Gecode::IntRelType {
  Gecode::IRT_EQ , Gecode::IRT_NQ , Gecode::IRT_LQ , Gecode::IRT_LE ,
  Gecode::IRT_GQ , Gecode::IRT_GR
}
 Relation types for integers. More...
enum  Gecode::BoolOpType {
  Gecode::BOT_AND , Gecode::BOT_OR , Gecode::BOT_IMP , Gecode::BOT_EQV ,
  Gecode::BOT_XOR
}
 Operation types for Booleans. More...
enum  Gecode::IntPropLevel {
  Gecode::IPL_DEF = 0 , Gecode::IPL_VAL = 1 , Gecode::IPL_BND = 2 , Gecode::IPL_DOM = 3 ,
  Gecode::IPL_BASIC = 4 , Gecode::IPL_ADVANCED = 8 , Gecode::IPL_BASIC_ADVANCED = IPL_BASIC | IPL_ADVANCED , Gecode::IPL_FULL = IPL_BASIC_ADVANCED ,
  Gecode::IPL_BITS_ = 4
}
 Propagation levels for integer propagators. More...
enum  Gecode::TaskType { Gecode::TT_FIXP , Gecode::TT_FIXS , Gecode::TT_FIXE }
 Type of task for scheduling constraints. More...

Functions

Reify Gecode::eqv (BoolVar x)
 Use equivalence for reification.
Reify Gecode::imp (BoolVar x)
 Use implication for reification.
Reify Gecode::pmi (BoolVar x)
 Use reverse implication for reification.
void Gecode::product (Home home, const IntVarArgs &x, IntVar y, IntPropLevel ipl=IPL_DEF)
 Constrain y to the exact product of the variables in x.
void Gecode::product (Home home, const IntVarArgs &x, IntVar y, Reify r, IntPropLevel ipl=IPL_DEF)
 Reify whether y is the exact product of the variables in x.
void Gecode::product_mod (Home home, const IntVarArgs &x, int m, IntVar y, IntPropLevel ipl=IPL_DEF)
 Constrain y to the product of x modulo m.
void Gecode::product_mod (Home home, const IntVarArgs &x, int m, IntVar y, Reify r, IntPropLevel ipl=IPL_DEF)
 Reify whether y is the product of x modulo m.
void Gecode::product_mod (Home home, const IntVarArgs &x, IntVar m, IntVar y, IntPropLevel ipl=IPL_DEF)
 Constrain y to the product of x modulo m.
void Gecode::product_mod (Home home, const IntVarArgs &x, IntVar m, IntVar y, Reify r, IntPropLevel ipl=IPL_DEF)
 Reify whether y is the product of x modulo m.

Detailed Description

Typedef Documentation

◆ TaskTypeArgs

Argument arrays for passing task type arguments.

Definition at line 1316 of file int.hh.

Enumeration Type Documentation

◆ ReifyMode

Mode for reification.

Enumerator
RM_EQV 

Equivalence for reification (default).

For a constraint \(c\) and a Boolean control variable \(b\) defines that \(b=1\Leftrightarrow c\) is propagated.

RM_IMP 

Implication for reification.

For a constraint \(c\) and a Boolean control variable \(b\) defines that \(b=1\Rightarrow c\) is propagated.

RM_PMI 

Inverse implication for reification.

For a constraint \(c\) and a Boolean control variable \(b\) defines that \(c\Rightarrow b=1\) is propagated.

Definition at line 1148 of file int.hh.

◆ IntRelType

Relation types for integers.

Enumerator
IRT_EQ 

Equality ( \(=\)).

IRT_NQ 

Disequality ( \(\neq\)).

IRT_LQ 

Less or equal ( \(\leq\)).

IRT_LE 

Less ( \(<\)).

IRT_GQ 

Greater or equal ( \(\geq\)).

IRT_GR 

Greater ( \(>\)).

Definition at line 1225 of file int.hh.

◆ BoolOpType

Operation types for Booleans.

Enumerator
BOT_AND 

Conjunction.

BOT_OR 

Disjunction.

BOT_IMP 

Implication.

BOT_EQV 

Equivalence.

BOT_XOR 

Exclusive or.

Definition at line 1250 of file int.hh.

◆ IntPropLevel

Propagation levels for integer propagators.

The descriptions are meant to be approximate. It is not required that a propagator achieves full domain consistency or full bounds consistency. It is more like: which level of consistency comes closest to the level of propagation the propagator implements.

If in the description of a constraint below no propagation level is mentioned, the propagation level for the constraint is domain propagation and the implementation in fact enforces domain consistency.

Enumerator
IPL_DEF 

Simple propagation levels.

Default level of propagation

IPL_VAL 

Value propagation.

IPL_BND 

Bounds propagation.

IPL_DOM 

Domain propagation Options: basic versus advanced propagation.

IPL_BASIC 

Use basic propagation algorithm.

IPL_ADVANCED 

Use advanced propagation algorithm.

IPL_BASIC_ADVANCED 

Use both.

IPL_FULL 

Use full propagation.

IPL_BITS_ 

Number of bits required (internal).

Definition at line 1274 of file int.hh.

◆ TaskType

Type of task for scheduling constraints.

Enumerator
TT_FIXP 
TT_FIXS 
TT_FIXE 

Definition at line 1305 of file int.hh.

Function Documentation

◆ eqv()

Reify Gecode::eqv ( BoolVar x)
inline

Use equivalence for reification.

Definition at line 69 of file reify.hpp.

◆ imp()

Reify Gecode::imp ( BoolVar x)
inline

Use implication for reification.

Definition at line 73 of file reify.hpp.

◆ pmi()

Reify Gecode::pmi ( BoolVar x)
inline

Use reverse implication for reification.

Definition at line 77 of file reify.hpp.

◆ product() [1/2]

void Gecode::product ( Home home,
const IntVarArgs & x,
IntVar y,
IntPropLevel ipl = IPL_DEF )

Constrain y to the exact product of the variables in x.

The product of an empty array is one. Uses bounds and algebraic propagation, without guaranteeing bounds consistency. The propagation level ipl is currently ignored.

Definition at line 377 of file arithmetic.cpp.

◆ product() [2/2]

void Gecode::product ( Home home,
const IntVarArgs & x,
IntVar y,
Reify r,
IntPropLevel ipl = IPL_DEF )

Reify whether y is the exact product of the variables in x.

The product of an empty array is one. Supports all reification modes using conservative algebraic tests. The propagation level ipl is currently ignored.

Definition at line 385 of file arithmetic.cpp.

◆ product_mod() [1/4]

void Gecode::product_mod ( Home home,
const IntVarArgs & x,
int m,
IntVar y,
IntPropLevel ipl = IPL_DEF )

Constrain y to the product of x modulo m.

The modulus m must be positive. The result uses the canonical Euclidean residue in the range zero through m minus one. The product of an empty array is one. Unlike mod(), a negative product still has a nonnegative residue. Uses bounds and algebraic propagation, without guaranteeing bounds consistency. The propagation level ipl is currently ignored. Throws Int::OutOfLimits if m is nonpositive or exceeds Int::Limits::max.

Definition at line 408 of file arithmetic.cpp.

◆ product_mod() [2/4]

void Gecode::product_mod ( Home home,
const IntVarArgs & x,
int m,
IntVar y,
Reify r,
IntPropLevel ipl = IPL_DEF )

Reify whether y is the product of x modulo m.

The modulus m must be positive. The result uses the canonical Euclidean residue in the range zero through m minus one. The product of an empty array is one. Supports all reification modes using conservative algebraic tests, without guaranteeing bounds consistency; ipl is currently ignored. Throws Int::OutOfLimits if m is nonpositive or exceeds Int::Limits::max, even for an inactive implication.

Definition at line 419 of file arithmetic.cpp.

◆ product_mod() [3/4]

void Gecode::product_mod ( Home home,
const IntVarArgs & x,
IntVar m,
IntVar y,
IntPropLevel ipl = IPL_DEF )

Constrain y to the product of x modulo m.

The variable modulus m is constrained to be positive and y uses the canonical Euclidean residue, so that \(0\leq y<m\). The product of an empty array is one. Uses bounds and algebraic propagation, without guaranteeing bounds consistency. The propagation level ipl is currently ignored.

Definition at line 444 of file arithmetic.cpp.

◆ product_mod() [4/4]

void Gecode::product_mod ( Home home,
const IntVarArgs & x,
IntVar m,
IntVar y,
Reify r,
IntPropLevel ipl = IPL_DEF )

Reify whether y is the product of x modulo m.

The reified proposition includes \(m>0\), the canonical range \(0\leq y<m\), and congruence with the product. The product of an empty array is one. Supports all reification modes using conservative algebraic tests, without guaranteeing bounds consistency; ipl is currently ignored. An inactive implication does not constrain the modulus or result.

Definition at line 453 of file arithmetic.cpp.