operations_research::Solver Class Reference

#include <constraint_solver.h>

List of all members.

Public Types

enum IntVarStrategy {
  INT_VAR_DEFAULT, INT_VAR_SIMPLE, CHOOSE_FIRST_UNBOUND, CHOOSE_RANDOM,
  CHOOSE_MIN_SIZE_LOWEST_MIN, CHOOSE_MIN_SIZE_HIGHEST_MIN, CHOOSE_MIN_SIZE_LOWEST_MAX, CHOOSE_MIN_SIZE_HIGHEST_MAX,
  CHOOSE_PATH
}

This enum describes the strategy used to select the next branching variable at each node during the search. More...

enum IntValueStrategy {
  INT_VALUE_DEFAULT, INT_VALUE_SIMPLE, ASSIGN_MIN_VALUE, ASSIGN_MAX_VALUE,
  ASSIGN_RANDOM_VALUE, ASSIGN_CENTER_VALUE
}

This enum describes the strategy used to select the next variable value to set. More...

enum EvaluatorStrategy { CHOOSE_STATIC_GLOBAL_BEST, CHOOSE_DYNAMIC_GLOBAL_BEST }

This enum is used by Solver::MakePhase to specify how to select variables and values during the search. More...

enum SequenceStrategy { SEQUENCE_DEFAULT, SEQUENCE_SIMPLE, CHOOSE_MIN_SLACK_RANK_FORWARD, CHOOSE_RANDOM_RANK_FORWARD }

Used for scheduling. Not yet implemented. More...

enum IntervalStrategy { INTERVAL_DEFAULT, INTERVAL_SIMPLE, INTERVAL_SET_TIMES_FORWARD }

Used for scheduling. Not yet implemented. More...

enum LocalSearchOperators {
  TWOOPT, OROPT, RELOCATE, EXCHANGE,
  CROSS, MAKEACTIVE, MAKEINACTIVE, SWAPACTIVE,
  EXTENDEDSWAPACTIVE, PATHLNS, UNACTIVELNS, INCREMENT,
  DECREMENT, SIMPLELNS
}

This enum is used in Solver::MakeOperator to specify the neighborhood to create. More...

enum EvaluatorLocalSearchOperators { LK, TSPOPT, TSPLNS }

This enum is used in Solver::MakeOperator associated with an evaluator to specify the neighborhood to create. More...

enum LocalSearchFilterBound { GE, LE, EQ }

This enum is used in Solver::MakeLocalSearchObjectiveFilter. More...

enum LocalSearchOperation { SUM, PROD, MAX, MIN }

This enum is used in Solver::MakeLocalSearchObjectiveFilter. More...

enum DemonPriority { DELAYED_PRIORITY = 0, VAR_PRIORITY = 1, NORMAL_PRIORITY = 2 }

This enum represents the three possible priorities for a demon in the Solver queue. More...

enum BinaryIntervalRelation {
  ENDS_AFTER_END, ENDS_AFTER_START, ENDS_AT_END, ENDS_AT_START,
  STARTS_AFTER_END, STARTS_AFTER_START, STARTS_AT_END, STARTS_AT_START,
  STAYS_IN_SYNC
}

This enum is used in Solver::MakeIntervalVarRelation to specify the temporal relation between the two intervals t1 and t2. More...

enum UnaryIntervalRelation {
  ENDS_AFTER, ENDS_AT, ENDS_BEFORE, STARTS_AFTER,
  STARTS_AT, STARTS_BEFORE, CROSS_DATE, AVOID_DATE
}

This enum is used in Solver::MakeIntervalVarRelation to specify the temporal relation between an interval t and an integer d. More...

enum DecisionModification {
  NO_CHANGE, KEEP_LEFT, KEEP_RIGHT, KILL_BOTH,
  SWITCH_BRANCHES
}

The Solver is responsible for creating the search tree. More...

enum MarkerType { SENTINEL, SIMPLE_MARKER, CHOICE_POINT, REVERSIBLE_ACTION }

This enum is used internally in private methods Solver::PushState and Solver::PopState to tag states in the search tree. More...

enum SolverState {
  OUTSIDE_SEARCH, IN_ROOT_NODE, IN_SEARCH, AT_SOLUTION,
  NO_MORE_SOLUTIONS, PROBLEM_INFEASIBLE
}

This enum represents the state of the solver w.r.t. the search. More...

typedef ResultCallback1< int64,
int64 > IndexEvaluator1

Callback typedefs.

typedef ResultCallback2< int64,
int64, int64 > IndexEvaluator2

typedef ResultCallback3< int64,
int64, int64, int64 > IndexEvaluator3

typedef ResultCallback2
< IntExpr *, CPModelLoader
*, const
CPIntegerExpressionProto & > IntegerExpressionBuilder

typedef ResultCallback2
< Constraint *, CPModelLoader
*, const CPConstraintProto & > ConstraintBuilder

typedef ResultCallback2
< IntervalVar *, CPModelLoader
*, const
CPIntervalVariableProto & > IntervalVariableBuilder

typedef ResultCallback2
< SequenceVar *, CPModelLoader
*, const
CPSequenceVariableProto & > SequenceVariableBuilder

Public Member Functions

Solver (const string &modelname)

Solver (const string &modelname, const SolverParameters &parameters)

~Solver ()

const SolverParameters & parameters () const

Read-only Parameters.

template<class T>

void SaveValue (T *o)

reversibility

template<typename T>

T * RevAlloc (T *object)

Registers the given object as being reversible.

template<typename T>

T * RevAllocArray (T *object)

Like RevAlloc() above, but for an array of objects: the array must have been allocated with the new[] operator.

void AddConstraint (Constraint *const c)

propagation

void AddCastConstraint (CastConstraint *const c, IntVar *const target_var, IntExpr *const casted_expression)

Adds the constraint 'c' to the solver and marks it as a cast constraint, that is, a constraint created calling Var() on an expression.

bool NestedSolve (DecisionBuilder *const db, bool restore, const std::vector< SearchMonitor * > &monitors)

Nested solve using a decision builder and up to three search monitors, usually one for the objective, one for the limits and one to collect solutions.

bool NestedSolve (DecisionBuilder *const db, bool restore, SearchMonitor *const *monitors, int size)

bool NestedSolve (DecisionBuilder *const db, bool restore)

bool NestedSolve (DecisionBuilder *const db, bool restore, SearchMonitor *const m1)

bool NestedSolve (DecisionBuilder *const db, bool restore, SearchMonitor *const m1, SearchMonitor *const m2)

bool NestedSolve (DecisionBuilder *const db, bool restore, SearchMonitor *const m1, SearchMonitor *const m2, SearchMonitor *const m3)

bool CheckAssignment (Assignment *const assignment)

Checks whether the given assignment satisfies all the relevant constraints.

bool CheckConstraint (Constraint *const constraint)

Checks whether adding this constraint will lead to an immediate failure.

SolverState state () const

State of the solver.

void Fail ()

Abandon the current branch in the search tree. A backtrack will follow.

void ExportModel (CPModelProto *const proto) const

Exports the model to protobuf.

void ExportModel (const std::vector< SearchMonitor * > &monitors, CPModelProto *const proto) const

Exports the model to protobuf.

bool LoadModel (const CPModelProto &proto)

Loads the model into the solver, and returns true upon success.

bool LoadModel (const CPModelProto &proto, std::vector< SearchMonitor * > *monitors)

Loads the model into the solver, appends search monitors to monitors, and returns true upon success.

bool CollectDecisionVariables (std::vector< IntVar * > *const primary_integer_variables, std::vector< IntVar * > *const secondary_integer_variables, std::vector< SequenceVar * > *const sequence_variables, std::vector< IntervalVar * > *const interval_variables)

Collects decision variables.

void RegisterBuilder (const string &tag, ConstraintBuilder *const builder)

Registers a constraint builder. Ownership is passed to the solver.

void RegisterBuilder (const string &tag, IntegerExpressionBuilder *const builder)

Registers an integer expression builder. Ownership is passed to the solver.

void RegisterBuilder (const string &tag, IntervalVariableBuilder *const builder)

Registers an interval variable builder. Ownership is passed to the solver.

void RegisterBuilder (const string &tag, SequenceVariableBuilder *const builder)

Registers a sequence variable builder. Ownership is passed to the solver.

ConstraintBuilder * GetConstraintBuilder (const string &tag) const

IntegerExpressionBuilder * GetIntegerExpressionBuilder (const string &tag) const

IntervalVariableBuilder * GetIntervalVariableBuilder (const string &tag) const

SequenceVariableBuilder * GetSequenceVariableBuilder (const string &tag) const

void AddBacktrackAction (Action *a, bool fast)

When SaveValue() is not the best way to go, one can create a reversible action that will be called upon backtrack.

string DebugString () const

misc debug string.

int64 wall_time () const

wall_time() in ms since the creation of the solver.

int64 branches () const

number of branches explored since the creation of the solver.

int64 solutions () const

number of solutions found since the start of the search.

int64 demon_runs (DemonPriority p) const

number of demons executed during search for a given priority.

int64 failures () const

number of failures encountered since the creation of the solver.

int64 neighbors () const

number of neighbors created

int64 filtered_neighbors () const

number of filtered neighbors (neighbors accepted by filters)

int64 accepted_neighbors () const

number of accepted neighbors

uint64 stamp () const

The stamp indicates how many moves in the search tree we have performed.

uint64 fail_stamp () const

The fail_stamp() is incremented after each backtrack.

IntVar * MakeIntVar (int64 vmin, int64 vmax, const string &name)

Make Factory.

IntVar * MakeIntVar (const std::vector< int64 > &values, const string &name)

MakeIntVar will create a variable with the given sparse domain.

IntVar * MakeIntVar (const std::vector< int > &values, const string &name)

MakeIntVar will create a variable with the given sparse domain.

IntVar * MakeIntVar (int64 vmin, int64 vmax)

MakeIntVar will create the best range based int var for the bounds given.

IntVar * MakeIntVar (const std::vector< int64 > &values)

MakeIntVar will create a variable with the given sparse domain.

IntVar * MakeIntVar (const std::vector< int > &values)

MakeIntVar will create a variable with the given sparse domain.

IntVar * MakeBoolVar (const string &name)

MakeBoolVar will create a variable with a {0, 1} domain.

IntVar * MakeBoolVar ()

MakeBoolVar will create a variable with a {0, 1} domain.

IntVar * MakeIntConst (int64 val, const string &name)

IntConst will create a constant expression.

IntVar * MakeIntConst (int64 val)

IntConst will create a constant expression.

void MakeIntVarArray (int var_count, int64 vmin, int64 vmax, const string &name, std::vector< IntVar * > *vars)

This method will append the vector vars with 'var_count' variables having bounds vmin and vmax and having name "name<i>" where is the index of the variable.

void MakeIntVarArray (int var_count, int64 vmin, int64 vmax, std::vector< IntVar * > *vars)

This method will append the vector vars with 'var_count' variables having bounds vmin and vmax and having no names.

IntVar ** MakeIntVarArray (int var_count, int64 vmin, int64 vmax, const string &name)

Same but allocates an array and returns it.

void MakeBoolVarArray (int var_count, const string &name, std::vector< IntVar * > *vars)

This method will append the vector vars with 'var_count' boolean variables having name "name<i>" where is the index of the variable.

void MakeBoolVarArray (int var_count, std::vector< IntVar * > *vars)

This method will append the vector vars with 'var_count' boolean variables having no names.

IntVar ** MakeBoolVarArray (int var_count, const string &name)

Same but allocates an array and returns it.

IntExpr * MakeSum (IntExpr *const left, IntExpr *const right)

Integer Expressions.

IntExpr * MakeSum (IntExpr *const expr, int64 value)

expr + value.

IntExpr * MakeSum (IntVar *const *vars, int size)

sum of all vars.

IntExpr * MakeSum (const std::vector< IntVar * > &vars)

sum of all vars.

IntExpr * MakeScalProd (const std::vector< IntVar * > &vars, const std::vector< int64 > &coefs)

scalar product

IntExpr * MakeScalProd (IntVar *const *vars, const int64 *const coefs, int size)

scalar product

IntExpr * MakeScalProd (const std::vector< IntVar * > &vars, const std::vector< int > &coefs)

scalar product

IntExpr * MakeScalProd (IntVar *const *vars, const int *const coefs, int size)

scalar product

IntExpr * MakeDifference (IntExpr *const left, IntExpr *const right)

left - right

IntExpr * MakeDifference (int64 value, IntExpr *const expr)

value - expr

IntExpr * MakeOpposite (IntExpr *const expr)

-expr

IntExpr * MakeProd (IntExpr *const left, IntExpr *const right)

left * right

IntExpr * MakeProd (IntExpr *const expr, int64 value)

expr * value

IntExpr * MakeDiv (IntExpr *const expr, int64 value)

expr / value (integer division)

IntExpr * MakeDiv (IntExpr *const numerator, IntExpr *const denominator)

numerator / denominator (integer division). Terms need to be positive.

IntExpr * MakeAbs (IntExpr *const expr)

|expr|

IntExpr * MakeSquare (IntExpr *const expr)

expr * expr

IntExpr * MakeElement (const int64 *const vals, int size, IntVar *const index)

vals[expr]

IntExpr * MakeElement (const std::vector< int64 > &vals, IntVar *const index)

vals[expr]

IntExpr * MakeElement (const int *const vals, int size, IntVar *const index)

vals[expr]

IntExpr * MakeElement (const std::vector< int > &vals, IntVar *const index)

vals[expr]

IntExpr * MakeElement (IndexEvaluator1 *values, IntVar *const index)

Function-based element.

IntExpr * MakeMonotonicElement (IndexEvaluator1 *values, bool increasing, IntVar *const index)

Function based element.

IntExpr * MakeElement (IndexEvaluator2 *values, IntVar *const index1, IntVar *const index2)

2D version of function-based element expression, values(expr1, expr2).

IntExpr * MakeElement (const IntVar *const *vars, int size, IntVar *const index)

vars[expr]

IntExpr * MakeElement (const std::vector< IntVar * > &vars, IntVar *const index)

vars[expr]

IntExpr * MakeMin (const std::vector< IntVar * > &vars)

min(vars)

IntExpr * MakeMin (IntVar *const *vars, int size)

min(vars)

IntExpr * MakeMin (IntExpr *const left, IntExpr *const right)

min (left, right)

IntExpr * MakeMin (IntExpr *const expr, int64 val)

min(expr, val)

IntExpr * MakeMin (IntExpr *const expr, int val)

min(expr, val)

IntExpr * MakeMax (const std::vector< IntVar * > &vars)

max(vars)

IntExpr * MakeMax (IntVar *const *vars, int size)

max(vars)

IntExpr * MakeMax (IntExpr *const left, IntExpr *const right)

max(left, right)

IntExpr * MakeMax (IntExpr *const expr, int64 val)

max(expr, val)

IntExpr * MakeMax (IntExpr *const expr, int val)

max(expr, val)

IntExpr * MakeConvexPiecewiseExpr (IntVar *e, int64 early_cost, int64 early_date, int64 late_date, int64 late_cost)

convex piecewise function.

IntExpr * MakeSemiContinuousExpr (IntExpr *const e, int64 fixed_charge, int64 step)

Semi continuous Expression (x <= 0 -> f(x) = 0; x > 0 -> f(x) = ax + b) a >= 0 and b >= 0.

Constraint * MakeTrueConstraint ()

Constraints This constraint always succeeds.

Constraint * MakeFalseConstraint ()

This constraint always fails.

Constraint * MakeFalseConstraint (const string &explanation)

Constraint * MakeIsEqualCstCt (IntVar *const v, int64 c, IntVar *const b)

b == (v == c)

IntVar * MakeIsEqualCstVar (IntVar *const var, int64 value)

status var of (v == c)

Constraint * MakeIsEqualCt (IntExpr *const v1, IntExpr *v2, IntVar *const b)

b == (v1 == v2)

IntVar * MakeIsEqualVar (IntExpr *const var, IntExpr *v2)

status var of (v1 == v2)

Constraint * MakeEquality (IntVar *const left, IntVar *const right)

left == right

Constraint * MakeEquality (IntExpr *const expr, int64 value)

expr == value

Constraint * MakeEquality (IntExpr *const expr, int value)

expr == value

Constraint * MakeIsDifferentCstCt (IntVar *const v, int64 c, IntVar *const b)

b == (v != c)

IntVar * MakeIsDifferentCstVar (IntVar *const v, int64 c)

status var of (v != c)

IntVar * MakeIsDifferentVar (IntExpr *const v1, IntExpr *const v2)

status var of (v1 != v2)

Constraint * MakeIsDifferentCt (IntExpr *const v1, IntExpr *const v2, IntVar *const b)

b == (v1 != v2)

Constraint * MakeNonEquality (IntVar *const left, IntVar *const right)

left != right

Constraint * MakeNonEquality (IntVar *const expr, int64 value)

expr != value

Constraint * MakeNonEquality (IntVar *const expr, int value)

expr != value

Constraint * MakeIsLessOrEqualCstCt (IntVar *const v, int64 c, IntVar *const b)

b == (v <= c)

IntVar * MakeIsLessOrEqualCstVar (IntVar *const v, int64 c)

status var of (v <= c)

IntVar * MakeIsLessOrEqualVar (IntExpr *const left, IntExpr *const right)

status var of (left <= right)

Constraint * MakeIsLessOrEqualCt (IntExpr *const left, IntExpr *const right, IntVar *const b)

b == (left <= right)

Constraint * MakeLessOrEqual (IntVar *const left, IntVar *const right)

left <= right

Constraint * MakeLessOrEqual (IntExpr *const expr, int64 value)

expr <= value

Constraint * MakeLessOrEqual (IntExpr *const expr, int value)

expr <= value

Constraint * MakeIsGreaterOrEqualCstCt (IntVar *const v, int64 c, IntVar *const b)

b == (v >= c)

IntVar * MakeIsGreaterOrEqualCstVar (IntVar *const v, int64 c)

status var of (v >= c)

IntVar * MakeIsGreaterOrEqualVar (IntExpr *const left, IntExpr *const right)

status var of (left >= right)

Constraint * MakeIsGreaterOrEqualCt (IntExpr *const left, IntExpr *const right, IntVar *const b)

b == (left >= right)

Constraint * MakeGreaterOrEqual (IntVar *const left, IntVar *const right)

left >= right

Constraint * MakeGreaterOrEqual (IntExpr *const expr, int64 value)

expr >= value

Constraint * MakeGreaterOrEqual (IntExpr *const expr, int value)

expr >= value

Constraint * MakeIsGreaterCstCt (IntVar *const v, int64 c, IntVar *const b)

b == (v > c)

IntVar * MakeIsGreaterCstVar (IntVar *const v, int64 c)

status var of (v > c)

IntVar * MakeIsGreaterVar (IntExpr *const left, IntExpr *const right)

status var of (left > right)

Constraint * MakeIsGreaterCt (IntExpr *const left, IntExpr *const right, IntVar *const b)

b == (left > right)

Constraint * MakeGreater (IntVar *const left, IntVar *const right)

left > right

Constraint * MakeGreater (IntExpr *const expr, int64 value)

expr > value

Constraint * MakeGreater (IntExpr *const expr, int value)

expr > value

Constraint * MakeIsLessCstCt (IntVar *const v, int64 c, IntVar *const b)

b == (v < c)

IntVar * MakeIsLessCstVar (IntVar *const v, int64 c)

status var of (v < c)

IntVar * MakeIsLessVar (IntExpr *const left, IntExpr *const right)

status var of (left < right)

Constraint * MakeIsLessCt (IntExpr *const left, IntExpr *const right, IntVar *const b)

b == (left < right)

Constraint * MakeLess (IntVar *const left, IntVar *const right)

left < right

Constraint * MakeLess (IntExpr *const expr, int64 value)

expr < value

Constraint * MakeLess (IntExpr *const expr, int value)

expr < value

Constraint * MakeSumLessOrEqual (const std::vector< IntVar * > &vars, int64 cst)

Variation on arrays.

Constraint * MakeSumLessOrEqual (IntVar *const *vars, int size, int64 cst)

Constraint * MakeSumGreaterOrEqual (const std::vector< IntVar * > &vars, int64 cst)

Constraint * MakeSumGreaterOrEqual (IntVar *const *vars, int size, int64 cst)

Constraint * MakeSumEquality (const std::vector< IntVar * > &vars, int64 cst)

Constraint * MakeSumEquality (IntVar *const *vars, int size, int64 cst)

Constraint * MakeSumEquality (const std::vector< IntVar * > &vars, IntVar *const var)

Constraint * MakeSumEquality (IntVar *const *vars, int size, IntVar *const var)

Constraint * MakeScalProdEquality (const std::vector< IntVar * > &vars, const std::vector< int64 > &coefficients, int64 cst)

Constraint * MakeScalProdEquality (IntVar *const *vars, int size, int64 const *coefficients, int64 cst)

namespace

Constraint * MakeScalProdEquality (IntVar *const *vars, int size, int const *coefficients, int64 cst)

Constraint * MakeScalProdEquality (const std::vector< IntVar * > &vars, const std::vector< int > &coefficients, int64 cst)

Constraint * MakeScalProdGreaterOrEqual (const std::vector< IntVar * > &vars, const std::vector< int64 > &coefficients, int64 cst)

Constraint * MakeScalProdGreaterOrEqual (IntVar *const *vars, int size, int64 const *coefficients, int64 cst)

namespace

Constraint * MakeScalProdGreaterOrEqual (const std::vector< IntVar * > &vars, const std::vector< int > &coefficients, int64 cst)

Constraint * MakeScalProdGreaterOrEqual (IntVar *const *vars, int size, int const *coefficients, int64 cst)

Constraint * MakeScalProdLessOrEqual (const std::vector< IntVar * > &vars, const std::vector< int64 > &coefficients, int64 cst)

Constraint * MakeScalProdLessOrEqual (IntVar *const *vars, int size, int64 const *coefficients, int64 cst)

namespace

Constraint * MakeScalProdLessOrEqual (const std::vector< IntVar * > &vars, const std::vector< int > &coefficients, int64 cst)

Constraint * MakeScalProdLessOrEqual (IntVar *const *vars, int size, int const *coefficients, int64 cst)

Demon * MakeConstraintInitialPropagateCallback (Constraint *const ct)

This method is a specialized case of the MakeConstraintDemon method to call the InitiatePropagate of the constraint 'ct'.

Demon * MakeDelayedConstraintInitialPropagateCallback (Constraint *const ct)

This method is a specialized case of the MakeConstraintDemon method to call the InitiatePropagate of the constraint 'ct' with low priority.

Demon * MakeCallbackDemon (Callback1< Solver * > *const callback)

Creates a demon from a callback.

Demon * MakeCallbackDemon (Closure *const closure)

Creates a demon from a closure.

Constraint * MakeBetweenCt (IntVar *const v, int64 l, int64 u)

(l <= b <= u)

Constraint * MakeIsBetweenCt (IntVar *const v, int64 l, int64 u, IntVar *const b)

b == (l <= v <= u)

Constraint * MakeIsMemberCt (IntVar *const v, const int64 *const values, int size, IntVar *const b)

b == (v in set)

Constraint * MakeIsMemberCt (IntVar *const v, const std::vector< int64 > &values, IntVar *const b)

Constraint * MakeIsMemberCt (IntVar *const v, const int *const values, int size, IntVar *const b)

Constraint * MakeIsMemberCt (IntVar *const v, const std::vector< int > &values, IntVar *const b)

IntVar * MakeIsMemberVar (IntVar *const v, const int64 *const values, int size)

IntVar * MakeIsMemberVar (IntVar *const v, const std::vector< int64 > &values)

IntVar * MakeIsMemberVar (IntVar *const v, const int *const values, int size)

IntVar * MakeIsMemberVar (IntVar *const v, const std::vector< int > &values)

Constraint * MakeMemberCt (IntVar *const v, const int64 *const values, int size)

v in set.

Constraint * MakeMemberCt (IntVar *const v, const std::vector< int64 > &values)

Constraint * MakeMemberCt (IntVar *const v, const int *const values, int size)

Constraint * MakeMemberCt (IntVar *const v, const std::vector< int > &values)

Constraint * MakeCount (const std::vector< IntVar * > &v, int64 value, int64 count)

|{i | v[i] == value}| == count

Constraint * MakeCount (const std::vector< IntVar * > &v, int64 value, IntVar *const count)

|{i | v[i] == value}| == count

Constraint * MakeDistribute (const std::vector< IntVar * > &vars, const std::vector< int64 > &values, const std::vector< IntVar * > &cards)

Aggregated version of count: |{i | v[i] == values[j]}| == cards[j].

Constraint * MakeDistribute (const std::vector< IntVar * > &vars, const std::vector< int > &values, const std::vector< IntVar * > &cards)

Aggregated version of count: |{i | v[i] == values[j]}| == cards[j].

Constraint * MakeDistribute (const std::vector< IntVar * > &vars, const std::vector< IntVar * > &cards)

Aggregated version of count: |{i | v[i] == j}| == cards[j].

Constraint * MakeDistribute (const std::vector< IntVar * > &vars, int64 card_min, int64 card_max, int64 card_size)

Aggregated version of count with bounded cardinalities: forall j in 0 .

Constraint * MakeDeviation (const std::vector< IntVar * > &vars, IntVar *const deviation_var, int64 total_sum)

Deviation constraint: sum_i |n * vars[i] - total_sum| <= deviation_var and sum_i vars[i] == total_sum n = vars.

Constraint * MakeAllDifferent (const std::vector< IntVar * > &vars)

All variables are pairwise different.

Constraint * MakeAllDifferent (const std::vector< IntVar * > &vars, bool stronger_propagation)

All variables are pairwise different.

Constraint * MakeAllDifferent (const IntVar *const *vars, int size, bool stronger_propagation)

All variables are pairwise different.

Constraint * MakeNoCycle (const std::vector< IntVar * > &nexts, const std::vector< IntVar * > &active, ResultCallback1< bool, int64 > *sink_handler=NULL)

Prevent cycles, nexts variables representing the next in the chain.

Constraint * MakeNoCycle (const IntVar *const *nexts, const IntVar *const *active, int size, ResultCallback1< bool, int64 > *sink_handler=NULL)

Constraint * MakeNoCycle (const std::vector< IntVar * > &nexts, const std::vector< IntVar * > &active, ResultCallback1< bool, int64 > *sink_handler, bool assume_paths)

namespace

Constraint * MakeNoCycle (const IntVar *const *nexts, const IntVar *const *active, int size, ResultCallback1< bool, int64 > *sink_handler, bool assume_paths)

Constraint * MakePathCumul (const std::vector< IntVar * > &nexts, const std::vector< IntVar * > &active, const std::vector< IntVar * > &cumuls, const std::vector< IntVar * > &transits)

Accumulate values along a path such that: cumuls[next[i]] = cumuls[i] + transits[i].

Constraint * MakePathCumul (const IntVar *const *nexts, const IntVar *const *active, const IntVar *const *cumuls, const IntVar *const *transits, int next_size, int cumul_size)

Constraint * MakeMapDomain (IntVar *const var, IntVar *const *vars, int size)

This constraint maps the domain of 'var' onto the array of variables 'vars'.

Constraint * MakeMapDomain (IntVar *const var, const std::vector< IntVar * > &vars)

This constraint maps the domain of 'var' onto the array of variables 'vars'.

Constraint * MakeAllowedAssignments (const std::vector< IntVar * > &vars, const IntTupleSet &tuples)

This method creates a constraint where the graph of the relation between the variables is given in extension.

Constraint * MakeTransitionConstraint (const std::vector< IntVar * > &vars, const IntTupleSet &transitions, int64 initial_state, const std::vector< int64 > &final_states)

This constraint create a finite automaton that will check the sequence of variables vars.

Constraint * MakeTransitionConstraint (const std::vector< IntVar * > &vars, const IntTupleSet &transitions, int64 initial_state, const std::vector< int > &final_states)

This constraint create a finite automaton that will check the sequence of variables vars.

Pack * MakePack (const std::vector< IntVar * > &vars, int number_of_bins)

Packing constraint.

IntervalVar * MakeFixedDurationIntervalVar (int64 start_min, int64 start_max, int64 duration, bool optional, const string &name)

scheduling objects

void MakeFixedDurationIntervalVarArray (int count, int64 start_min, int64 start_max, int64 duration, bool optional, const string &name, std::vector< IntervalVar * > *array)

This method fills the vector with 'count' interval var built with the corresponding parameters.

IntervalVar * MakeFixedInterval (int64 start, int64 duration, const string &name)

Creates an fixed and performed interval.

IntervalVar * MakeMirrorInterval (IntervalVar *const interval_var)

Creates an interval var that is the mirror image of the given one, that is, the interval var obtained by reversing the axis.

IntervalVar * MakeIntervalRelaxedMin (IntervalVar *const interval_var)

Creates and returns an interval variable that wraps around the given one, relaxing the min start and end.

IntervalVar * MakeIntervalRelaxedMax (IntervalVar *const interval_var)

Creates and returns an interval variable that wraps around the given one, relaxing the max start and end.

Constraint * MakeIntervalVarRelation (IntervalVar *const t, UnaryIntervalRelation r, int64 d)

scheduling constraints

Constraint * MakeIntervalVarRelation (IntervalVar *const t1, BinaryIntervalRelation r, IntervalVar *const t2)

This method creates a relation between two an interval vars.

Constraint * MakeTemporalDisjunction (IntervalVar *const t1, IntervalVar *const t2, IntVar *const alt)

This constraint implements a temporal disjunction between two interval vars t1 and t2.

Constraint * MakeTemporalDisjunction (IntervalVar *const t1, IntervalVar *const t2)

This constraint implements a temporal disjunction between two interval vars.

Constraint * MakeDisjunctiveConstraint (const std::vector< IntervalVar * > &intervals)

This constraint forces all interval vars into an non overlapping sequence.

SequenceVar * MakeSequenceVar (const std::vector< IntervalVar * > &intervals, const string &name)

The sequence variable is used to rank disjoint intervals.

Constraint * MakeCumulative (const std::vector< IntervalVar * > &intervals, const std::vector< int64 > &demands, int64 capacity, const string &name)

This constraint forces that, for any integer t, the sum of the demands corresponding to an interval containing t does not exceed the given capacity.

Constraint * MakeCumulative (const std::vector< IntervalVar * > &intervals, const std::vector< int > &demands, int64 capacity, const string &name)

This constraint forces that, for any integer t, the sum of the demands corresponding to an interval containing t does not exceed the given capacity.

Assignment * MakeAssignment ()

Assignments.

Assignment * MakeAssignment (const Assignment *const a)

This method creates an assignnment which is a copy of 'a'.

SolutionCollector * MakeFirstSolutionCollector (const Assignment *const assignment)

Solution Collectors.

SolutionCollector * MakeFirstSolutionCollector ()

Collect the first solution of the search.

SolutionCollector * MakeLastSolutionCollector (const Assignment *const assignment)

Collect the last solution of the search.

SolutionCollector * MakeLastSolutionCollector ()

Collect the last solution of the search.

SolutionCollector * MakeBestValueSolutionCollector (const Assignment *const assignment, bool maximize)

Collect the solution corresponding to the optimal value of the objective of 'a'; if 'a' does not have an objective no solution is collected.

SolutionCollector * MakeBestValueSolutionCollector (bool maximize)

Collect the solution corresponding to the optimal value of the objective of 'a'; if 'a' does not have an objective no solution is collected.

SolutionCollector * MakeAllSolutionCollector (const Assignment *const assignment)

Collect all solutions of the search.

SolutionCollector * MakeAllSolutionCollector ()

Collect all solutions of the search.

OptimizeVar * MakeMinimize (IntVar *const v, int64 step)

Objective.

OptimizeVar * MakeMaximize (IntVar *const v, int64 step)

Creates a maximization objective.

OptimizeVar * MakeOptimize (bool maximize, IntVar *const v, int64 step)

Creates a objective with a given sense (true = maximization).

OptimizeVar * MakeWeightedMinimize (const std::vector< IntVar * > &vars, const std::vector< int64 > &weights, int64 step)

Creates a minimization weighted objective.

OptimizeVar * MakeWeightedMinimize (const std::vector< IntVar * > &vars, const std::vector< int > &weights, int64 step)

Creates a minimization weighted objective.

OptimizeVar * MakeWeightedMaximize (const std::vector< IntVar * > &vars, const std::vector< int64 > &weights, int64 step)

Creates a maximization weigthed objective.

OptimizeVar * MakeWeightedMaximize (const std::vector< IntVar * > &vars, const std::vector< int > &weights, int64 step)

Creates a maximization weigthed objective.

OptimizeVar * MakeWeightedOptimize (bool maximize, const std::vector< IntVar * > &vars, const std::vector< int64 > &weights, int64 step)

Creates a weighted objective with a given sense (true = maximization).

OptimizeVar * MakeWeightedOptimize (bool maximize, const std::vector< IntVar * > &vars, const std::vector< int > &weights, int64 step)

Creates a weighted objective with a given sense (true = maximization).

SearchMonitor * MakeTabuSearch (bool maximize, IntVar *const v, int64 step, const std::vector< IntVar * > &vars, int64 keep_tenure, int64 forbid_tenure, double tabu_factor)

Meta-heuristics Search monitors which try to get the search out of local optima.

SearchMonitor * MakeTabuSearch (bool maximize, IntVar *const v, int64 step, const IntVar *const *vars, int size, int64 keep_tenure, int64 forbid_tenure, double tabu_factor)

SearchMonitor * MakeSimulatedAnnealing (bool maximize, IntVar *const v, int64 step, int64 initial_temperature)

Creates a Simulated Annealing monitor.

SearchMonitor * MakeGuidedLocalSearch (bool maximize, IntVar *const objective, IndexEvaluator2 *objective_function, int64 step, const std::vector< IntVar * > &vars, double penalty_factor)

Creates a Guided Local Search monitor.

SearchMonitor * MakeGuidedLocalSearch (bool maximize, IntVar *const objective, IndexEvaluator2 *objective_function, int64 step, const IntVar *const *vars, int size, double penalty_factor)

SearchMonitor * MakeGuidedLocalSearch (bool maximize, IntVar *const objective, IndexEvaluator3 *objective_function, int64 step, const std::vector< IntVar * > &vars, const std::vector< IntVar * > &secondary_vars, double penalty_factor)

SearchMonitor * MakeGuidedLocalSearch (bool maximize, IntVar *const objective, IndexEvaluator3 *objective_function, int64 step, const IntVar *const *vars, const IntVar *const *secondary_vars, int size, double penalty_factor)

SearchMonitor * MakeLubyRestart (int scale_factor)

Restart Search.

SearchMonitor * MakeConstantRestart (int frequency)

This search monitor will restart the search periodically after 'frequency' failures.

SearchLimit * MakeTimeLimit (int64 time_in_ms)

Search Limit.

SearchLimit * MakeBranchesLimit (int64 branches)

Creates a search limit that constrains the number of branches explored in the search tree.

SearchLimit * MakeFailuresLimit (int64 failures)

Creates a search limit that constrains the number of failures that can happen when exploring the search tree.

SearchLimit * MakeSolutionsLimit (int64 solutions)

Creates a search limit that constrains the number of solutions found during the search.

SearchLimit * MakeLimit (int64 time, int64 branches, int64 failures, int64 solutions)

Limits the search with the 'time', 'branches', 'failures' and 'solutions' limits.

SearchLimit * MakeLimit (int64 time, int64 branches, int64 failures, int64 solutions, bool smart_time_check)

Version reducing calls to wall timer by estimating number of remaining calls.

SearchLimit * MakeLimit (int64 time, int64 branches, int64 failures, int64 solutions, bool smart_time_check, bool cumulative)

Creates a search limit which can either apply cumulatively or search-by-search.

SearchLimit * MakeLimit (const SearchLimitProto &proto)

Creates a search limit from its protobuf description.

SearchLimit * MakeLimit (SearchLimit *const limit_1, SearchLimit *const limit_2)

Creates a search limit that is reached when either of the underlying limit is reached.

void UpdateLimits (int64 time, int64 branches, int64 failures, int64 solutions, SearchLimit *limit)

int64 GetTime (SearchLimit *limit)

Returns 'time' limit of search limit.

SearchLimit * MakeCustomLimit (ResultCallback< bool > *limiter)

Callback-based search limit.

NoGoodManager * MakeNoGoodManager ()

No Goods.

SearchMonitor * MakeTreeMonitor (const IntVar *const *vars, int size, const string &file_tree, const string &file_visualization)

Tree Monitor Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const std::vector< IntVar * > &vars, const string &file_tree, const string &file_visualization)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const IntVar *const *vars, int size, const string &file_config, const string &file_tree, const string &file_visualization)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const std::vector< IntVar * > &vars, const string &file_config, const string &file_tree, const string &file_visualization)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const IntVar *const *vars, int size, string *const tree_xml, string *const visualization_xml)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const std::vector< IntVar * > &vars, string *const tree_xml, string *const visualization_xml)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const IntVar *const *vars, int size, string *const config_xml, string *const tree_xml, string *const visualization_xml)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeTreeMonitor (const std::vector< IntVar * > &vars, string *const config_xml, string *const tree_xml, string *const visualization_xml)

Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

SearchMonitor * MakeSearchLog (int branch_count)

Search Log The SearchMonitors below will display a periodic search log on LOG(INFO) every branch_count branches explored.

SearchMonitor * MakeSearchLog (int branch_count, IntVar *const objective)

At each solution, this monitor also display the objective value.

SearchMonitor * MakeSearchLog (int branch_count, ResultCallback< string > *display_callback)

At each solution, this monitor will also display result of display_callback.

SearchMonitor * MakeSearchLog (int branch_count, IntVar *objective, ResultCallback< string > *display_callback)

At each solution, this monitor will display the objective value and the result of display_callback.

SearchMonitor * MakeSearchLog (int branch_count, OptimizeVar *const objective)

OptimizeVar Search Logs At each solution, this monitor will also display the objective->Print().

SearchMonitor * MakeSearchLog (int branch_count, OptimizeVar *const objective, ResultCallback< string > *display_callback)

Creates a search monitor that will also print the result of the display callback.

SearchMonitor * MakeSearchTrace (const string &prefix)

Search Trace.

ModelVisitor * MakePrintModelVisitor ()

ModelVisitor.

ModelVisitor * MakeStatisticsModelVisitor ()

Displays some nice statistics on the model.

SearchMonitor * MakeSymmetryManager (const std::vector< SymmetryBreaker * > &visitors)

Symmetry Breaking.

SearchMonitor * MakeSymmetryManager (SymmetryBreaker *const *visitors, int size)

SearchMonitor * MakeSymmetryManager (SymmetryBreaker *const v1)

SearchMonitor * MakeSymmetryManager (SymmetryBreaker *const v1, SymmetryBreaker *const v2)

SearchMonitor * MakeSymmetryManager (SymmetryBreaker *const v1, SymmetryBreaker *const v2, SymmetryBreaker *const v3)

SearchMonitor * MakeSymmetryManager (SymmetryBreaker *const v1, SymmetryBreaker *const v2, SymmetryBreaker *const v3, SymmetryBreaker *const v4)

SearchMonitor * MakeSimplexConnection (Callback1< MPSolver * > *const builder, Callback1< MPSolver * > *const modifier, Callback1< MPSolver * > *const runner, int simplex_frequency)

Simplex Connection.

SearchMonitor * MakeSimplexConstraint (int simplex_frequency)

Linear Relaxation Constraint.

Decision * MakeAssignVariableValue (IntVar *const var, int64 value)

Search Decicions and Decision Builders.

Decision * MakeVariableLessOrEqualValue (IntVar *const var, int64 value)

Decision * MakeVariableGreaterOrEqualValue (IntVar *const var, int64 value)

Decision * MakeSplitVariableDomain (IntVar *const var, int64 value, bool start_with_lower_half)

namespace

Decision * MakeAssignVariableValueOrFail (IntVar *const var, int64 value)

namespace

Decision * MakeAssignVariablesValues (const IntVar *const *vars, int size, const int64 *const values)

namespace

Decision * MakeAssignVariablesValues (const std::vector< IntVar * > &vars, const std::vector< int64 > &values)

Decision * MakeFailDecision ()

namespace

DecisionBuilder * Compose (DecisionBuilder *const db1, DecisionBuilder *const db2)

Creates a decision builder which sequentially composes decision builders.

DecisionBuilder * Compose (DecisionBuilder *const db1, DecisionBuilder *const db2, DecisionBuilder *const db3)

DecisionBuilder * Compose (DecisionBuilder *const db1, DecisionBuilder *const db2, DecisionBuilder *const db3, DecisionBuilder *const db4)

DecisionBuilder * Compose (const std::vector< DecisionBuilder * > &dbs)

DecisionBuilder * Try (DecisionBuilder *const db1, DecisionBuilder *const db2)

Creates a decision builder which will create a search tree where each decision builder is called from the top of the search tree.

DecisionBuilder * Try (DecisionBuilder *const db1, DecisionBuilder *const db2, DecisionBuilder *const db3)

DecisionBuilder * Try (DecisionBuilder *const db1, DecisionBuilder *const db2, DecisionBuilder *const db3, DecisionBuilder *const db4)

DecisionBuilder * Try (const std::vector< DecisionBuilder * > &dbs)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IntVarStrategy var_str, IntValueStrategy val_str)

Phases on IntVar arrays.

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IntVarStrategy var_str, IntValueStrategy val_str)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IndexEvaluator1 *var_evaluator, IntValueStrategy val_str)

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IndexEvaluator1 *var_evaluator, IntValueStrategy val_str)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IntVarStrategy var_str, IndexEvaluator2 *val_eval)

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IntVarStrategy var_str, IndexEvaluator2 *val_eval)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IndexEvaluator1 *var_evaluator, IndexEvaluator2 *val_eval)

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IndexEvaluator1 *var_evaluator, IndexEvaluator2 *val_eval)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IntVarStrategy var_str, IndexEvaluator2 *val_eval, IndexEvaluator1 *tie_breaker)

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IntVarStrategy var_str, IndexEvaluator2 *val_eval, IndexEvaluator1 *tie_breaker)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IndexEvaluator1 *var_evaluator, IndexEvaluator2 *val_eval, IndexEvaluator1 *tie_breaker)

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IndexEvaluator1 *var_evaluator, IndexEvaluator2 *val_eval, IndexEvaluator1 *tie_breaker)

DecisionBuilder * MakeDefaultPhase (const IntVar *const *vars, int size)

DecisionBuilder * MakeDefaultPhase (const std::vector< IntVar * > &vars)

namespace

DecisionBuilder * MakeDefaultPhase (const IntVar *const *vars, int size, const DefaultPhaseParameters &parameters)

DecisionBuilder * MakeDefaultPhase (const std::vector< IntVar * > &vars, const DefaultPhaseParameters &parameters)

DecisionBuilder * MakePhase (IntVar *const v0, IntVarStrategy var_str, IntValueStrategy val_str)

shortcuts for small arrays.

DecisionBuilder * MakePhase (IntVar *const v0, IntVar *const v1, IntVarStrategy var_str, IntValueStrategy val_str)

DecisionBuilder * MakePhase (IntVar *const v0, IntVar *const v1, IntVar *const v2, IntVarStrategy var_str, IntValueStrategy val_str)

DecisionBuilder * MakePhase (IntVar *const v0, IntVar *const v1, IntVar *const v2, IntVar *const v3, IntVarStrategy var_str, IntValueStrategy val_str)

Decision * MakeScheduleOrPostpone (IntervalVar *const var, int64 est, int64 *const marker)

Scheduling Decisions.

Decision * MakeRankFirstInterval (SequenceVar *const sequence, int index)

Returns a decision that tries to rank first the ith interval var in the sequence variable.

Decision * MakeRankLastInterval (SequenceVar *const sequence, int index)

Returns a decision that tries to rank last the ith interval var in the sequence variable.

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IndexEvaluator2 *evaluator, EvaluatorStrategy str)

Returns a decision builder which assigns values to variables which minimize the values returned by the evaluator.

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IndexEvaluator2 *evaluator, EvaluatorStrategy str)

DecisionBuilder * MakePhase (const std::vector< IntVar * > &vars, IndexEvaluator2 *evaluator, IndexEvaluator1 *tie_breaker, EvaluatorStrategy str)

Returns a decision builder which assigns values to variables which minimize the values returned by the evaluator.

DecisionBuilder * MakePhase (const IntVar *const *vars, int size, IndexEvaluator2 *evaluator, IndexEvaluator1 *tie_breaker, EvaluatorStrategy str)

DecisionBuilder * MakePhase (const std::vector< IntervalVar * > &intervals, IntervalStrategy str)

Scheduling phases.

DecisionBuilder * MakePhase (const std::vector< SequenceVar * > &sequences, SequenceStrategy str)

DecisionBuilder * MakeDecisionBuilderFromAssignment (Assignment *const assignment, DecisionBuilder *const db, const IntVar *const *vars, int size)

Returns a decision builder for which the left-most leaf corresponds to assignment, the rest of the tree being explored using 'db'.

DecisionBuilder * MakeConstraintAdder (Constraint *const ct)

Returns a decision builder that will add the given constraint to the model.

DecisionBuilder * MakeSolveOnce (DecisionBuilder *const db)

SolveOnce will collapse a search tree described by a decision builder 'db' and a set of monitors and wrap it into a single point.

DecisionBuilder * MakeSolveOnce (DecisionBuilder *const db, SearchMonitor *const monitor1)

DecisionBuilder * MakeSolveOnce (DecisionBuilder *const db, SearchMonitor *const monitor1, SearchMonitor *const monitor2)

DecisionBuilder * MakeSolveOnce (DecisionBuilder *const db, SearchMonitor *const monitor1, SearchMonitor *const monitor2, SearchMonitor *const monitor3)

DecisionBuilder * MakeSolveOnce (DecisionBuilder *const db, SearchMonitor *const monitor1, SearchMonitor *const monitor2, SearchMonitor *const monitor3, SearchMonitor *const monitor4)

DecisionBuilder * MakeSolveOnce (DecisionBuilder *const db, const std::vector< SearchMonitor * > &monitors)

DecisionBuilder * MakeNestedOptimize (DecisionBuilder *const db, Assignment *const solution, bool maximize, int64 step)

NestedOptimize will collapse a search tree described by a decision builder 'db' and a set of monitors and wrap it into a single point.

DecisionBuilder * MakeNestedOptimize (DecisionBuilder *const db, Assignment *const solution, bool maximize, int64 step, SearchMonitor *const monitor1)

DecisionBuilder * MakeNestedOptimize (DecisionBuilder *const db, Assignment *const solution, bool maximize, int64 step, SearchMonitor *const monitor1, SearchMonitor *const monitor2)

DecisionBuilder * MakeNestedOptimize (DecisionBuilder *const db, Assignment *const solution, bool maximize, int64 step, SearchMonitor *const monitor1, SearchMonitor *const monitor2, SearchMonitor *const monitor3)

DecisionBuilder * MakeNestedOptimize (DecisionBuilder *const db, Assignment *const solution, bool maximize, int64 step, SearchMonitor *const monitor1, SearchMonitor *const monitor2, SearchMonitor *const monitor3, SearchMonitor *const monitor4)

DecisionBuilder * MakeNestedOptimize (DecisionBuilder *const db, Assignment *const solution, bool maximize, int64 step, const std::vector< SearchMonitor * > &monitors)

DecisionBuilder * MakeRestoreAssignment (Assignment *assignment)

Returns a DecisionBuilder which restores an Assignment (calls void Assignment::Restore()).

DecisionBuilder * MakeStoreAssignment (Assignment *assignment)

Returns a DecisionBuilder which stores an Assignment (calls void Assignment::Store()).

LocalSearchOperator * MakeOperator (const std::vector< IntVar * > &vars, LocalSearchOperators op)

Local Search Operators.

LocalSearchOperator * MakeOperator (const IntVar *const *vars, int size, LocalSearchOperators op)

LocalSearchOperator * MakeOperator (const std::vector< IntVar * > &vars, const std::vector< IntVar * > &secondary_vars, LocalSearchOperators op)

LocalSearchOperator * MakeOperator (const IntVar *const *vars, const IntVar *const *secondary_vars, int size, LocalSearchOperators op)

LocalSearchOperator * MakeOperator (const std::vector< IntVar * > &vars, IndexEvaluator3 *const evaluator, EvaluatorLocalSearchOperators op)

LocalSearchOperator * MakeOperator (const IntVar *const *vars, int size, IndexEvaluator3 *const evaluator, EvaluatorLocalSearchOperators op)

LocalSearchOperator * MakeOperator (const std::vector< IntVar * > &vars, const std::vector< IntVar * > &secondary_vars, IndexEvaluator3 *const evaluator, EvaluatorLocalSearchOperators op)

LocalSearchOperator * MakeOperator (const IntVar *const *vars, const IntVar *const *secondary_vars, int size, IndexEvaluator3 *const evaluator, EvaluatorLocalSearchOperators op)

LocalSearchOperator * MakeRandomLNSOperator (const std::vector< IntVar * > &vars, int number_of_variables)

Creates a large neighborhood search operator which creates fragments (set of relaxed variables) with up to number_of_variables random variables (sampling with replacement is performed meaning that at most number_of_variables variables are selected).

LocalSearchOperator * MakeRandomLNSOperator (const std::vector< IntVar * > &vars, int number_of_variables, int32 seed)

LocalSearchOperator * MakeRandomLNSOperator (const IntVar *const *vars, int size, int number_of_variables)

LocalSearchOperator * MakeRandomLNSOperator (const IntVar *const *vars, int size, int number_of_variables, int32 seed)

LocalSearchOperator * MakeMoveTowardTargetOperator (const Assignment &target)

Creates a local search operator that tries to move the assignment of some variables toward a target.

LocalSearchOperator * MakeMoveTowardTargetOperator (const std::vector< IntVar * > &variables, const std::vector< int64 > &target_values)

Creates a local search operator that tries to move the assignment of some variables toward a target.

LocalSearchOperator * ConcatenateOperators (const std::vector< LocalSearchOperator * > &ops)

Creates a local search operator which concatenates a vector of operators.

LocalSearchOperator * ConcatenateOperators (const std::vector< LocalSearchOperator * > &ops, bool restart)

LocalSearchOperator * ConcatenateOperators (const std::vector< LocalSearchOperator * > &ops, ResultCallback2< int64, int, int > *const evaluator)

LocalSearchOperator * RandomConcatenateOperators (const std::vector< LocalSearchOperator * > &ops)

Randomized version of local search concatenator; calls a random operator at each call to MakeNextNeighbor().

LocalSearchOperator * MakeNeighborhoodLimit (LocalSearchOperator *const op, int64 limit)

Creates a local search operator that wraps another local search operator and limits the number of neighbors explored (i.e.

DecisionBuilder * MakeLocalSearchPhase (Assignment *const assignment, LocalSearchPhaseParameters *const parameters)

Local Search decision builders factories.

DecisionBuilder * MakeLocalSearchPhase (const std::vector< IntVar * > &vars, DecisionBuilder *const first_solution, LocalSearchPhaseParameters *const parameters)

DecisionBuilder * MakeLocalSearchPhase (IntVar *const *vars, int size, DecisionBuilder *const first_solution, LocalSearchPhaseParameters *const parameters)

SolutionPool * MakeDefaultSolutionPool ()

Solution Pool.

LocalSearchPhaseParameters * MakeLocalSearchPhaseParameters (LocalSearchOperator *const ls_operator, DecisionBuilder *const sub_decision_builder)

Local Search Phase Parameters.

LocalSearchPhaseParameters * MakeLocalSearchPhaseParameters (LocalSearchOperator *const ls_operator, DecisionBuilder *const sub_decision_builder, SearchLimit *const limit)

LocalSearchPhaseParameters * MakeLocalSearchPhaseParameters (LocalSearchOperator *const ls_operator, DecisionBuilder *const sub_decision_builder, SearchLimit *const limit, const std::vector< LocalSearchFilter * > &filters)

LocalSearchPhaseParameters * MakeLocalSearchPhaseParameters (SolutionPool *const pool, LocalSearchOperator *const ls_operator, DecisionBuilder *const sub_decision_builder)

LocalSearchPhaseParameters * MakeLocalSearchPhaseParameters (SolutionPool *const pool, LocalSearchOperator *const ls_operator, DecisionBuilder *const sub_decision_builder, SearchLimit *const limit)

LocalSearchPhaseParameters * MakeLocalSearchPhaseParameters (SolutionPool *const pool, LocalSearchOperator *const ls_operator, DecisionBuilder *const sub_decision_builder, SearchLimit *const limit, const std::vector< LocalSearchFilter * > &filters)

LocalSearchFilter * MakeVariableDomainFilter ()

Local Search Filters.

LocalSearchFilter * MakeLocalSearchObjectiveFilter (const IntVar *const *vars, int size, IndexEvaluator2 *const values, const IntVar *const objective, Solver::LocalSearchFilterBound filter_enum, Solver::LocalSearchOperation op_enum)

namespace

LocalSearchFilter * MakeLocalSearchObjectiveFilter (const std::vector< IntVar * > &vars, IndexEvaluator2 *const values, const IntVar *const objective, Solver::LocalSearchFilterBound filter_enum, Solver::LocalSearchOperation op_enum)

LocalSearchFilter * MakeLocalSearchObjectiveFilter (const IntVar *const *vars, const IntVar *const *secondary_vars, int size, ResultCallback3< int64, int64, int64, int64 > *const values, const IntVar *const objective, Solver::LocalSearchFilterBound filter_enum, Solver::LocalSearchOperation op_enum)

void TopPeriodicCheck ()

Performs PeriodicCheck on the top-level search; can be called from a nested solve to check top-level limits for instance.

int TopProgressPercent ()

Returns a percentage representing the propress of the search before reaching the limits of the top-level search (can be called from a nested solve).

void PushState ()

The PushState and PopState methods manipulates the states of the reversible objects.

void PopState ()

int SearchDepth () const

Gets the search depth of the current active search.

int SearchLeftDepth () const

Gets the search left depth of the current active search.

int SolveDepth () const

Gets the number of nested searches.

void SetBranchSelector (ResultCallback1< Solver::DecisionModification, Solver * > *const bs)

Sets the given branch selector on the current active search.

DecisionBuilder * MakeApplyBranchSelector (ResultCallback1< Solver::DecisionModification, Solver * > *const bs)

Creates a decision builder that will set the branch selector.

template<class T>

void SaveAndSetValue (T *adr, T val)

All-in-one SaveAndSetValue.

template<class T>

void SaveAndAdd (T *adr, T val)

All-in-one SaveAndAdd_value.

int64 Rand64 (int64 size)

Returns a random value between 0 and 'size' - 1;.

int32 Rand32 (int32 size)

Returns a random value between 0 and 'size' - 1;.

void ReSeed (int32 seed)

Reseed the solver random generator.

void AddFailHook (Action *a)

Adds a fail hook, that is an action that will be called after each failure.

void ExportProfilingOverview (const string &filename)

Exports the profiling information in a human readable overview.

bool CurrentlyInSolve () const

Returns true whether the current search has been created using a Solve() call instead of a NewSearch 0ne.

int constraints () const

Counts the number of constraints that have been added to the solver before the search,.

void Accept (ModelVisitor *const visitor) const

Accepts the given model visitor.

void Accept (ModelVisitor *const visitor, const std::vector< SearchMonitor * > &monitors) const

Accepts the given model visitor.

Decision * balancing_decision () const

void set_fail_intercept (Closure *const c)

Internal set_fail_intercept does not take ownership of the closure.

void clear_fail_intercept ()

DemonProfiler * demon_profiler () const

Access to demon profiler.

bool HasName (const PropagationBaseObject *object) const

Returns whether the object has been named or not.

Demon * RegisterDemon (Demon *const d)

Adds a new demon and wraps it inside a DemonProfiler if necessary.

IntExpr * RegisterIntExpr (IntExpr *const expr)

Registers a new IntExpr and wraps it inside a TraceIntExpr if necessary.

IntVar * RegisterIntVar (IntVar *const var)

Registers a new IntVar and wraps it inside a TraceIntVar if necessary.

IntervalVar * RegisterIntervalVar (IntervalVar *const var)

Registers a new IntervalVar and wraps it inside a TraceIntervalVar if necessary.

Search * ActiveSearch () const

Returns the active search, NULL outside search.

ModelCache * Cache () const

Returns the cache of the model.

bool InstrumentsDemons () const

Returns whether we are instrumenting demons.

bool IsProfilingEnabled () const

Returns whether we are profiling the solver.

bool InstrumentsVariables () const

Returns whether we are tracing variables.

bool NameAllVariables () const

Returns whether all variables should be named.

string model_name () const

Returns the name of the model.

DependencyGraph * Graph () const

Returns the dependency graph of the solver.

PropagationMonitor * GetPropagationMonitor () const

Returns the propagation monitor.

void AddPropagationMonitor (PropagationMonitor *const monitor)

Adds the propagation monitor to the solver.

bool Solve (DecisionBuilder *const db, const std::vector< SearchMonitor * > &monitors)

bool Solve (DecisionBuilder *const db, SearchMonitor *const *monitors, int size)

bool Solve (DecisionBuilder *const db)

bool Solve (DecisionBuilder *const db, SearchMonitor *const m1)

bool Solve (DecisionBuilder *const db, SearchMonitor *const m1, SearchMonitor *const m2)

bool Solve (DecisionBuilder *const db, SearchMonitor *const m1, SearchMonitor *const m2, SearchMonitor *const m3)

bool Solve (DecisionBuilder *const db, SearchMonitor *const m1, SearchMonitor *const m2, SearchMonitor *const m3, SearchMonitor *const m4)

void NewSearch (DecisionBuilder *const db, const std::vector< SearchMonitor * > &monitors)

void NewSearch (DecisionBuilder *const db, SearchMonitor *const *monitors, int size)

Opens a new top level search.

void NewSearch (DecisionBuilder *const db)

void NewSearch (DecisionBuilder *const db, SearchMonitor *const m1)

void NewSearch (DecisionBuilder *const db, SearchMonitor *const m1, SearchMonitor *const m2)

void NewSearch (DecisionBuilder *const db, SearchMonitor *const m1, SearchMonitor *const m2, SearchMonitor *const m3)

void NewSearch (DecisionBuilder *const db, SearchMonitor *const m1, SearchMonitor *const m2, SearchMonitor *const m3, SearchMonitor *const m4)

bool NextSolution ()

namespace

void RestartSearch ()

void EndSearch ()

Static Public Member Functions

static bool UpgradeModel (CPModelProto *const proto)

Upgrades the model to the latest version.

static int64 MemoryUsage ()

Current memory usage in bytes.

Static Public Attributes

static const int kNumPriorities = 3

Number of priorities for demons.

Friends

class BaseIntExpr

class Constraint

class DemonProfiler

class FindOneNeighbor

class IntVar

class PropagationBaseObject

class Queue

class SearchMonitor

class SimpleRevFIFO

class RevImmutableMultiMap

void InternalSaveBooleanVarValue (Solver *const, IntVar *const)

void SetQueueCleanerOnFail (Solver *const, IntVar *const)

Classes

struct IntegerCastInfo

Holds semantic information stating that the 'expression' has been cast into 'variable' using the Var() method, and that 'maintainer' is responsible for maintaining the equality between 'variable' and 'expression'. More...

Detailed Description

Solver Class.

A solver represent the main computation engine. It implements the whole range of Constraint Programming protocol:

Reversibility
Propagation
Search

Usually, a Constraint Programming code consists of

the creation of the Solver,
the creation of the decision variables of the model,
the creation of the constraints of the model and their addition to the solver() through the AddConstraint() method,
the creation of the main DecisionBuilder class,
the launch of the solve method with the above-created decision builder.

For the time being, Solver is not MT_SAFE, nor MT_HOT.

Definition at line 342 of file constraint_solver.h.

Member Typedef Documentation

typedef ResultCallback1<int64, int64> operations_research::Solver::IndexEvaluator1

Callback typedefs.

Definition at line 345 of file constraint_solver.h.

typedef ResultCallback2<int64, int64, int64> operations_research::Solver::IndexEvaluator2

Definition at line 346 of file constraint_solver.h.

typedef ResultCallback3<int64, int64, int64, int64> operations_research::Solver::IndexEvaluator3

Definition at line 347 of file constraint_solver.h.

typedef ResultCallback2<IntExpr*, CPModelLoader*, const CPIntegerExpressionProto&> operations_research::Solver::IntegerExpressionBuilder

Definition at line 351 of file constraint_solver.h.

typedef ResultCallback2<Constraint*, CPModelLoader*, const CPConstraintProto&> operations_research::Solver::ConstraintBuilder

Definition at line 354 of file constraint_solver.h.

typedef ResultCallback2<IntervalVar*, CPModelLoader*, const CPIntervalVariableProto&> operations_research::Solver::IntervalVariableBuilder

Definition at line 358 of file constraint_solver.h.

typedef ResultCallback2<SequenceVar*, CPModelLoader*, const CPSequenceVariableProto&> operations_research::Solver::SequenceVariableBuilder

Definition at line 362 of file constraint_solver.h.

Member Enumeration Documentation

enum operations_research::Solver::IntVarStrategy

This enum describes the strategy used to select the next branching variable at each node during the search.

Enumerator:

INT_VAR_DEFAULT	The default behavior is CHOOSE_FIRST_UNBOUND.
INT_VAR_SIMPLE	The simple selection is CHOOSE_FIRST_UNBOUND.
CHOOSE_FIRST_UNBOUND	Select the first unbound variable. Variables are considered in the order of the vector of IntVars used to create the selector.
CHOOSE_RANDOM	Randomly select one of the remaining unbound variables.
CHOOSE_MIN_SIZE_LOWEST_MIN	Among unbound variables, select the variable with the smallest size, i.e. the smallest number of possible values. In case of tie, the selected variables is the one with the lowest min value. In case of tie, the first one is selected, first being defined by the order in the vector of IntVars used to create the selector.
CHOOSE_MIN_SIZE_HIGHEST_MIN	Among unbound variables, select the variable with the smallest size, i.e. the smallest number of possible values. In case of tie, the selected variables is the one with the highest min value. In case of tie, the first one is selected, first being defined by the order in the vector of IntVars used to create the selector.
CHOOSE_MIN_SIZE_LOWEST_MAX	Among unbound variables, select the variable with the smallest size, i.e. the smallest number of possible values. In case of tie, the selected variables is the one with the lowest max value. In case of tie, the first one is selected, first being defined by the order in the vector of IntVars used to create the selector.
CHOOSE_MIN_SIZE_HIGHEST_MAX	Among unbound variables, select the variable with the smallest size, i.e. the smallest number of possible values. In case of tie, the selected variables is the one with the highest max value. In case of tie, the first one is selected, first being defined by the order in the vector of IntVars used to create the selector.
CHOOSE_PATH	Selects the next unbound variable on a path, the path being defined by the variables: var[i] corresponds to the index of the next of i.

Definition at line 382 of file constraint_solver.h.

enum operations_research::Solver::IntValueStrategy

This enum describes the strategy used to select the next variable value to set.

Enumerator:

INT_VALUE_DEFAULT	The default behavior is ASSIGN_MIN_VALUE.
INT_VALUE_SIMPLE	The simple selection is ASSIGN_MIN_VALUE.
ASSIGN_MIN_VALUE	Selects the min value of the selected variable.
ASSIGN_MAX_VALUE	Selects the max value of the selected variable.
ASSIGN_RANDOM_VALUE	Selects randomly one of the possible values of the selected variable.
ASSIGN_CENTER_VALUE	Selects the first possible value which is the closest to the center of the domain of the selected variable. The center is defined as (min + max) / 2.

Definition at line 436 of file constraint_solver.h.

enum operations_research::Solver::EvaluatorStrategy

This enum is used by Solver::MakePhase to specify how to select variables and values during the search.

In Solver::MakePhase(const std::vector<IntVar*>&, IntVarStrategy, IntValueStrategy), variables are selected first, and then the associated value. In Solver::MakePhase(const std::vector<IntVar*>& vars, IndexEvaluator2*, EvaluatorStrategy), the selection is done scanning every pair <variable, possible value>. The next selected pair is then the best among all possibilities, i.e. the pair with the smallest evaluation. As this is costly, two options are offered: static or dynamic evaluation.

Enumerator:

CHOOSE_STATIC_GLOBAL_BEST	Pairs are compared at the first call of the selector, and results are cached. Next calls to the selector use the previous computation, and so are not up-to-date, e.g. some <variable, value> pairs may not be possible anymore due to propagation since the first to call.
CHOOSE_DYNAMIC_GLOBAL_BEST	Pairs are compared each time a variable is selected. That way all pairs are relevant and evaluation is accurate. This strategy runs in O(number-of-pairs) at each variable selection, versus O(1) in the static version.

Definition at line 468 of file constraint_solver.h.

enum operations_research::Solver::SequenceStrategy

Used for scheduling. Not yet implemented.

Enumerator:

SEQUENCE_DEFAULT
SEQUENCE_SIMPLE
CHOOSE_MIN_SLACK_RANK_FORWARD
CHOOSE_RANDOM_RANK_FORWARD

Definition at line 483 of file constraint_solver.h.

enum operations_research::Solver::IntervalStrategy

Used for scheduling. Not yet implemented.

Enumerator:

INTERVAL_DEFAULT
INTERVAL_SIMPLE
INTERVAL_SET_TIMES_FORWARD

Definition at line 491 of file constraint_solver.h.

enum operations_research::Solver::LocalSearchOperators

This enum is used in Solver::MakeOperator to specify the neighborhood to create.

Enumerator:

TWOOPT	Operator which reverves a sub-chain of a path. It is called TwoOpt because it breaks two arcs on the path; resulting paths are called two-optimal. Possible neighbors for the path 1 -> 2 -> 3 -> 4 -> 5 (where (1, 5) are first and last nodes of the path and can therefore not be moved): 1 -> [3 -> 2] -> 4 -> 5 1 -> [4 -> 3 -> 2] -> 5 1 -> 2 -> [4 -> 3] -> 5
OROPT	Relocate: OROPT and RELOCATE. Operator which moves a sub-chain of a path to another position; the specified chain length is the fixed length of the chains being moved. When this length is 1, the operator simply moves a node to another position. Possible neighbors for the path 1 -> 2 -> 3 -> 4 -> 5, for a chain length of 2 (where (1, 5) are first and last nodes of the path and can therefore not be moved): 1 -> 4 -> [2 -> 3] -> 5 1 -> [3 -> 4] -> 2 -> 5 Using Relocate with chain lengths of 1, 2 and 3 together is equivalent to the OrOpt operator on a path. The OrOpt operator is a limited version of 3Opt (breaks 3 arcs on a path).
RELOCATE	Relocate neighborhood with length of 1 (see OROPT comment).
EXCHANGE	Operator which exchanges the positions of two nodes. Possible neighbors for the path 1 -> 2 -> 3 -> 4 -> 5 (where (1, 5) are first and last nodes of the path and can therefore not be moved): 1 -> [3] -> [2] -> 4 -> 5 1 -> [4] -> 3 -> [2] -> 5 1 -> 2 -> [4] -> [3] -> 5
CROSS	Operator which cross exchanges the starting chains of 2 paths, including exchanging the whole paths. First and last nodes are not moved. Possible neighbors for the paths 1 -> 2 -> 3 -> 4 -> 5 and 6 -> 7 -> 8 (where (1, 5) and (6, 8) are first and last nodes of the paths and can therefore not be moved): 1 -> [7] -> 3 -> 4 -> 5 6 -> [2] -> 8 1 -> [7] -> 4 -> 5 6 -> [2 -> 3] -> 8 1 -> [7] -> 5 6 -> [2 -> 3 -> 4] -> 8
MAKEACTIVE	Operator which inserts an inactive node into a path. Possible neighbors for the path 1 -> 2 -> 3 -> 4 with 5 inactive (where 1 and 4 are first and last nodes of the path) are: 1 -> [5] -> 2 -> 3 -> 4 1 -> 2 -> [5] -> 3 -> 4 1 -> 2 -> 3 -> [5] -> 4
MAKEINACTIVE	Operator which makes path nodes inactive. Possible neighbors for the path 1 -> 2 -> 3 -> 4 (where 1 and 4 are first and last nodes of the path) are: 1 -> 3 -> 4 with 2 inactive 1 -> 2 -> 4 with 3 inactive
SWAPACTIVE	Operator which replaces an active node by an inactive one. Possible neighbors for the path 1 -> 2 -> 3 -> 4 with 5 inactive (where 1 and 4 are first and last nodes of the path) are: 1 -> [5] -> 3 -> 4 with 2 inactive 1 -> 2 -> [5] -> 4 with 3 inactive
EXTENDEDSWAPACTIVE	Operator which makes an inactive node active and an active one inactive. It is similar to SwapActiveOperator excepts that it tries to insert the inactive node in all possible positions instead of just the position of the node made inactive. Possible neighbors for the path 1 -> 2 -> 3 -> 4 with 5 inactive (where 1 and 4 are first and last nodes of the path) are: 1 -> [5] -> 3 -> 4 with 2 inactive 1 -> 3 -> [5] -> 4 with 2 inactive 1 -> [5] -> 2 -> 4 with 3 inactive 1 -> 2 -> [5] -> 4 with 3 inactive
PATHLNS	Operator which relaxes two sub-chains of three consecutive arcs each. Each sub-chain is defined by a start node and the next three arcs. Those six arcs are relaxed to build a new neighbor. PATHLNS explores all possible pairs of starting nodes and so defines n^2 neighbors, n being the number of nodes. Note that the two sub-chains can be part of the same path; they even may overlap.
UNACTIVELNS	Operator which relaxes all inactive nodes and one sub-chain of six consecutive arcs. That way the path can be improve by inserting inactive nodes or swaping arcs.
INCREMENT	Operator which defines one neighbor per variable. Each neighbor tries to increment by one the value of the corresponding variable. When a new solution is found the neighborhood is rebuilt from scratch, i.e. tries to increment values in the variable order. Consider for instance variables x and y. x is incremented 1 by 1 to its max, and when it is not possible to increment x anymore, y is incremented once. If this is a solution, then next neighbor tries to increment x.
DECREMENT	Operator which defines a neighborhood to decrement values. The behavior is the same as INCREMENT, except values are decremented instead of incremented.
SIMPLELNS	Operator which defines one neighbor per variable. Each neighbor relaxes one variable. When a new solution is found the neighborhood is rebuilt from scratch. Consider for instance variables x and y. First x is relaxed and the solver is looking for the best possible solution (with only x relaxed). Then y is relaxed, and the solver is looking for a new solution. If a new solution is found, then the next variable to be relaxed is x.

Definition at line 499 of file constraint_solver.h.

enum operations_research::Solver::EvaluatorLocalSearchOperators

This enum is used in Solver::MakeOperator associated with an evaluator to specify the neighborhood to create.

Enumerator:

LK	Lin–Kernighan local search. While the accumulated local gain is positive, perform a 2opt or a 3opt move followed by a series of 2opt moves. Return a neighbor for which the global gain is positive.
TSPOPT	Sliding TSP operator. Uses an exact dynamic programming algorithm to solve the TSP corresponding to path sub-chains. For a subchain 1 -> 2 -> 3 -> 4 -> 5 -> 6, solves the TSP on nodes A, 2, 3, 4, 5, where A is a merger of nodes 1 and 6 such that cost(A,i) = cost(1,i) and cost(i,A) = cost(i,6).
TSPLNS	TSP-base LNS. Randomly merge consecutive nodes until n "meta"-nodes remain and solve the corresponding TSP. This is an "unlimited" neighborhood which must be stopped by search limits. To force diversification, the operator iteratively forces each node to serve as base of a meta-node.

Definition at line 624 of file constraint_solver.h.

enum operations_research::Solver::LocalSearchFilterBound

This enum is used in Solver::MakeLocalSearchObjectiveFilter.

It specifies the behavior of the objective filter to create. The goal is to define under which condition a move is accepted based on the current objective value.

Enumerator:

GE	Move is accepted when the current objective value >= objective.Min.
LE	Move is accepted when the current objective value <= objective.Max.
EQ	Move is accepted when the current objective value is in the interval objective.Min . . objective.Max.

Definition at line 652 of file constraint_solver.h.

enum operations_research::Solver::LocalSearchOperation

This enum is used in Solver::MakeLocalSearchObjectiveFilter.

It specifies the operation used in the objective to build the corresponding filter.

Enumerator:

SUM	The objective is the sum of the variables defined in Solver::MakeLocalSearchObjectiveFilter.
PROD	The objective is the product of the variables defined in Solver::MakeLocalSearchObjectiveFilter.
MAX	The objective is the max of the variables defined in Solver::MakeLocalSearchObjectiveFilter.
MIN	The objective is the min of the variables defined in Solver::MakeLocalSearchObjectiveFilter.

Definition at line 664 of file constraint_solver.h.

enum operations_research::Solver::DemonPriority

This enum represents the three possible priorities for a demon in the Solver queue.

Note this is for advanced users only.

Enumerator:

DELAYED_PRIORITY	DELAYED_PRIORITY is the lowest priority: Demons will be processed after VAR_PRIORITY and NORMAL_PRIORITY demons.
VAR_PRIORITY	VAR_PRIORITY is between DELAYED_PRIORITY and NORMAL_PRIORITY.
NORMAL_PRIORITY	NORMAL_PRIORITY is the highest priority: Demons will be processed first.

Definition at line 685 of file constraint_solver.h.

enum operations_research::Solver::BinaryIntervalRelation

This enum is used in Solver::MakeIntervalVarRelation to specify the temporal relation between the two intervals t1 and t2.

Enumerator:

ENDS_AFTER_END	t1 ends after t2 end, i.e. End(t1) >= End(t2).
ENDS_AFTER_START	t1 ends after t2 start, i.e. End(t1) >= Start(t2).
ENDS_AT_END	t1 ends at t2 end, i.e. End(t1) == End(t2).
ENDS_AT_START	t1 ends at t2 start, i.e. End(t1) == Start(t2).
STARTS_AFTER_END	t1 starts after t2 end, i.e. Start(t1) >= End(t2).
STARTS_AFTER_START	t1 starts after t2 start, i.e. Start(t1) >= Start(t2).
STARTS_AT_END	t1 starts at t2 end, i.e. Start(t1) == End(t2).
STARTS_AT_START	t1 starts at t2 start, i.e. Start(t1) == Start(t2).
STAYS_IN_SYNC	STARTS_AT_START and ENDS_AT_END at the same time. t1 starts at t2 start, i.e. Start(t1) == Start(t2). t1 ends at t2 end, i.e. End(t1) == End(t2).

Definition at line 699 of file constraint_solver.h.

enum operations_research::Solver::UnaryIntervalRelation

This enum is used in Solver::MakeIntervalVarRelation to specify the temporal relation between an interval t and an integer d.

Enumerator:

ENDS_AFTER	t ends after d, i.e. End(t) >= d.
ENDS_AT	t ends at d, i.e. End(t) == d.
ENDS_BEFORE	t ends before d, i.e. End(t) <= d.
STARTS_AFTER	t starts after d, i.e. Start(t) >= d.
STARTS_AT	t starts at d, i.e. Start(t) == d.
STARTS_BEFORE	t starts before d, i.e. Start(t) <= d.
CROSS_DATE	STARTS_BEFORE and ENDS_AFTER at the same time, i.e. d is in t. t starts before d, i.e. Start(t) <= d. t ends after d, i.e. End(t) >= d.
AVOID_DATE	STARTS_AFTER or ENDS_BEFORE, i.e. d is not in t. t starts after d, i.e. Start(t) >= d. t ends before d, i.e. End(t) <= d.

Definition at line 732 of file constraint_solver.h.

enum operations_research::Solver::DecisionModification

The Solver is responsible for creating the search tree.

Thanks to the DecisionBuilder, it creates a new decision with two branches at each node: left and right. The DecisionModification enum is used to specify how the branch selector should behave.

Enumerator:

NO_CHANGE	Keeps the default behavior, i.e. apply left branch first, and then right branch in case of backtracking.
KEEP_LEFT	Right branches are ignored. This is used to make the code faster when backtrack makes no sense or is not useful. This is faster as there is no need to create one new node per decision.
KEEP_RIGHT	Left branches are ignored. This is used to make the code faster when backtrack makes no sense or is not useful. This is faster as there is no need to create one new node per decision.
KILL_BOTH	Backtracks to the previous decisions, i.e. left and right branches are not applied.
SWITCH_BRANCHES	Applies right branch first. Left branch will be applied in case of backtracking.

Definition at line 767 of file constraint_solver.h.

enum operations_research::Solver::MarkerType

This enum is used internally in private methods Solver::PushState and Solver::PopState to tag states in the search tree.

Enumerator:

SENTINEL
SIMPLE_MARKER
CHOICE_POINT
REVERSIBLE_ACTION

Definition at line 793 of file constraint_solver.h.

enum operations_research::Solver::SolverState

This enum represents the state of the solver w.r.t. the search.

Enumerator:

OUTSIDE_SEARCH	Before search, after search.
IN_ROOT_NODE	Executing the root node.
IN_SEARCH	Executing the search code.
AT_SOLUTION	After successful NextSolution and before EndSearch.
NO_MORE_SOLUTIONS	After failed NextSolution and before EndSearch.
PROBLEM_INFEASIBLE	After search, the model is infeasible.

Definition at line 801 of file constraint_solver.h.

Constructor & Destructor Documentation

operations_research::Solver::Solver ( const string & modelname ) [explicit]

Definition at line 1407 of file constraint_solver.cc.

operations_research::Solver::Solver	(	const string &	modelname,
		const SolverParameters &	parameters
	)

Definition at line 1373 of file constraint_solver.cc.

operations_research::Solver::~Solver ( )

Definition at line 1457 of file constraint_solver.cc.

Member Function Documentation

const SolverParameters& operations_research::Solver::parameters ( ) const [inline]

Read-only Parameters.

Definition at line 815 of file constraint_solver.h.

template<class T>

void operations_research::Solver::SaveValue ( T * o ) [inline]

reversibility

SaveValue() will save the value of the corresponding object. It must be called before modifying the object. The value will be restored upon backtrack.

Definition at line 822 of file constraint_solver.h.

template<typename T>

T* operations_research::Solver::RevAlloc ( T * object ) [inline]

Registers the given object as being reversible.

By calling this method, the caller gives ownership of the object to the solver, which will delete it when there is a backtrack out of the current state.

Returns the argument for convenience: this way, the caller may directly invoke a constructor in the argument, without having to store the pointer first.

This function is only for users that define their own subclasses of BaseObject: for all subclasses predefined in the library, the corresponding factory methods (e.g., MakeIntVar(...), MakeAllDifferent(...) already take care of the registration.

Definition at line 838 of file constraint_solver.h.

template<typename T>

T* operations_research::Solver::RevAllocArray ( T * object ) [inline]

Like RevAlloc() above, but for an array of objects: the array must have been allocated with the new[] operator.

The entire array will be deleted when backtracking out of the current state.

This method is valid for arrays of int, int64, uint64, bool, BaseObject*, IntVar*, IntExpr*, and Constraint*.

Definition at line 848 of file constraint_solver.h.

void operations_research::Solver::AddConstraint ( Constraint *const c )

propagation

Adds the constraint 'c' to the model.

After calling this method, and until there is a backtrack that undoes the addition, any assignment of variables to values must satisfy the given constraint in order to be considered feasible. There are two fairly different use cases:

the most common use case is modeling: the given constraint is really part of the problem that the user is trying to solve. In this use case, AddConstraint is called outside of search (i.e., with state() == OUTSIDE_SEARCH). Most users should only use AddConstraint in this way. In this case, the constraint will belong to the model forever: it cannot not be removed by backtracking.

a rarer use case is that 'c' is not a real constraint of the model. It may be a constraint generated by a branching decision (a constraint whose goal is to restrict the search space), a symmetry breaking constraint (a constraint that does restrict the search space, but in a way that cannot have an impact on the quality of the solutions in the subtree), or an inferred constraint that, while having no semantic value to the model (it does not restrict the set of solutions), is worth having because we believe it may strengthen the propagation. In these cases, it happens that the constraint is added during the search (i.e., with state() == IN_SEARCH or state() == IN_ROOT_NODE). When a constraint is added during a search, it applies only to the subtree of the search tree rooted at the current node, and will be automatically removed by bracktracking.

This method does not take ownership of the constraint. If the constraint has been created by any factory method (Solver::MakeXXX), it will automatically be deleted. However, power users who implement their own constraints should do: solver.AddConstraint(solver.RevAlloc(new MyConstraint(...));

Definition at line 1659 of file constraint_solver.cc.

void operations_research::Solver::AddCastConstraint	(	CastConstraint *const	c,
		IntVar *const	target_var,
		IntExpr *const	casted_expression
	)

Adds the constraint 'c' to the solver and marks it as a cast constraint, that is, a constraint created calling Var() on an expression.

This is used internally.

Definition at line 1679 of file constraint_solver.cc.

bool operations_research::Solver::Solve	(	DecisionBuilder *const	db,
		const std::vector< SearchMonitor * > &	monitors
	)

Solves the problem using the given DecisionBuilder and returns true if a solution was found and accepted.

These methods are the ones most users should use to search for a solution. Note that the definition of 'solution' is subtle. A solution here is defined as a leaf of the search tree with respect to the given decision builder for which there is no failure. What this means is that, contrary to intuition, a solution may not have all variables of the model bound. It is the responsibility of the decision builder to keep returning decisions until all variables are indeed bound. The most extreme counterexample is calling Solve with a trivial decision builder whose Next() method always returns NULL. In this case, Solve immediately returns 'true', since not assigning any variable to any value is a solution, unless the root node propagation discovers that the model is infeasible.

These function must be called from outside of search, meaning that state() == OUTSIDE_SEARCH.

Solve will terminate whenever any of the following event arise: A search monitor asks the solver to terminate the search by calling SearchMonitor::FinishCurrentSearch(). A solution is found that is accepted by all search monitors, and none of the search monitors decides to search for another one.

Upon search termination, there will be a series of backtracks all the way to the top level. This means that a user cannot expect to inspect the solution by querying variables after a call to Solve(): all the information will be lost. In order to do something with the solution, the user must either: Use a search monitor that can process such a leaf. See, in particular, the SolutionCollector class. Do not use Solve. Instead, use the more fine-grained approach using methods NewSearch(...), NextSolution(), and EndSearch().

Parameters:

	db	The decision builder that will generate the search tree.
	monitors	A vector of search monitors that will be notified of various events during the search. In their reaction to these events, such monitors may influence the search.

Definition at line 1782 of file constraint_solver.cc.

bool operations_research::Solver::Solve	(	DecisionBuilder *const	db,
		SearchMonitor const	monitors,
		int	size
	)

Definition at line 1830 of file constraint_solver.cc.

bool operations_research::Solver::Solve ( DecisionBuilder *const db )

Definition at line 1793 of file constraint_solver.cc.

bool operations_research::Solver::Solve	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1
	)

Definition at line 1787 of file constraint_solver.cc.

bool operations_research::Solver::Solve	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2
	)

Definition at line 1797 of file constraint_solver.cc.

bool operations_research::Solver::Solve	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2,
		SearchMonitor *const	m3
	)

Definition at line 1806 of file constraint_solver.cc.

bool operations_research::Solver::Solve	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2,
		SearchMonitor *const	m3,
		SearchMonitor *const	m4
	)

Definition at line 1817 of file constraint_solver.cc.

void operations_research::Solver::NewSearch	(	DecisionBuilder *const	db,
		const std::vector< SearchMonitor * > &	monitors
	)

Decomposed top level search. The code should look like solver->NewSearch(db); while (solver->NextSolution()) { .. use the current solution } solver()->EndSearch();

Definition at line 1841 of file constraint_solver.cc.

void operations_research::Solver::NewSearch	(	DecisionBuilder *const	db,
		SearchMonitor const	monitors,
		int	size
	)

Opens a new top level search.

Definition at line 1892 of file constraint_solver.cc.

void operations_research::Solver::NewSearch ( DecisionBuilder *const db )

Definition at line 1852 of file constraint_solver.cc.

void operations_research::Solver::NewSearch	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1
	)

Definition at line 1846 of file constraint_solver.cc.

void operations_research::Solver::NewSearch	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2
	)

Definition at line 1856 of file constraint_solver.cc.

void operations_research::Solver::NewSearch	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2,
		SearchMonitor *const	m3
	)

Definition at line 1865 of file constraint_solver.cc.

void operations_research::Solver::NewSearch	(	DecisionBuilder *const	db,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2,
		SearchMonitor *const	m3,
		SearchMonitor *const	m4
	)

Definition at line 1876 of file constraint_solver.cc.

bool operations_research::Solver::NextSolution ( )

namespace

Search for the next solution in the search tree.

Definition at line 2126 of file constraint_solver.cc.

void operations_research::Solver::RestartSearch ( )

Definition at line 2013 of file constraint_solver.cc.

void operations_research::Solver::EndSearch ( )

Definition at line 2292 of file constraint_solver.cc.

bool operations_research::Solver::NestedSolve	(	DecisionBuilder *const	db,
		bool	restore,
		const std::vector< SearchMonitor * > &	monitors
	)

Nested solve using a decision builder and up to three search monitors, usually one for the objective, one for the limits and one to collect solutions.

The restore parameter indicates if the search should backtrack completely after completion, even in case of success.

Definition at line 2385 of file constraint_solver.cc.

bool operations_research::Solver::NestedSolve	(	DecisionBuilder *const	db,
		bool	restore,
		SearchMonitor const	monitors,
		int	size
	)

Definition at line 2425 of file constraint_solver.cc.

bool operations_research::Solver::NestedSolve	(	DecisionBuilder *const	db,
		bool	restore
	)

Definition at line 2399 of file constraint_solver.cc.

bool operations_research::Solver::NestedSolve	(	DecisionBuilder *const	db,
		bool	restore,
		SearchMonitor *const	m1
	)

Definition at line 2391 of file constraint_solver.cc.

bool operations_research::Solver::NestedSolve	(	DecisionBuilder *const	db,
		bool	restore,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2
	)

Definition at line 2403 of file constraint_solver.cc.

bool operations_research::Solver::NestedSolve	(	DecisionBuilder *const	db,
		bool	restore,
		SearchMonitor *const	m1,
		SearchMonitor *const	m2,
		SearchMonitor *const	m3
	)

Definition at line 2413 of file constraint_solver.cc.

bool operations_research::Solver::CheckAssignment ( Assignment *const assignment )

Checks whether the given assignment satisfies all the relevant constraints.

Definition at line 2305 of file constraint_solver.cc.

bool operations_research::Solver::CheckConstraint ( Constraint *const constraint )

Checks whether adding this constraint will lead to an immediate failure.

It will return true if the model is already inconsistent, or if adding the constraint makes it inconsistent.

Definition at line 2381 of file constraint_solver.cc.

SolverState operations_research::Solver::state ( ) const [inline]

State of the solver.

Definition at line 1020 of file constraint_solver.h.

void operations_research::Solver::Fail ( )

Abandon the current branch in the search tree. A backtrack will follow.

Definition at line 2474 of file constraint_solver.cc.

void operations_research::Solver::ExportModel ( CPModelProto *const proto ) const

Exports the model to protobuf.

This code will be called from inside the solver during the start of the search.

Definition at line 2418 of file io.cc.

void operations_research::Solver::ExportModel	(	const std::vector< SearchMonitor * > &	monitors,
		CPModelProto *const	proto
	)			const

Exports the model to protobuf.

Solver API.

Search monitors are useful to pass the objective and limits to the protobuf.

Definition at line 2403 of file io.cc.

bool operations_research::Solver::LoadModel ( const CPModelProto & proto )

Loads the model into the solver, and returns true upon success.

Definition at line 2426 of file io.cc.

bool operations_research::Solver::LoadModel	(	const CPModelProto &	proto,
		std::vector< SearchMonitor * > *	monitors
	)

Loads the model into the solver, appends search monitors to monitors, and returns true upon success.

Definition at line 2430 of file io.cc.

bool operations_research::Solver::UpgradeModel ( CPModelProto *const proto ) [static]

Upgrades the model to the latest version.

Definition at line 2495 of file io.cc.

bool operations_research::Solver::CollectDecisionVariables	(	std::vector< IntVar * > *const	primary_integer_variables,
		std::vector< IntVar * > *const	secondary_integer_variables,
		std::vector< SequenceVar * > *const	sequence_variables,
		std::vector< IntervalVar * > *const	interval_variables
	)

Collects decision variables.

namespace

All decision variables will be collected in 4 groups:

Main integer decision variables.
Secondary integer variables (that are derived integer variables that should be fixed like times of tasks after the order has been fixed).
Sequence variables.
Interval variables.

From these 4 groups, one could write a decision builder: solver.Compose( solver.MakeDefaultPhase(primary_integer_variables), solver.MakePhase(sequence_variables, Solver::SEQUENCE_DEFAULT), solver.MakePhase(interval_variables, Solver::INTERVAL_DEFAULT), solver.MakePhase(secondary_integer_variables, Solver::INT_VAR_DEFAULT); SWIG

Definition at line 201 of file collect_variables.cc.

void operations_research::Solver::RegisterBuilder	(	const string &	tag,
		ConstraintBuilder *const	builder
	)

Registers a constraint builder. Ownership is passed to the solver.

Definition at line 2502 of file io.cc.

void operations_research::Solver::RegisterBuilder	(	const string &	tag,
		IntegerExpressionBuilder *const	builder
	)

Registers an integer expression builder. Ownership is passed to the solver.

Definition at line 2507 of file io.cc.

void operations_research::Solver::RegisterBuilder	(	const string &	tag,
		IntervalVariableBuilder *const	builder
	)

Registers an interval variable builder. Ownership is passed to the solver.

Definition at line 2512 of file io.cc.

void operations_research::Solver::RegisterBuilder	(	const string &	tag,
		SequenceVariableBuilder *const	builder
	)

Registers a sequence variable builder. Ownership is passed to the solver.

Definition at line 2517 of file io.cc.

Solver::ConstraintBuilder * operations_research::Solver::GetConstraintBuilder ( const string & tag ) const

Definition at line 2523 of file io.cc.

Solver::IntegerExpressionBuilder * operations_research::Solver::GetIntegerExpressionBuilder ( const string & tag ) const

Definition at line 2528 of file io.cc.

Solver::IntervalVariableBuilder * operations_research::Solver::GetIntervalVariableBuilder ( const string & tag ) const

Definition at line 2533 of file io.cc.

Solver::SequenceVariableBuilder * operations_research::Solver::GetSequenceVariableBuilder ( const string & tag ) const

Definition at line 2540 of file io.cc.

void operations_research::Solver::AddBacktrackAction	(	Action *	a,
		bool	fast
	)

When SaveValue() is not the best way to go, one can create a reversible action that will be called upon backtrack.

The "fast" parameter indicates whether we need restore all values saved through SaveValue() before calling this method.

Definition at line 1571 of file constraint_solver.cc.

string operations_research::Solver::DebugString ( ) const

misc debug string.

Definition at line 1484 of file constraint_solver.cc.

int64 operations_research::Solver::MemoryUsage ( ) [static]

Current memory usage in bytes.

Definition at line 1519 of file constraint_solver.cc.

int64 operations_research::Solver::wall_time ( ) const

wall_time() in ms since the creation of the solver.

Definition at line 1524 of file constraint_solver.cc.

int64 operations_research::Solver::branches ( ) const [inline]

number of branches explored since the creation of the solver.

Definition at line 1099 of file constraint_solver.h.

int64 operations_research::Solver::solutions ( ) const

number of solutions found since the start of the search.

Definition at line 1528 of file constraint_solver.cc.

int64 operations_research::Solver::demon_runs ( DemonPriority p ) const [inline]

number of demons executed during search for a given priority.

Definition at line 1105 of file constraint_solver.h.

int64 operations_research::Solver::failures ( ) const [inline]

number of failures encountered since the creation of the solver.

Definition at line 1108 of file constraint_solver.h.

int64 operations_research::Solver::neighbors ( ) const [inline]

number of neighbors created

Definition at line 1111 of file constraint_solver.h.

int64 operations_research::Solver::filtered_neighbors ( ) const [inline]

number of filtered neighbors (neighbors accepted by filters)

Definition at line 1114 of file constraint_solver.h.

int64 operations_research::Solver::accepted_neighbors ( ) const [inline]

number of accepted neighbors

Definition at line 1117 of file constraint_solver.h.

uint64 operations_research::Solver::stamp ( ) const

The stamp indicates how many moves in the search tree we have performed.

It is useful to detect if we need to update same lazy structures.

Definition at line 1639 of file constraint_solver.cc.

uint64 operations_research::Solver::fail_stamp ( ) const

The fail_stamp() is incremented after each backtrack.

Definition at line 1643 of file constraint_solver.cc.

IntVar * operations_research::Solver::MakeIntVar	(	int64	vmin,
		int64	vmax,
		const string &	name
	)

Make Factory.

API.

All factories (MakeXXX methods) encapsulate creation of objects through RevAlloc(). Hence, the Solver used for allocating the returned object will retain ownership of the allocated memory. Destructors are called upon backtrack, or when the Solver is itself destructed. Int Variables and Constants MakeIntVar will create the best range based int var for the bounds given.

Definition at line 4307 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntVar	(	const std::vector< int64 > &	values,
		const string &	name
	)

MakeIntVar will create a variable with the given sparse domain.

Definition at line 4330 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntVar	(	const std::vector< int > &	values,
		const string &	name
	)

MakeIntVar will create a variable with the given sparse domain.

Definition at line 4345 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntVar	(	int64	vmin,
		int64	vmax
	)

MakeIntVar will create the best range based int var for the bounds given.

Definition at line 4318 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntVar ( const std::vector< int64 > & values )

MakeIntVar will create a variable with the given sparse domain.

Definition at line 4341 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntVar ( const std::vector< int > & values )

MakeIntVar will create a variable with the given sparse domain.

Definition at line 4356 of file expressions.cc.

IntVar * operations_research::Solver::MakeBoolVar ( const string & name )

MakeBoolVar will create a variable with a {0, 1} domain.

Definition at line 4322 of file expressions.cc.

IntVar * operations_research::Solver::MakeBoolVar ( )

MakeBoolVar will create a variable with a {0, 1} domain.

Definition at line 4326 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntConst	(	int64	val,
		const string &	name
	)

IntConst will create a constant expression.

Definition at line 4360 of file expressions.cc.

IntVar * operations_research::Solver::MakeIntConst ( int64 val )

IntConst will create a constant expression.

Definition at line 4372 of file expressions.cc.

void operations_research::Solver::MakeIntVarArray	(	int	var_count,
		int64	vmin,
		int64	vmax,
		const string &	name,
		std::vector< IntVar * > *	vars
	)

This method will append the vector vars with 'var_count' variables having bounds vmin and vmax and having name "name<i>" where is the index of the variable.

namespace

Definition at line 4391 of file expressions.cc.

void operations_research::Solver::MakeIntVarArray	(	int	var_count,
		int64	vmin,
		int64	vmax,
		std::vector< IntVar * > *	vars
	)

This method will append the vector vars with 'var_count' variables having bounds vmin and vmax and having no names.

Definition at line 4401 of file expressions.cc.

IntVar ** operations_research::Solver::MakeIntVarArray	(	int	var_count,
		int64	vmin,
		int64	vmax,
		const string &	name
	)

Same but allocates an array and returns it.

Definition at line 4410 of file expressions.cc.

void operations_research::Solver::MakeBoolVarArray	(	int	var_count,
		const string &	name,
		std::vector< IntVar * > *	vars
	)

This method will append the vector vars with 'var_count' boolean variables having name "name<i>" where is the index of the variable.

Definition at line 4421 of file expressions.cc.

void operations_research::Solver::MakeBoolVarArray	(	int	var_count,
		std::vector< IntVar * > *	vars
	)

This method will append the vector vars with 'var_count' boolean variables having no names.

Definition at line 4429 of file expressions.cc.

IntVar ** operations_research::Solver::MakeBoolVarArray	(	int	var_count,
		const string &	name
	)

Same but allocates an array and returns it.

Definition at line 4435 of file expressions.cc.

IntExpr * operations_research::Solver::MakeSum	(	IntExpr *const	left,
		IntExpr *const	right
	)

Integer Expressions.

left + right.

Definition at line 4450 of file expressions.cc.

IntExpr * operations_research::Solver::MakeSum	(	IntExpr *const	expr,
		int64	value
	)

expr + value.

Definition at line 4465 of file expressions.cc.

IntExpr * operations_research::Solver::MakeSum	(	IntVar const	vars,
		int	size
	)

sum of all vars.

Definition at line 1390 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeSum ( const std::vector< IntVar * > & vars )

sum of all vars.

namespace

Definition at line 1386 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeScalProd	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	coefs
	)

scalar product

Definition at line 2818 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeScalProd	(	IntVar const	vars,
		const int64 *const	coefs,
		int	size
	)

scalar product

namespace

Definition at line 2901 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeScalProd	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	coefs
	)

scalar product

Definition at line 2824 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeScalProd	(	IntVar const	vars,
		const int *const	coefs,
		int	size
	)

scalar product

Definition at line 2907 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeDifference	(	IntExpr *const	left,
		IntExpr *const	right
	)

left - right

Definition at line 4475 of file expressions.cc.

IntExpr * operations_research::Solver::MakeDifference	(	int64	value,
		IntExpr *const	expr
	)

value - expr

warning: this is 'v - e'.

Definition at line 4704 of file expressions.cc.

IntExpr * operations_research::Solver::MakeOpposite ( IntExpr *const expr )

-expr

Definition at line 4715 of file expressions.cc.

IntExpr * operations_research::Solver::MakeProd	(	IntExpr *const	left,
		IntExpr *const	right
	)

left * right

Definition at line 4749 of file expressions.cc.

IntExpr * operations_research::Solver::MakeProd	(	IntExpr *const	expr,
		int64	value
	)

expr * value

Definition at line 4727 of file expressions.cc.

IntExpr * operations_research::Solver::MakeDiv	(	IntExpr *const	expr,
		int64	value
	)

expr / value (integer division)

Definition at line 4807 of file expressions.cc.

IntExpr * operations_research::Solver::MakeDiv	(	IntExpr *const	numerator,
		IntExpr *const	denominator
	)

numerator / denominator (integer division). Terms need to be positive.

Definition at line 4790 of file expressions.cc.

IntExpr * operations_research::Solver::MakeAbs ( IntExpr *const expr )

|expr|

Definition at line 4828 of file expressions.cc.

IntExpr * operations_research::Solver::MakeSquare ( IntExpr *const expr )

expr * expr

Definition at line 4838 of file expressions.cc.

IntExpr * operations_research::Solver::MakeElement	(	const int64 *const	vals,
		int	size,
		IntVar *const	index
	)

vals[expr]

Definition at line 540 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	const std::vector< int64 > &	vals,
		IntVar *const	index
	)

vals[expr]

Definition at line 536 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	const int *const	vals,
		int	size,
		IntVar *const	index
	)

vals[expr]

namespace

Definition at line 525 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	const std::vector< int > &	vals,
		IntVar *const	index
	)

vals[expr]

Definition at line 551 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	IndexEvaluator1 *	values,
		IntVar *const	index
	)

Function-based element.

namespace

The constraint takes ownership of callback The callback must be able to cope with any possible value in the domain of 'index' (potentially negative ones too).

Definition at line 731 of file element.cc.

IntExpr * operations_research::Solver::MakeMonotonicElement	(	IndexEvaluator1 *	values,
		bool	increasing,
		IntVar *const	index
	)

Function based element.

namespace

The constraint takes ownership of callback. The callback must be monotonic. It must be able to cope with any possible value in the domain of 'index' (potentially negative ones too). Furtermore, monotonicity is not checked. Thus giving a non monotonic function, or specifying an incorrect increasing parameter will result in undefined behavior.

Definition at line 757 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	IndexEvaluator2 *	values,
		IntVar *const	index1,
		IntVar *const	index2
	)

2D version of function-based element expression, values(expr1, expr2).

namespace

Definition at line 1005 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	const IntVar const	vars,
		int	size,
		IntVar *const	index
	)

vars[expr]

namespace

Definition at line 1371 of file element.cc.

IntExpr * operations_research::Solver::MakeElement	(	const std::vector< IntVar * > &	vars,
		IntVar *const	index
	)

vars[expr]

Definition at line 1379 of file element.cc.

IntExpr * operations_research::Solver::MakeMin ( const std::vector< IntVar * > & vars )

min(vars)

Definition at line 1410 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeMin	(	IntVar const	vars,
		int	size
	)

min(vars)

Definition at line 1414 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeMin	(	IntExpr *const	left,
		IntExpr *const	right
	)

min (left, right)

Definition at line 4850 of file expressions.cc.

IntExpr * operations_research::Solver::MakeMin	(	IntExpr *const	expr,
		int64	val
	)

min(expr, val)

Definition at line 4868 of file expressions.cc.

IntExpr * operations_research::Solver::MakeMin	(	IntExpr *const	expr,
		int	val
	)

min(expr, val)

Definition at line 4882 of file expressions.cc.

IntExpr * operations_research::Solver::MakeMax ( const std::vector< IntVar * > & vars )

max(vars)

Definition at line 1418 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeMax	(	IntVar const	vars,
		int	size
	)

max(vars)

Definition at line 1422 of file expr_array.cc.

IntExpr * operations_research::Solver::MakeMax	(	IntExpr *const	left,
		IntExpr *const	right
	)

max(left, right)

Definition at line 4886 of file expressions.cc.

IntExpr * operations_research::Solver::MakeMax	(	IntExpr *const	expr,
		int64	val
	)

max(expr, val)

Definition at line 4904 of file expressions.cc.

IntExpr * operations_research::Solver::MakeMax	(	IntExpr *const	expr,
		int	val
	)

max(expr, val)

Definition at line 4918 of file expressions.cc.

IntExpr * operations_research::Solver::MakeConvexPiecewiseExpr	(	IntVar *	e,
		int64	early_cost,
		int64	early_date,
		int64	late_date,
		int64	late_cost
	)

convex piecewise function.

Definition at line 4922 of file expressions.cc.

IntExpr * operations_research::Solver::MakeSemiContinuousExpr	(	IntExpr *const	e,
		int64	fixed_charge,
		int64	step
	)

Semi continuous Expression (x <= 0 -> f(x) = 0; x > 0 -> f(x) = ax + b) a >= 0 and b >= 0.

Definition at line 4931 of file expressions.cc.

Constraint * operations_research::Solver::MakeTrueConstraint ( )

Constraints This constraint always succeeds.

namespace

Definition at line 105 of file constraints.cc.

Constraint * operations_research::Solver::MakeFalseConstraint ( )

This constraint always fails.

namespace

Definition at line 134 of file constraints.cc.

Constraint * operations_research::Solver::MakeFalseConstraint ( const string & explanation )

Definition at line 138 of file constraints.cc.

Constraint * operations_research::Solver::MakeIsEqualCstCt	(	IntVar *const	v,
		int64	c,
		IntVar *const	b
	)

b == (v == c)

Definition at line 391 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsEqualCstVar	(	IntVar *const	var,
		int64	value
	)

status var of (v == c)

namespace

Definition at line 352 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsEqualCt	(	IntExpr *const	v1,
		IntExpr *	v2,
		IntVar *const	b
	)

b == (v1 == v2)

Definition at line 4522 of file expressions.cc.

IntVar * operations_research::Solver::MakeIsEqualVar	(	IntExpr *const	var,
		IntExpr *	v2
	)

status var of (v1 == v2)

Definition at line 4487 of file expressions.cc.

Constraint * operations_research::Solver::MakeEquality	(	IntVar *const	left,
		IntVar *const	right
	)

left == right

namespace

Definition at line 70 of file range_cst.cc.

Constraint * operations_research::Solver::MakeEquality	(	IntExpr *const	expr,
		int64	value
	)

expr == value

namespace

Definition at line 82 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeEquality	(	IntExpr *const	expr,
		int	value
	)

expr == value

Definition at line 87 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsDifferentCstCt	(	IntVar *const	v,
		int64	c,
		IntVar *const	b
	)

b == (v != c)

Definition at line 507 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsDifferentCstVar	(	IntVar *const	v,
		int64	c
	)

status var of (v != c)

namespace

Definition at line 468 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsDifferentVar	(	IntExpr *const	v1,
		IntExpr *const	v2
	)

status var of (v1 != v2)

Definition at line 4535 of file expressions.cc.

Constraint * operations_research::Solver::MakeIsDifferentCt	(	IntExpr *const	v1,
		IntExpr *const	v2,
		IntVar *const	b
	)

b == (v1 != v2)

Definition at line 4571 of file expressions.cc.

Constraint * operations_research::Solver::MakeNonEquality	(	IntVar *const	left,
		IntVar *const	right
	)

left != right

namespace

Definition at line 350 of file range_cst.cc.

Constraint * operations_research::Solver::MakeNonEquality	(	IntVar *const	expr,
		int64	value
	)

expr != value

namespace

Definition at line 290 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeNonEquality	(	IntVar *const	expr,
		int	value
	)

expr != value

Definition at line 295 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsLessOrEqualCstCt	(	IntVar *const	v,
		int64	c,
		IntVar *const	b
	)

b == (v <= c)

Definition at line 729 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsLessOrEqualCstVar	(	IntVar *const	v,
		int64	c
	)

status var of (v <= c)

namespace

Definition at line 692 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsLessOrEqualVar	(	IntExpr *const	left,
		IntExpr *const	right
	)

status var of (left <= right)

Definition at line 4584 of file expressions.cc.

Constraint * operations_research::Solver::MakeIsLessOrEqualCt	(	IntExpr *const	left,
		IntExpr *const	right,
		IntVar *const	b
	)

b == (left <= right)

Definition at line 4621 of file expressions.cc.

Constraint * operations_research::Solver::MakeLessOrEqual	(	IntVar *const	left,
		IntVar *const	right
	)

left <= right

namespace

Definition at line 125 of file range_cst.cc.

Constraint * operations_research::Solver::MakeLessOrEqual	(	IntExpr *const	expr,
		int64	value
	)

expr <= value

namespace

Definition at line 206 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeLessOrEqual	(	IntExpr *const	expr,
		int	value
	)

expr <= value

Definition at line 211 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsGreaterOrEqualCstCt	(	IntVar *const	v,
		int64	c,
		IntVar *const	b
	)

b == (v >= c)

Definition at line 617 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsGreaterOrEqualCstVar	(	IntVar *const	v,
		int64	c
	)

status var of (v >= c)

namespace

Definition at line 580 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsGreaterOrEqualVar	(	IntExpr *const	left,
		IntExpr *const	right
	)

status var of (left >= right)

Definition at line 4682 of file expressions.cc.

Constraint * operations_research::Solver::MakeIsGreaterOrEqualCt	(	IntExpr *const	left,
		IntExpr *const	right,
		IntVar *const	b
	)

b == (left >= right)

Definition at line 4687 of file expressions.cc.

Constraint * operations_research::Solver::MakeGreaterOrEqual	(	IntVar *const	left,
		IntVar *const	right
	)

left >= right

namespace

Definition at line 180 of file range_cst.cc.

Constraint * operations_research::Solver::MakeGreaterOrEqual	(	IntExpr *const	expr,
		int64	value
	)

expr >= value

namespace

Definition at line 140 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeGreaterOrEqual	(	IntExpr *const	expr,
		int	value
	)

expr >= value

Definition at line 145 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsGreaterCstCt	(	IntVar *const	v,
		int64	c,
		IntVar *const	b
	)

b == (v > c)

Definition at line 630 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsGreaterCstVar	(	IntVar *const	v,
		int64	c
	)

status var of (v > c)

Definition at line 613 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsGreaterVar	(	IntExpr *const	left,
		IntExpr *const	right
	)

status var of (left > right)

Definition at line 4693 of file expressions.cc.

Constraint * operations_research::Solver::MakeIsGreaterCt	(	IntExpr *const	left,
		IntExpr *const	right,
		IntVar *const	b
	)

b == (left > right)

Definition at line 4698 of file expressions.cc.

Constraint * operations_research::Solver::MakeGreater	(	IntVar *const	left,
		IntVar *const	right
	)

left > right

namespace

Definition at line 288 of file range_cst.cc.

Constraint * operations_research::Solver::MakeGreater	(	IntExpr *const	expr,
		int64	value
	)

expr > value

Definition at line 150 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeGreater	(	IntExpr *const	expr,
		int	value
	)

expr > value

Definition at line 155 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsLessCstCt	(	IntVar *const	v,
		int64	c,
		IntVar *const	b
	)

b == (v < c)

Definition at line 742 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsLessCstVar	(	IntVar *const	v,
		int64	c
	)

status var of (v < c)

Definition at line 725 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsLessVar	(	IntExpr *const	left,
		IntExpr *const	right
	)

status var of (left < right)

Definition at line 4633 of file expressions.cc.

Constraint * operations_research::Solver::MakeIsLessCt	(	IntExpr *const	left,
		IntExpr *const	right,
		IntVar *const	b
	)

b == (left < right)

Definition at line 4670 of file expressions.cc.

Constraint * operations_research::Solver::MakeLess	(	IntVar *const	left,
		IntVar *const	right
	)

left < right

namespace

Definition at line 234 of file range_cst.cc.

Constraint * operations_research::Solver::MakeLess	(	IntExpr *const	expr,
		int64	value
	)

expr < value

Definition at line 216 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeLess	(	IntExpr *const	expr,
		int	value
	)

expr < value

Definition at line 221 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeSumLessOrEqual	(	const std::vector< IntVar * > &	vars,
		int64	cst
	)

Variation on arrays.

namespace

Definition at line 2567 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumLessOrEqual	(	IntVar const	vars,
		int	size,
		int64	cst
	)

Definition at line 2571 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumGreaterOrEqual	(	const std::vector< IntVar * > &	vars,
		int64	cst
	)

Definition at line 2581 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumGreaterOrEqual	(	IntVar const	vars,
		int	size,
		int64	cst
	)

Definition at line 2586 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumEquality	(	const std::vector< IntVar * > &	vars,
		int64	cst
	)

Definition at line 2596 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumEquality	(	IntVar const	vars,
		int	size,
		int64	cst
	)

Definition at line 2600 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumEquality	(	const std::vector< IntVar * > &	vars,
		IntVar *const	var
	)

Definition at line 2619 of file expr_array.cc.

Constraint * operations_research::Solver::MakeSumEquality	(	IntVar const	vars,
		int	size,
		IntVar *const	var
	)

Definition at line 2624 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdEquality	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	coefficients,
		int64	cst
	)

Definition at line 2634 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdEquality	(	IntVar const	vars,
		int	size,
		int64 const *	coefficients,
		int64	cst
	)

namespace

Definition at line 2680 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdEquality	(	IntVar const	vars,
		int	size,
		int const *	coefficients,
		int64	cst
	)

Definition at line 2687 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdEquality	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	coefficients,
		int64	cst
	)

Definition at line 2644 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdGreaterOrEqual	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	coefficients,
		int64	cst
	)

Definition at line 2694 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdGreaterOrEqual	(	IntVar const	vars,
		int	size,
		int64 const *	coefficients,
		int64	cst
	)

namespace

Definition at line 2733 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdGreaterOrEqual	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	coefficients,
		int64	cst
	)

Definition at line 2704 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdGreaterOrEqual	(	IntVar const	vars,
		int	size,
		int const *	coefficients,
		int64	cst
	)

Definition at line 2741 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdLessOrEqual	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	coefficients,
		int64	cst
	)

Definition at line 2749 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdLessOrEqual	(	IntVar const	vars,
		int	size,
		int64 const *	coefficients,
		int64	cst
	)

namespace

Definition at line 2804 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdLessOrEqual	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	coefficients,
		int64	cst
	)

Definition at line 2759 of file expr_array.cc.

Constraint * operations_research::Solver::MakeScalProdLessOrEqual	(	IntVar const	vars,
		int	size,
		int const *	coefficients,
		int64	cst
	)

Definition at line 2811 of file expr_array.cc.

Demon * operations_research::Solver::MakeConstraintInitialPropagateCallback ( Constraint *const ct )

This method is a specialized case of the MakeConstraintDemon method to call the InitiatePropagate of the constraint 'ct'.

Definition at line 28 of file constraints.cc.

Demon * operations_research::Solver::MakeDelayedConstraintInitialPropagateCallback ( Constraint *const ct )

This method is a specialized case of the MakeConstraintDemon method to call the InitiatePropagate of the constraint 'ct' with low priority.

Definition at line 35 of file constraints.cc.

Demon * operations_research::Solver::MakeCallbackDemon ( Callback1< Solver * > *const callback )

Creates a demon from a callback.

namespace

Definition at line 78 of file constraints.cc.

Demon * operations_research::Solver::MakeCallbackDemon ( Closure *const closure )

Creates a demon from a closure.

Definition at line 82 of file constraints.cc.

Constraint * operations_research::Solver::MakeBetweenCt	(	IntVar *const	v,
		int64	l,
		int64	u
	)

(l <= b <= u)

namespace

Definition at line 782 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsBetweenCt	(	IntVar *const	v,
		int64	l,
		int64	u,
		IntVar *const	b
	)

b == (l <= v <= u)

namespace

Definition at line 847 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsMemberCt	(	IntVar *const	v,
		const int64 *const	values,
		int	size,
		IntVar *const	b
	)

b == (v in set)

namespace

Definition at line 1014 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsMemberCt	(	IntVar *const	v,
		const std::vector< int64 > &	values,
		IntVar *const	b
	)

Definition at line 1026 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsMemberCt	(	IntVar *const	v,
		const int *const	values,
		int	size,
		IntVar *const	b
	)

Definition at line 1032 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeIsMemberCt	(	IntVar *const	v,
		const std::vector< int > &	values,
		IntVar *const	b
	)

Definition at line 1044 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsMemberVar	(	IntVar *const	v,
		const int64 *const	values,
		int	size
	)

Definition at line 1050 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsMemberVar	(	IntVar *const	v,
		const std::vector< int64 > &	values
	)

Definition at line 1058 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsMemberVar	(	IntVar *const	v,
		const int *const	values,
		int	size
	)

Definition at line 1063 of file expr_cst.cc.

IntVar * operations_research::Solver::MakeIsMemberVar	(	IntVar *const	v,
		const std::vector< int > &	values
	)

Definition at line 1071 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeMemberCt	(	IntVar *const	v,
		const int64 *const	values,
		int	size
	)

v in set.

namespace

Propagation is lazy, i.e. this constraint does not creates holes in the domain of the variable.

Definition at line 899 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeMemberCt	(	IntVar *const	v,
		const std::vector< int64 > &	values
	)

Definition at line 907 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeMemberCt	(	IntVar *const	v,
		const int *const	values,
		int	size
	)

Definition at line 912 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeMemberCt	(	IntVar *const	v,
		const std::vector< int > &	values
	)

Definition at line 920 of file expr_cst.cc.

Constraint * operations_research::Solver::MakeCount	(	const std::vector< IntVar * > &	v,
		int64	value,
		int64	count
	)

|{i | v[i] == value}| == count

namespace

Definition at line 195 of file count_cst.cc.

Constraint * operations_research::Solver::MakeCount	(	const std::vector< IntVar * > &	v,
		int64	value,
		IntVar *const	count
	)

|{i | v[i] == value}| == count

namespace

Definition at line 387 of file count_cst.cc.

Constraint * operations_research::Solver::MakeDistribute	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	values,
		const std::vector< IntVar * > &	cards
	)

Aggregated version of count: |{i | v[i] == values[j]}| == cards[j].

namespace

Factory

Definition at line 1107 of file count_cst.cc.

Constraint * operations_research::Solver::MakeDistribute	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	values,
		const std::vector< IntVar * > &	cards
	)

Aggregated version of count: |{i | v[i] == values[j]}| == cards[j].

Definition at line 1138 of file count_cst.cc.

Constraint * operations_research::Solver::MakeDistribute	(	const std::vector< IntVar * > &	vars,
		const std::vector< IntVar * > &	cards
	)

Aggregated version of count: |{i | v[i] == j}| == cards[j].

Definition at line 1169 of file count_cst.cc.

Constraint * operations_research::Solver::MakeDistribute	(	const std::vector< IntVar * > &	vars,
		int64	card_min,
		int64	card_max,
		int64	card_size
	)

Aggregated version of count with bounded cardinalities: forall j in 0 .

. card_size - 1: card_min <= |{i | v[i] == j}| <= card_max

Definition at line 1184 of file count_cst.cc.

Constraint * operations_research::Solver::MakeDeviation	(	const std::vector< IntVar * > &	vars,
		IntVar *const	deviation_var,
		int64	total_sum
	)

Deviation constraint: sum_i |n * vars[i] - total_sum| <= deviation_var and sum_i vars[i] == total_sum n = vars.

namespace

Definition at line 427 of file deviation.cc.

Constraint * operations_research::Solver::MakeAllDifferent ( const std::vector< IntVar * > & vars )

All variables are pairwise different.

namespace

This corresponds to the stronger version of the propagation algorithm.

Definition at line 426 of file alldiff_cst.cc.

Constraint * operations_research::Solver::MakeAllDifferent	(	const std::vector< IntVar * > &	vars,
		bool	stronger_propagation
	)

All variables are pairwise different.

If 'stronger_propagation' is true, stronger, and potentially slower propagation will occur. This API will be deprecated in the future.

Definition at line 430 of file alldiff_cst.cc.

Constraint * operations_research::Solver::MakeAllDifferent	(	const IntVar const	vars,
		int	size,
		bool	stronger_propagation
	)

All variables are pairwise different.

If 'stronger_propagation' is true, stronger, and potentially slower propagation will occur. This API will be deprecated in the future.

Definition at line 435 of file alldiff_cst.cc.

Constraint * operations_research::Solver::MakeNoCycle	(	const std::vector< IntVar * > &	nexts,
		const std::vector< IntVar * > &	active,
		ResultCallback1< bool, int64 > *	sink_handler = `NULL`
	)

Prevent cycles, nexts variables representing the next in the chain.

Active variables indicate if the corresponding next variable is active; this could be useful to model unperformed nodes in a routing problem. A callback can be added to specify sink values (by default sink values are values >= vars.size()). Ownership of the callback is passed to the constraint. If assume_paths is either not specified or true, the constraint assumes the 'next' variables represent paths (and performs a faster propagation); otherwise the constraint assumes the 'next' variables represent a forest.

Definition at line 574 of file constraints.cc.

Constraint * operations_research::Solver::MakeNoCycle	(	const IntVar const	nexts,
		const IntVar const	active,
		int	size,
		ResultCallback1< bool, int64 > *	sink_handler = `NULL`
	)

Definition at line 580 of file constraints.cc.

Constraint * operations_research::Solver::MakeNoCycle	(	const std::vector< IntVar * > &	nexts,
		const std::vector< IntVar * > &	active,
		ResultCallback1< bool, int64 > *	sink_handler,
		bool	assume_paths
	)

namespace

Definition at line 544 of file constraints.cc.

Constraint * operations_research::Solver::MakeNoCycle	(	const IntVar const	nexts,
		const IntVar const	active,
		int	size,
		ResultCallback1< bool, int64 > *	sink_handler,
		bool	assume_paths
	)

Definition at line 556 of file constraints.cc.

Constraint * operations_research::Solver::MakePathCumul	(	const std::vector< IntVar * > &	nexts,
		const std::vector< IntVar * > &	active,
		const std::vector< IntVar * > &	cumuls,
		const std::vector< IntVar * > &	transits
	)

Accumulate values along a path such that: cumuls[next[i]] = cumuls[i] + transits[i].

namespace

Active variables indicate if the corresponding next variable is active; this could be useful to model unperformed nodes in a routing problem.

Definition at line 814 of file constraints.cc.

Constraint * operations_research::Solver::MakePathCumul	(	const IntVar const	nexts,
		const IntVar const	active,
		const IntVar const	cumuls,
		const IntVar const	transits,
		int	next_size,
		int	cumul_size
	)

Definition at line 827 of file constraints.cc.

Constraint * operations_research::Solver::MakeMapDomain	(	IntVar *const	var,
		IntVar const	vars,
		int	size
	)

This constraint maps the domain of 'var' onto the array of variables 'vars'.

namespace

That is for all i in [0 .. size - 1]: vars[i] == 1 <=> var->Contains(i);

Definition at line 273 of file constraints.cc.

Constraint * operations_research::Solver::MakeMapDomain	(	IntVar *const	var,
		const std::vector< IntVar * > &	vars
	)

This constraint maps the domain of 'var' onto the array of variables 'vars'.

That is for all i in [0 .. size - 1]: vars[i] == 1 <=> var->Contains(i);

Definition at line 278 of file constraints.cc.

Constraint * operations_research::Solver::MakeAllowedAssignments	(	const std::vector< IntVar * > &	vars,
		const IntTupleSet &	tuples
	)

This method creates a constraint where the graph of the relation between the variables is given in extension.

namespace

There are 'arity' variables involved in the relation and the graph is given by a integer tuple set.

Definition at line 824 of file table.cc.

Constraint * operations_research::Solver::MakeTransitionConstraint	(	const std::vector< IntVar * > &	vars,
		const IntTupleSet &	transitions,
		int64	initial_state,
		const std::vector< int64 > &	final_states
	)

This constraint create a finite automaton that will check the sequence of variables vars.

namespace

It uses a transition table called 'transitions'. Each transition is a triple (current_state, variable_value, new_state). The initial state is given, and the set of accepted states is decribed by 'final_states'. These states are hidden inside the constraint. Only the transitions (i.e. the variables) are visible.

Definition at line 948 of file table.cc.

Constraint * operations_research::Solver::MakeTransitionConstraint	(	const std::vector< IntVar * > &	vars,
		const IntTupleSet &	transitions,
		int64	initial_state,
		const std::vector< int > &	final_states
	)

This constraint create a finite automaton that will check the sequence of variables vars.

It uses a transition table called 'transitions'. Each transition is a triple (current_state, variable_value, new_state). The initial state is given, and the set of accepted states is decribed by 'final_states'. These states are hidden inside the constraint. Only the transitions (i.e. the variables) are visible.

Definition at line 960 of file table.cc.

Pack * operations_research::Solver::MakePack	(	const std::vector< IntVar * > &	vars,
		int	number_of_bins
	)

Packing constraint.

This constraint packs all variables onto 'number_of_bins' variables. For any given variable, a value of 'number_of_bins' indicates that the variable is not assigned to any bin. Dimensions, i.e. cumulative constraints on this packing can be added directly from the pack class.

Definition at line 1345 of file pack.cc.

IntervalVar * operations_research::Solver::MakeFixedDurationIntervalVar	(	int64	start_min,
		int64	start_max,
		int64	duration,
		bool	optional,
		const string &	name
	)

scheduling objects

Creates an interval var with a fixed duration. The duration must be greater than 0. If optional is true, then the interval can be performed or unperformed. If optional is false, then the interval is always performed.

Definition at line 1468 of file interval.cc.

void operations_research::Solver::MakeFixedDurationIntervalVarArray	(	int	count,
		int64	start_min,
		int64	start_max,
		int64	duration,
		bool	optional,
		const string &	name,
		std::vector< IntervalVar * > *	array
	)

This method fills the vector with 'count' interval var built with the corresponding parameters.

Definition at line 1488 of file interval.cc.

IntervalVar * operations_research::Solver::MakeFixedInterval	(	int64	start,
		int64	duration,
		const string &	name
	)

Creates an fixed and performed interval.

Definition at line 1462 of file interval.cc.

IntervalVar * operations_research::Solver::MakeMirrorInterval ( IntervalVar *const interval_var )

Creates an interval var that is the mirror image of the given one, that is, the interval var obtained by reversing the axis.

namespace

Definition at line 93 of file interval.cc.

IntervalVar * operations_research::Solver::MakeIntervalRelaxedMin ( IntervalVar *const interval_var )

Creates and returns an interval variable that wraps around the given one, relaxing the min start and end.

Relaxing means making unbounded when optional. If the variable is non optional, this methods returns interval_var.

More precisely, such an interval variable behaves as follows: When the underlying must be performed, the returned interval variable behaves exactly as the underlying; When the underlying may or may not be performed, the returned interval variable behaves like the underlying, except that it is unbounded on the min side; When the underlying cannot be performed, the returned interval variable is of duration 0 and must be performed in an interval unbounded on both sides.

This is very useful to implement propagators that may only modify the start max or end max.

Definition at line 280 of file interval.cc.

IntervalVar * operations_research::Solver::MakeIntervalRelaxedMax ( IntervalVar *const interval_var )

Creates and returns an interval variable that wraps around the given one, relaxing the max start and end.

namespace

Relaxing means making unbounded when optional. If the variable is non optional, this methods returns interval_var.

More precisely, such an interval variable behaves as follows: When the underlying must be performed, the returned interval variable behaves exactly as the underlying; When the underlying may or may not be performed, the returned interval variable behaves like the underlying, except that it is unbounded on the max side; When the underlying cannot be performed, the returned interval variable is of duration 0 and must be performed in an interval unbounded on both sides.

This is very useful to implement propagators that may only modify the start min or end min.

Definition at line 271 of file interval.cc.

Constraint * operations_research::Solver::MakeIntervalVarRelation	(	IntervalVar *const	t,
		Solver::UnaryIntervalRelation	r,
		int64	d
	)

scheduling constraints

namespace

This method creates a relation between an interval var and a date.

Definition at line 128 of file timetabling.cc.

Constraint * operations_research::Solver::MakeIntervalVarRelation	(	IntervalVar *const	t1,
		Solver::BinaryIntervalRelation	r,
		IntervalVar *const	t2
	)

This method creates a relation between two an interval vars.

namespace

Definition at line 260 of file timetabling.cc.

Constraint * operations_research::Solver::MakeTemporalDisjunction	(	IntervalVar *const	t1,
		IntervalVar *const	t2,
		IntVar *const	alt
	)

This constraint implements a temporal disjunction between two interval vars t1 and t2.

namespace

'alt' indicates which alternative was chosen (alt == 0 is equivalent to t1 before t2).

Definition at line 433 of file timetabling.cc.

Constraint * operations_research::Solver::MakeTemporalDisjunction	(	IntervalVar *const	t1,
		IntervalVar *const	t2
	)

This constraint implements a temporal disjunction between two interval vars.

Definition at line 439 of file timetabling.cc.

Constraint * operations_research::Solver::MakeDisjunctiveConstraint ( const std::vector< IntervalVar * > & intervals )

This constraint forces all interval vars into an non overlapping sequence.

namespace

Sequence Constraint

Definition at line 1727 of file resource.cc.

SequenceVar * operations_research::Solver::MakeSequenceVar	(	const std::vector< IntervalVar * > &	intervals,
		const string &	name
	)

The sequence variable is used to rank disjoint intervals.

Factory methods.

It will post a SequenceConstraint upon creation.

Definition at line 2153 of file resource.cc.

Constraint * operations_research::Solver::MakeCumulative	(	const std::vector< IntervalVar * > &	intervals,
		const std::vector< int64 > &	demands,
		int64	capacity,
		const string &	name
	)

This constraint forces that, for any integer t, the sum of the demands corresponding to an interval containing t does not exceed the given capacity.

Intervals and demands should be vectors of equal size.

Demands should only contain non-negative values. Zero values are supported, and the corresponding intervals are filtered out, as they neither impact nor are impacted by this constraint.

Definition at line 2161 of file resource.cc.

Constraint * operations_research::Solver::MakeCumulative	(	const std::vector< IntervalVar * > &	intervals,
		const std::vector< int > &	demands,
		int64	capacity,
		const string &	name
	)

This constraint forces that, for any integer t, the sum of the demands corresponding to an interval containing t does not exceed the given capacity.

Intervals and demands should be vectors of equal size.

Demands should only contain non-negative values. Zero values are supported, and the corresponding intervals are filtered out, as they neither impact nor are impacted by this constraint.

Definition at line 2177 of file resource.cc.

Assignment * operations_research::Solver::MakeAssignment ( )

Assignments.

This method creates an empty assignment.

Definition at line 1097 of file assignment.cc.

Assignment * operations_research::Solver::MakeAssignment ( const Assignment *const a )

This method creates an assignnment which is a copy of 'a'.

Definition at line 1101 of file assignment.cc.

SolutionCollector * operations_research::Solver::MakeFirstSolutionCollector ( const Assignment *const assignment )

Solution Collectors.

namespace

Collect the first solution of the search.

Definition at line 2241 of file search.cc.

SolutionCollector * operations_research::Solver::MakeFirstSolutionCollector ( )

Collect the first solution of the search.

The variables will need to be added later.

Definition at line 2246 of file search.cc.

SolutionCollector * operations_research::Solver::MakeLastSolutionCollector ( const Assignment *const assignment )

Collect the last solution of the search.

namespace

Definition at line 2288 of file search.cc.

SolutionCollector * operations_research::Solver::MakeLastSolutionCollector ( )

Collect the last solution of the search.

The variables will need to be added later.

Definition at line 2293 of file search.cc.

SolutionCollector * operations_research::Solver::MakeBestValueSolutionCollector	(	const Assignment *const	assignment,
		bool	maximize
	)

Collect the solution corresponding to the optimal value of the objective of 'a'; if 'a' does not have an objective no solution is collected.

namespace

This collector only collects one solution corresponding to the best objective value (the first one found).

Definition at line 2361 of file search.cc.

SolutionCollector * operations_research::Solver::MakeBestValueSolutionCollector ( bool maximize )

Collect the solution corresponding to the optimal value of the objective of 'a'; if 'a' does not have an objective no solution is collected.

This collector only collects one solution corresponding to the best objective value (the first one found). The variables will need to be added later.

Definition at line 2366 of file search.cc.

SolutionCollector * operations_research::Solver::MakeAllSolutionCollector ( const Assignment *const assignment )

Collect all solutions of the search.

namespace

Definition at line 2406 of file search.cc.

SolutionCollector * operations_research::Solver::MakeAllSolutionCollector ( )

Collect all solutions of the search.

The variables will need to be added later.

Definition at line 2410 of file search.cc.

OptimizeVar * operations_research::Solver::MakeMinimize	(	IntVar *const	v,
		int64	step
	)

Objective.

Creates a minimization objective.

Definition at line 2505 of file search.cc.

OptimizeVar * operations_research::Solver::MakeMaximize	(	IntVar *const	v,
		int64	step
	)

Creates a maximization objective.

Definition at line 2509 of file search.cc.

OptimizeVar * operations_research::Solver::MakeOptimize	(	bool	maximize,
		IntVar *const	v,
		int64	step
	)

Creates a objective with a given sense (true = maximization).

Definition at line 2513 of file search.cc.

OptimizeVar * operations_research::Solver::MakeWeightedMinimize	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	weights,
		int64	step
	)

Creates a minimization weighted objective.

The actual objective is scalar_prod(vars, weights).

Definition at line 2593 of file search.cc.

OptimizeVar * operations_research::Solver::MakeWeightedMinimize	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	weights,
		int64	step
	)

Creates a minimization weighted objective.

The actual objective is scalar_prod(vars, weights).

Definition at line 2621 of file search.cc.

OptimizeVar * operations_research::Solver::MakeWeightedMaximize	(	const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	weights,
		int64	step
	)

Creates a maximization weigthed objective.

Definition at line 2602 of file search.cc.

OptimizeVar * operations_research::Solver::MakeWeightedMaximize	(	const std::vector< IntVar * > &	vars,
		const std::vector< int > &	weights,
		int64	step
	)

Creates a maximization weigthed objective.

Definition at line 2630 of file search.cc.

OptimizeVar * operations_research::Solver::MakeWeightedOptimize	(	bool	maximize,
		const std::vector< IntVar * > &	vars,
		const std::vector< int64 > &	weights,
		int64	step
	)

Creates a weighted objective with a given sense (true = maximization).

namespace

Definition at line 2583 of file search.cc.

OptimizeVar * operations_research::Solver::MakeWeightedOptimize	(	bool	maximize,
		const std::vector< IntVar * > &	vars,
		const std::vector< int > &	weights,
		int64	step
	)

Creates a weighted objective with a given sense (true = maximization).

Definition at line 2611 of file search.cc.

SearchMonitor * operations_research::Solver::MakeTabuSearch	(	bool	maximize,
		IntVar *const	v,
		int64	step,
		const std::vector< IntVar * > &	vars,
		int64	keep_tenure,
		int64	forbid_tenure,
		double	tabu_factor
	)

Meta-heuristics Search monitors which try to get the search out of local optima.

namespace

Creates a Tabu Search monitor. In the context of local search the behavior is similar to MakeOptimize(), creating an objective in a given sense. The behavior differs once a local optimum is reached: thereafter solutions which degrade the value of the objective are allowed if they are not "tabu". A solution is "tabu" if it doesn't respect the following rules:

improving the best solution found so far
variables in the "keep" list must keep their value, variables in the "forbid" list must not take the value they have in the list. Variables with new values enter the tabu lists after each new solution found and leave the lists after a given number of iterations (called tenure). Only the variables passed to the method can enter the lists. The tabu criterion is softened by the tabu factor which gives the number of "tabu" violations which is tolerated; a factor of 1 means no violations allowed, a factor of 0 means all violations allowed.

Definition at line 2904 of file search.cc.

SearchMonitor * operations_research::Solver::MakeTabuSearch	(	bool	maximize,
		IntVar *const	v,
		int64	step,
		const IntVar const	vars,
		int	size,
		int64	keep_tenure,
		int64	forbid_tenure,
		double	tabu_factor
	)

Definition at line 2922 of file search.cc.

SearchMonitor * operations_research::Solver::MakeSimulatedAnnealing	(	bool	maximize,
		IntVar *const	v,
		int64	step,
		int64	initial_temperature
	)

Creates a Simulated Annealing monitor.

namespace

Todo:: TODO(user): document behavior

Definition at line 3023 of file search.cc.

SearchMonitor * operations_research::Solver::MakeGuidedLocalSearch	(	bool	maximize,
		IntVar *const	objective,
		IndexEvaluator2 *	objective_function,
		int64	step,
		const std::vector< IntVar * > &	vars,
		double	penalty_factor
	)

Creates a Guided Local Search monitor.

namespace

Description here: http://en.wikipedia.org/wiki/Guided_Local_Search

Definition at line 3626 of file search.cc.

SearchMonitor * operations_research::Solver::MakeGuidedLocalSearch	(	bool	maximize,
		IntVar *const	objective,
		IndexEvaluator2 *	objective_function,
		int64	step,
		const IntVar const	vars,
		int	size,
		double	penalty_factor
	)

Definition at line 3642 of file search.cc.

SearchMonitor * operations_research::Solver::MakeGuidedLocalSearch	(	bool	maximize,
		IntVar *const	objective,
		IndexEvaluator3 *	objective_function,
		int64	step,
		const std::vector< IntVar * > &	vars,
		const std::vector< IntVar * > &	secondary_vars,
		double	penalty_factor
	)

Definition at line 3660 of file search.cc.

SearchMonitor * operations_research::Solver::MakeGuidedLocalSearch	(	bool	maximize,
		IntVar *const	objective,
		IndexEvaluator3 *	objective_function,
		int64	step,
		const IntVar const	vars,
		const IntVar const	secondary_vars,
		int	size,
		double	penalty_factor
	)

Definition at line 3678 of file search.cc.

SearchMonitor * operations_research::Solver::MakeLubyRestart ( int scale_factor )

Restart Search.

namespace

This search monitor will restart the search periodically. At the iteration n, it will restart after scale_factor * Luby(n) failures where Luby is the Luby Strategy (i.e. 1 1 2 1 1 2 4 1 1 2 1 1 2 4 8...).

Definition at line 4409 of file search.cc.

SearchMonitor * operations_research::Solver::MakeConstantRestart ( int frequency )

This search monitor will restart the search periodically after 'frequency' failures.

namespace

Definition at line 4442 of file search.cc.

SearchLimit * operations_research::Solver::MakeTimeLimit ( int64 time_in_ms )

Search Limit.

namespace

Creates a search limit that constrains the running time given in milliseconds.

Definition at line 3931 of file search.cc.

SearchLimit * operations_research::Solver::MakeBranchesLimit ( int64 branches )

Creates a search limit that constrains the number of branches explored in the search tree.

Definition at line 3935 of file search.cc.

SearchLimit * operations_research::Solver::MakeFailuresLimit ( int64 failures )

Creates a search limit that constrains the number of failures that can happen when exploring the search tree.

Definition at line 3939 of file search.cc.

SearchLimit * operations_research::Solver::MakeSolutionsLimit ( int64 solutions )

Creates a search limit that constrains the number of solutions found during the search.

Definition at line 3943 of file search.cc.

SearchLimit * operations_research::Solver::MakeLimit	(	int64	time,
		int64	branches,
		int64	failures,
		int64	solutions
	)

Limits the search with the 'time', 'branches', 'failures' and 'solutions' limits.

Definition at line 3947 of file search.cc.

SearchLimit * operations_research::Solver::MakeLimit	(	int64	time,
		int64	branches,
		int64	failures,
		int64	solutions,
		bool	smart_time_check
	)

Version reducing calls to wall timer by estimating number of remaining calls.

Definition at line 3954 of file search.cc.

SearchLimit * operations_research::Solver::MakeLimit	(	int64	time,
		int64	branches,
		int64	failures,
		int64	solutions,
		bool	smart_time_check,
		bool	cumulative
	)

Creates a search limit which can either apply cumulatively or search-by-search.

Definition at line 3963 of file search.cc.

SearchLimit * operations_research::Solver::MakeLimit ( const SearchLimitProto & proto )

Creates a search limit from its protobuf description.

Definition at line 3978 of file search.cc.

SearchLimit * operations_research::Solver::MakeLimit	(	SearchLimit *const	limit_1,
		SearchLimit *const	limit_2
	)

Creates a search limit that is reached when either of the underlying limit is reached.

namespace

That is, the returned limit is more stringent than both argument limits.

Definition at line 4054 of file search.cc.

void operations_research::Solver::UpdateLimits	(	int64	time,
		int64	branches,
		int64	failures,
		int64	solutions,
		SearchLimit *	limit
	)

Definition at line 4059 of file search.cc.

int64 operations_research::Solver::GetTime ( SearchLimit * limit )

Returns 'time' limit of search limit.

Definition at line 4070 of file search.cc.

SearchLimit * operations_research::Solver::MakeCustomLimit ( ResultCallback< bool > * limiter )

Callback-based search limit.

namespace

Search stops when limiter returns true; if this happens at a leaf the corresponding solution will be rejected.

Definition at line 4120 of file search.cc.

NoGoodManager * operations_research::Solver::MakeNoGoodManager ( )

No Goods.

namespace

Creates a non-reversible nogood manager to store and use nogoods during search. Nogoods are defined by the NoGood class. It can be used during search with restart to avoid revisiting the same portion of the search tree.

API

Definition at line 208 of file nogoods.cc.

SearchMonitor * operations_research::Solver::MakeTreeMonitor	(	const IntVar const	vars,
		int	size,
		const string &	file_tree,
		const string &	file_visualization
	)

Tree Monitor Creates a tree monitor that outputs a detailed overview of the decision phase in cpviz format.

API.

The XML data is written to files file_tree and file_visualization as the search finishes.

Definition at line 795 of file tree_monitor.cc.

SearchMonitor * operations_research::Solver::MakeTreeMonitor	(	const std::vector< IntVar * > &	vars,
		const string &	file_tree,
		const string &	file_visualization
	)