Detailed Description

Wrapper class around the cp_model proto.

This class provides two types of methods:

NewXXX to create integer, boolean, or interval variables.
AddXXX to create new constraints and add them to the model.

Definition at line 735 of file cp_model.h.

#include <cp_model.h>

Public Member Functions
void	SetName (absl::string_view name)
	Sets the name of the model.
IntVar	NewIntVar (const Domain &domain)
	Creates an integer variable with the given domain.
BoolVar	NewBoolVar ()
	Creates a Boolean variable.
IntVar	NewConstant (int64_t value)
BoolVar	TrueVar ()
BoolVar	FalseVar ()
IntervalVar	NewIntervalVar (const LinearExpr &start, const LinearExpr &size, const LinearExpr &end)
	Creates an interval variable from 3 affine expressions.
IntervalVar	NewFixedSizeIntervalVar (const LinearExpr &start, int64_t size)
	Creates an interval variable with a fixed size.
IntervalVar	NewOptionalIntervalVar (const LinearExpr &start, const LinearExpr &size, const LinearExpr &end, BoolVar presence)
IntervalVar	NewOptionalFixedSizeIntervalVar (const LinearExpr &start, int64_t size, BoolVar presence)
	Creates an optional interval variable with a fixed size.
void	FixVariable (IntVar var, int64_t value)
void	FixVariable (BoolVar var, bool value)
Constraint	AddBoolOr (absl::Span< const BoolVar > literals)
	Adds the constraint that at least one of the literals must be true.
Constraint	AddAtLeastOne (absl::Span< const BoolVar > literals)
	Same as AddBoolOr(). Sum literals >= 1.
Constraint	AddAtMostOne (absl::Span< const BoolVar > literals)
	At most one literal is true. Sum literals <= 1.
Constraint	AddExactlyOne (absl::Span< const BoolVar > literals)
	Exactly one literal is true. Sum literals == 1.
Constraint	AddBoolAnd (absl::Span< const BoolVar > literals)
	Adds the constraint that all literals must be true.
Constraint	AddBoolXor (absl::Span< const BoolVar > literals)
	Adds the constraint that an odd number of literals is true.
Constraint	AddImplication (BoolVar a, BoolVar b)
	Adds a => b.
Constraint	AddImplication (absl::Span< const BoolVar > lhs, absl::Span< const BoolVar > rhs)
	Adds implication: if all lhs vars are true then all rhs vars must be true.
Constraint	AddEquality (const LinearExpr &left, const LinearExpr &right)
	Adds left == right.
Constraint	AddGreaterOrEqual (const LinearExpr &left, const LinearExpr &right)
	Adds left >= right.
Constraint	AddGreaterThan (const LinearExpr &left, const LinearExpr &right)
	Adds left > right.
Constraint	AddLessOrEqual (const LinearExpr &left, const LinearExpr &right)
	Adds left <= right.
Constraint	AddLessThan (const LinearExpr &left, const LinearExpr &right)
	Adds left < right.
Constraint	AddLinearConstraint (const LinearExpr &expr, const Domain &domain)
	Adds expr in domain.
Constraint	AddNotEqual (const LinearExpr &left, const LinearExpr &right)
	Adds left != right.
Constraint	AddAllDifferent (absl::Span< const IntVar > vars)
	This constraint forces all variables to have different values.
Constraint	AddAllDifferent (absl::Span< const LinearExpr > exprs)
	This constraint forces all expressions to have different values.
Constraint	AddAllDifferent (std::initializer_list< LinearExpr > exprs)
	This constraint forces all expressions to have different values.
Constraint	AddVariableElement (LinearExpr index, absl::Span< const IntVar > variables, LinearExpr target)
	Adds the element constraint: variables[index] == target.
Constraint	AddElement (LinearExpr index, absl::Span< const LinearExpr > expressions, LinearExpr target)
	Adds the element constraint: expressions[index] == target.
Constraint	AddElement (LinearExpr index, std::initializer_list< LinearExpr > expressions, LinearExpr target)
	Adds the element constraint: expressions[index] == target.
Constraint	AddElement (LinearExpr index, absl::Span< const int64_t > values, LinearExpr target)
	Adds the element constraint: values[index] == target.
CircuitConstraint	AddCircuitConstraint ()
MultipleCircuitConstraint	AddMultipleCircuitConstraint ()
TableConstraint	AddAllowedAssignments (absl::Span< const LinearExpr > expressions)
TableConstraint	AddAllowedAssignments (absl::Span< const IntVar > variables)
TableConstraint	AddAllowedAssignments (std::initializer_list< LinearExpr > expressions)
TableConstraint	AddForbiddenAssignments (absl::Span< const LinearExpr > expression)
TableConstraint	AddForbiddenAssignments (absl::Span< const IntVar > variables)
TableConstraint	AddForbiddenAssignments (std::initializer_list< LinearExpr > expressions)
Constraint	AddInverseConstraint (absl::Span< const IntVar > variables, absl::Span< const IntVar > inverse_variables)
ReservoirConstraint	AddReservoirConstraint (int64_t min_level, int64_t max_level)
AutomatonConstraint	AddAutomaton (absl::Span< const LinearExpr > transition_expressions, int starting_state, absl::Span< const int > final_states)
AutomatonConstraint	AddAutomaton (absl::Span< const IntVar > transition_variables, int starting_state, absl::Span< const int > final_states)
AutomatonConstraint	AddAutomaton (std::initializer_list< LinearExpr > transition_expressions, int starting_state, absl::Span< const int > final_states)
Constraint	AddMinEquality (const LinearExpr &target, absl::Span< const IntVar > vars)
	Adds target == min(vars).
Constraint	AddMinEquality (const LinearExpr &target, absl::Span< const LinearExpr > exprs)
	Adds target == min(exprs).
Constraint	AddMinEquality (const LinearExpr &target, std::initializer_list< LinearExpr > exprs)
	Adds target == min(exprs).
Constraint	AddMaxEquality (const LinearExpr &target, absl::Span< const IntVar > vars)
	Adds target == max(vars).
Constraint	AddMaxEquality (const LinearExpr &target, absl::Span< const LinearExpr > exprs)
	Adds target == max(exprs).
Constraint	AddMaxEquality (const LinearExpr &target, std::initializer_list< LinearExpr > exprs)
	Adds target == max(exprs).
Constraint	AddDivisionEquality (const LinearExpr &target, const LinearExpr &numerator, const LinearExpr &denominator)
	Adds target = num / denom (integer division rounded towards 0).
Constraint	AddAbsEquality (const LinearExpr &target, const LinearExpr &expr)
	Adds target == abs(expr).
Constraint	AddModuloEquality (const LinearExpr &target, const LinearExpr &var, const LinearExpr &mod)
	Adds target = var % mod.
Constraint	AddMultiplicationEquality (const LinearExpr &target, absl::Span< const LinearExpr > exprs)
	Adds target == prod(exprs).
Constraint	AddMultiplicationEquality (const LinearExpr &target, absl::Span< const IntVar > vars)
	Adds target == prod(vars).
Constraint	AddMultiplicationEquality (const LinearExpr &target, std::initializer_list< LinearExpr > exprs)
	Adds target == prod(vars).
Constraint	AddMultiplicationEquality (const LinearExpr &target, const LinearExpr &left, const LinearExpr &right)
	Adds target == left * right.
Constraint	AddNoOverlap (absl::Span< const IntervalVar > vars)
NoOverlap2DConstraint	AddNoOverlap2D ()
CumulativeConstraint	AddCumulative (LinearExpr capacity)
void	Minimize (const LinearExpr &expr)
	Adds a linear minimization objective.
void	Minimize (const DoubleLinearExpr &expr)
void	Maximize (const LinearExpr &expr)
	Adds a linear maximization objective.
void	Maximize (const DoubleLinearExpr &expr)
void	ClearObjective ()
	Removes the objective from the model.
bool	HasObjective () const
	Checks whether the model contains an objective.
void	AddDecisionStrategy (absl::Span< const IntVar > variables, DecisionStrategyProto::VariableSelectionStrategy var_strategy, DecisionStrategyProto::DomainReductionStrategy domain_strategy)
	Adds a decision strategy on a list of integer variables.
void	AddDecisionStrategy (absl::Span< const BoolVar > variables, DecisionStrategyProto::VariableSelectionStrategy var_strategy, DecisionStrategyProto::DomainReductionStrategy domain_strategy)
	Adds a decision strategy on a list of integer variables.
void	AddDecisionStrategy (absl::Span< const LinearExpr > expressions, DecisionStrategyProto::VariableSelectionStrategy var_strategy, DecisionStrategyProto::DomainReductionStrategy domain_strategy)
	Adds a decision strategy on a list of affine expressions.
void	AddDecisionStrategy (std::initializer_list< LinearExpr > expressions, DecisionStrategyProto::VariableSelectionStrategy var_strategy, DecisionStrategyProto::DomainReductionStrategy domain_strategy)
	Adds a decision strategy on a list of affine expressions.
void	AddHint (IntVar var, int64_t value)
	Adds hinting to a variable.
void	AddHint (BoolVar var, bool value)
	Adds hinting to a Boolean variable.
void	ClearHints ()
	Removes all hints.
void	AddAssumption (BoolVar lit)
	Adds a literal to the model as assumptions.
void	AddAssumptions (absl::Span< const BoolVar > literals)
	Adds multiple literals to the model as assumptions.
void	ClearAssumptions ()
	Remove all assumptions from the model.
const CpModelProto &	Build () const
const CpModelProto &	Proto () const
CpModelProto *	MutableProto ()
bool	ExportToFile (absl::string_view filename) const
	Export the model to file.
CpModelBuilder	Clone () const
	Returns a cloned version of the current model.
BoolVar	GetBoolVarFromProtoIndex (int index)
	Returns the Boolean variable from its index in the proto.
IntVar	GetIntVarFromProtoIndex (int index)
	Returns the integer variable from its index in the proto.
IntervalVar	GetIntervalVarFromProtoIndex (int index)
	Returns the interval variable from its index in the proto.

Friends
class	CumulativeConstraint
class	ReservoirConstraint
class	IntervalVar
class	IntVar

Member Function Documentation

◆ AddAbsEquality()

Constraint operations_research::sat::CpModelBuilder::AddAbsEquality	(	const LinearExpr &	target,
		const LinearExpr &	expr )

Adds target == abs(expr).

Definition at line 1209 of file cp_model.cc.

◆ AddAllDifferent() [1/3]

Constraint operations_research::sat::CpModelBuilder::AddAllDifferent ( absl::Span< const IntVar > vars )

This constraint forces all variables to have different values.

Definition at line 918 of file cp_model.cc.

◆ AddAllDifferent() [2/3]

Constraint operations_research::sat::CpModelBuilder::AddAllDifferent ( absl::Span< const LinearExpr > exprs )

This constraint forces all expressions to have different values.

Definition at line 928 of file cp_model.cc.

◆ AddAllDifferent() [3/3]

Constraint operations_research::sat::CpModelBuilder::AddAllDifferent ( std::initializer_list< LinearExpr > exprs )

This constraint forces all expressions to have different values.

Definition at line 936 of file cp_model.cc.

◆ AddAllowedAssignments() [1/3]

TableConstraint operations_research::sat::CpModelBuilder::AddAllowedAssignments ( absl::Span< const IntVar > variables )

Adds an allowed assignments constraint.

Definition at line 1013 of file cp_model.cc.

◆ AddAllowedAssignments() [2/3]

TableConstraint operations_research::sat::CpModelBuilder::AddAllowedAssignments ( absl::Span< const LinearExpr > expressions )

Adds an allowed assignments constraint.

An AllowedAssignments constraint is a constraint on an array of affine expressions (a * var + b) that forces, when all expressions are fixed to a single value, that the corresponding list of values is equal to one of the tuples added to the constraint.

It returns a table constraint that allows adding tuples incrementally after construction.

Definition at line 1004 of file cp_model.cc.

◆ AddAllowedAssignments() [3/3]

TableConstraint operations_research::sat::CpModelBuilder::AddAllowedAssignments ( std::initializer_list< LinearExpr > expressions )

Adds an allowed assignments constraint.

Definition at line 1024 of file cp_model.cc.

◆ AddAssumption()

void operations_research::sat::CpModelBuilder::AddAssumption ( BoolVar lit )

Adds a literal to the model as assumptions.

Definition at line 1425 of file cp_model.cc.

◆ AddAssumptions()

void operations_research::sat::CpModelBuilder::AddAssumptions ( absl::Span< const BoolVar > literals )

Adds multiple literals to the model as assumptions.

Definition at line 1429 of file cp_model.cc.

◆ AddAtLeastOne()

Constraint operations_research::sat::CpModelBuilder::AddAtLeastOne ( absl::Span< const BoolVar > literals )

Same as AddBoolOr(). Sum literals >= 1.

Definition at line 787 of file cp_model.cc.

◆ AddAtMostOne()

Constraint operations_research::sat::CpModelBuilder::AddAtMostOne ( absl::Span< const BoolVar > literals )

At most one literal is true. Sum literals <= 1.

Definition at line 791 of file cp_model.cc.

◆ AddAutomaton() [1/3]

AutomatonConstraint operations_research::sat::CpModelBuilder::AddAutomaton	(	absl::Span< const IntVar >	transition_variables,
		int	starting_state,
		absl::Span< const int >	final_states )

An automaton constraint.

Definition at line 1089 of file cp_model.cc.

◆ AddAutomaton() [2/3]

AutomatonConstraint operations_research::sat::CpModelBuilder::AddAutomaton	(	absl::Span< const LinearExpr >	transition_expressions,
		int	starting_state,
		absl::Span< const int >	final_states )

An automaton constraint.

An automaton constraint takes a list of variables (of size n), an initial state, a set of final states, and a set of transitions. A transition is a triplet ('tail', 'head', 'label'), where 'tail' and 'head' are states, and 'label' is the label of an arc from 'head' to 'tail', corresponding to the value of one variable in the list of variables.

This automaton will be unrolled into a flow with n + 1 phases. Each phase contains the possible states of the automaton. The first state contains the initial state. The last phase contains the final states.

Between two consecutive phases i and i + 1, the automaton creates a set of arcs. For each transition (tail, head, label), it will add an arc from the state 'tail' of phase i and the state 'head' of phase i + 1. This arc labeled by the value 'label' of the variables 'variables[i]'. That is, this arc can only be selected if 'variables[i]' is assigned the value 'label'. A feasible solution of this constraint is an assignment of variables such that, starting from the initial state in phase 0, there is a path labeled by the values of the variables that ends in one of the final states in the final phase.

It returns an AutomatonConstraint that allows adding transition incrementally after construction.

Definition at line 1075 of file cp_model.cc.

◆ AddAutomaton() [3/3]

AutomatonConstraint operations_research::sat::CpModelBuilder::AddAutomaton	(	std::initializer_list< LinearExpr >	transition_expressions,
		int	starting_state,
		absl::Span< const int >	final_states )

An automaton constraint.

Definition at line 1105 of file cp_model.cc.

◆ AddBoolAnd()

Constraint operations_research::sat::CpModelBuilder::AddBoolAnd ( absl::Span< const BoolVar > literals )

Adds the constraint that all literals must be true.

Definition at line 806 of file cp_model.cc.

◆ AddBoolOr()

Constraint operations_research::sat::CpModelBuilder::AddBoolOr ( absl::Span< const BoolVar > literals )

Adds the constraint that at least one of the literals must be true.

Definition at line 780 of file cp_model.cc.

◆ AddBoolXor()

Constraint operations_research::sat::CpModelBuilder::AddBoolXor ( absl::Span< const BoolVar > literals )

Adds the constraint that an odd number of literals is true.

Definition at line 814 of file cp_model.cc.

◆ AddCircuitConstraint()

CircuitConstraint operations_research::sat::CpModelBuilder::AddCircuitConstraint ( )

Adds a circuit constraint.

The circuit constraint is defined on a graph where the arc presence is controlled by literals. That is the arc is part of the circuit of its corresponding literal is assigned to true.

For now, we ignore node indices with no incident arc. All the other nodes must have exactly one incoming and one outgoing selected arc (i.e. literal at true). All the selected arcs that are not self-loops must form a single circuit.

It returns a circuit constraint that allows adding arcs incrementally after construction.

Definition at line 996 of file cp_model.cc.

◆ AddCumulative()

CumulativeConstraint operations_research::sat::CpModelBuilder::AddCumulative ( LinearExpr capacity )

The cumulative constraint

It ensures that for any integer point, the sum of the demands of the intervals containing that point does not exceed the capacity.

Definition at line 1281 of file cp_model.cc.

◆ AddDecisionStrategy() [1/4]

void operations_research::sat::CpModelBuilder::AddDecisionStrategy	(	absl::Span< const BoolVar >	variables,
		DecisionStrategyProto::VariableSelectionStrategy	var_strategy,
		DecisionStrategyProto::DomainReductionStrategy	domain_strategy )

Adds a decision strategy on a list of integer variables.

Definition at line 1362 of file cp_model.cc.

◆ AddDecisionStrategy() [2/4]

void operations_research::sat::CpModelBuilder::AddDecisionStrategy	(	absl::Span< const IntVar >	variables,
		DecisionStrategyProto::VariableSelectionStrategy	var_strategy,
		DecisionStrategyProto::DomainReductionStrategy	domain_strategy )

Adds a decision strategy on a list of integer variables.

Definition at line 1342 of file cp_model.cc.

◆ AddDecisionStrategy() [3/4]

void operations_research::sat::CpModelBuilder::AddDecisionStrategy	(	absl::Span< const LinearExpr >	expressions,
		DecisionStrategyProto::VariableSelectionStrategy	var_strategy,
		DecisionStrategyProto::DomainReductionStrategy	domain_strategy )

Adds a decision strategy on a list of affine expressions.

Definition at line 1382 of file cp_model.cc.

◆ AddDecisionStrategy() [4/4]

void operations_research::sat::CpModelBuilder::AddDecisionStrategy	(	std::initializer_list< LinearExpr >	expressions,
		DecisionStrategyProto::VariableSelectionStrategy	var_strategy,
		DecisionStrategyProto::DomainReductionStrategy	domain_strategy )

Adds a decision strategy on a list of affine expressions.

Definition at line 1394 of file cp_model.cc.

◆ AddDivisionEquality()

Constraint operations_research::sat::CpModelBuilder::AddDivisionEquality	(	const LinearExpr &	target,
		const LinearExpr &	numerator,
		const LinearExpr &	denominator )

Adds target = num / denom (integer division rounded towards 0).

Definition at line 1199 of file cp_model.cc.

◆ AddElement() [1/3]

Constraint operations_research::sat::CpModelBuilder::AddElement	(	LinearExpr	index,
		absl::Span< const int64_t >	values,
		LinearExpr	target )

Adds the element constraint: values[index] == target.

Definition at line 957 of file cp_model.cc.

◆ AddElement() [2/3]

Constraint operations_research::sat::CpModelBuilder::AddElement	(	LinearExpr	index,
		absl::Span< const LinearExpr >	expressions,
		LinearExpr	target )

Adds the element constraint: expressions[index] == target.

Definition at line 970 of file cp_model.cc.

◆ AddElement() [3/3]

Constraint operations_research::sat::CpModelBuilder::AddElement	(	LinearExpr	index,
		std::initializer_list< LinearExpr >	expressions,
		LinearExpr	target )

Adds the element constraint: expressions[index] == target.

Definition at line 983 of file cp_model.cc.

◆ AddEquality()

Constraint operations_research::sat::CpModelBuilder::AddEquality	(	const LinearExpr &	left,
		const LinearExpr &	right )

Adds left == right.

Definition at line 839 of file cp_model.cc.

◆ AddExactlyOne()

Constraint operations_research::sat::CpModelBuilder::AddExactlyOne ( absl::Span< const BoolVar > literals )

Exactly one literal is true. Sum literals == 1.

Definition at line 799 of file cp_model.cc.

◆ AddForbiddenAssignments() [1/3]

TableConstraint operations_research::sat::CpModelBuilder::AddForbiddenAssignments ( absl::Span< const IntVar > variables )

Adds an forbidden assignments constraint.

Definition at line 1040 of file cp_model.cc.

◆ AddForbiddenAssignments() [2/3]

TableConstraint operations_research::sat::CpModelBuilder::AddForbiddenAssignments ( absl::Span< const LinearExpr > expression )

Adds an forbidden assignments constraint.

A ForbiddenAssignments constraint is a constraint on an array of affine expressions (a * var + b) where the list of impossible combinations is provided in the tuples added to the constraint.

It returns a table constraint that allows adding tuples incrementally after construction.

Definition at line 1033 of file cp_model.cc.

◆ AddForbiddenAssignments() [3/3]

TableConstraint operations_research::sat::CpModelBuilder::AddForbiddenAssignments ( std::initializer_list< LinearExpr > expressions )

Adds an forbidden assignments constraint.

Definition at line 1047 of file cp_model.cc.

◆ AddGreaterOrEqual()

Constraint operations_research::sat::CpModelBuilder::AddGreaterOrEqual	(	const LinearExpr &	left,
		const LinearExpr &	right )

Adds left >= right.

Definition at line 849 of file cp_model.cc.

◆ AddGreaterThan()

Constraint operations_research::sat::CpModelBuilder::AddGreaterThan	(	const LinearExpr &	left,
		const LinearExpr &	right )

Adds left > right.

Definition at line 869 of file cp_model.cc.

◆ AddHint() [1/2]

void operations_research::sat::CpModelBuilder::AddHint	(	BoolVar	var,
		bool	value )

Adds hinting to a Boolean variable.

Definition at line 1411 of file cp_model.cc.

◆ AddHint() [2/2]

void operations_research::sat::CpModelBuilder::AddHint	(	IntVar	var,
		int64_t	value )

Adds hinting to a variable.

Definition at line 1406 of file cp_model.cc.

◆ AddImplication() [1/2]

Constraint operations_research::sat::CpModelBuilder::AddImplication	(	absl::Span< const BoolVar >	lhs,
		absl::Span< const BoolVar >	rhs )

inline

Adds implication: if all lhs vars are true then all rhs vars must be true.

Definition at line 815 of file cp_model.h.

◆ AddImplication() [2/2]

Constraint operations_research::sat::CpModelBuilder::AddImplication	(	BoolVar	a,
		BoolVar	b )

inline

Adds a => b.

Definition at line 810 of file cp_model.h.

◆ AddInverseConstraint()

Constraint operations_research::sat::CpModelBuilder::AddInverseConstraint	(	absl::Span< const IntVar >	variables,
		absl::Span< const IntVar >	inverse_variables )

An inverse constraint.

It enforces that if 'variables[i]' is assigned a value 'j', then inverse_variables[j] is assigned a value 'i'. And vice versa.

Definition at line 1054 of file cp_model.cc.

◆ AddLessOrEqual()

Constraint operations_research::sat::CpModelBuilder::AddLessOrEqual	(	const LinearExpr &	left,
		const LinearExpr &	right )

Adds left <= right.

Definition at line 859 of file cp_model.cc.

◆ AddLessThan()

Constraint operations_research::sat::CpModelBuilder::AddLessThan	(	const LinearExpr &	left,
		const LinearExpr &	right )

Adds left < right.

Definition at line 879 of file cp_model.cc.

◆ AddLinearConstraint()

Constraint operations_research::sat::CpModelBuilder::AddLinearConstraint	(	const LinearExpr &	expr,
		const Domain &	domain )

Adds expr in domain.

Definition at line 889 of file cp_model.cc.

◆ AddMaxEquality() [1/3]

Constraint operations_research::sat::CpModelBuilder::AddMaxEquality	(	const LinearExpr &	target,
		absl::Span< const IntVar >	vars )

Adds target == max(vars).

Definition at line 1169 of file cp_model.cc.

◆ AddMaxEquality() [2/3]

Constraint operations_research::sat::CpModelBuilder::AddMaxEquality	(	const LinearExpr &	target,
		absl::Span< const LinearExpr >	exprs )

Adds target == max(exprs).

Definition at line 1179 of file cp_model.cc.

◆ AddMaxEquality() [3/3]

Constraint operations_research::sat::CpModelBuilder::AddMaxEquality	(	const LinearExpr &	target,
		std::initializer_list< LinearExpr >	exprs )

Adds target == max(exprs).

Definition at line 1189 of file cp_model.cc.

◆ AddMinEquality() [1/3]

Constraint operations_research::sat::CpModelBuilder::AddMinEquality	(	const LinearExpr &	target,
		absl::Span< const IntVar >	vars )

Adds target == min(vars).

Definition at line 1133 of file cp_model.cc.

◆ AddMinEquality() [2/3]

Constraint operations_research::sat::CpModelBuilder::AddMinEquality	(	const LinearExpr &	target,
		absl::Span< const LinearExpr >	exprs )

Adds target == min(exprs).

Definition at line 1145 of file cp_model.cc.

◆ AddMinEquality() [3/3]

Constraint operations_research::sat::CpModelBuilder::AddMinEquality	(	const LinearExpr &	target,
		std::initializer_list< LinearExpr >	exprs )

Adds target == min(exprs).

Definition at line 1157 of file cp_model.cc.

◆ AddModuloEquality()

Constraint operations_research::sat::CpModelBuilder::AddModuloEquality	(	const LinearExpr &	target,
		const LinearExpr &	var,
		const LinearExpr &	mod )

Adds target = var % mod.

Definition at line 1219 of file cp_model.cc.

◆ AddMultipleCircuitConstraint()

MultipleCircuitConstraint operations_research::sat::CpModelBuilder::AddMultipleCircuitConstraint ( )

Adds a multiple circuit constraint, aka the "VRP" (Vehicle Routing Problem) constraint.

The direct graph where arc i (from tails[i] to head[i]) is present iff literals[i] is true must satisfy this set of properties:

#incoming arcs == 1 except for node 0.
#outgoing arcs == 1 except for node 0.
for node zero, #incoming arcs == #outgoing arcs.
There are no duplicate arcs.
Self-arcs are allowed except for node 0.
There is no cycle in this graph, except through node 0.

Definition at line 1000 of file cp_model.cc.

◆ AddMultiplicationEquality() [1/4]

Constraint operations_research::sat::CpModelBuilder::AddMultiplicationEquality	(	const LinearExpr &	target,
		absl::Span< const IntVar >	vars )

Adds target == prod(vars).

Definition at line 1229 of file cp_model.cc.

◆ AddMultiplicationEquality() [2/4]

Constraint operations_research::sat::CpModelBuilder::AddMultiplicationEquality	(	const LinearExpr &	target,
		absl::Span< const LinearExpr >	exprs )

Adds target == prod(exprs).

Definition at line 1239 of file cp_model.cc.

◆ AddMultiplicationEquality() [3/4]

Constraint operations_research::sat::CpModelBuilder::AddMultiplicationEquality	(	const LinearExpr &	target,
		const LinearExpr &	left,
		const LinearExpr &	right )

Adds target == left * right.

Definition at line 1258 of file cp_model.cc.

◆ AddMultiplicationEquality() [4/4]

Constraint operations_research::sat::CpModelBuilder::AddMultiplicationEquality	(	const LinearExpr &	target,
		std::initializer_list< LinearExpr >	exprs )

Adds target == prod(vars).

Definition at line 1249 of file cp_model.cc.

◆ AddNoOverlap()

Constraint operations_research::sat::CpModelBuilder::AddNoOverlap ( absl::Span< const IntervalVar > vars )

Adds a no-overlap constraint that ensures that all present intervals do not overlap in time.

Definition at line 1269 of file cp_model.cc.

◆ AddNoOverlap2D()

NoOverlap2DConstraint operations_research::sat::CpModelBuilder::AddNoOverlap2D ( )

The no_overlap_2d constraint prevents a set of boxes from overlapping.

Definition at line 1277 of file cp_model.cc.

◆ AddNotEqual()

Constraint operations_research::sat::CpModelBuilder::AddNotEqual	(	const LinearExpr &	left,
		const LinearExpr &	right )

Adds left != right.

Definition at line 906 of file cp_model.cc.

◆ AddReservoirConstraint()

ReservoirConstraint operations_research::sat::CpModelBuilder::AddReservoirConstraint	(	int64_t	min_level,
		int64_t	max_level )

Adds a reservoir constraint with optional refill/emptying events.

Maintain a reservoir level within bounds. The water level starts at 0, and at any time, it must be within [min_level, max_level].

Given an event (time, level_change, active), if active is true, and if time is assigned a value t, then the level of the reservoir changes by level_change (which is constant) at time t. Therefore, at any time t:

sum(level_changes[i] * actives[i] if times[i] <= t)
    in [min_level, max_level]

Note that min level must be <= 0, and the max level must be >= 0. Please use fixed level_changes to simulate an initial state.

It returns a ReservoirConstraint that allows adding optional and non optional events incrementally after construction.

Definition at line 1067 of file cp_model.cc.

◆ AddVariableElement()

Constraint operations_research::sat::CpModelBuilder::AddVariableElement	(	LinearExpr	index,
		absl::Span< const IntVar >	variables,
		LinearExpr	target )

Adds the element constraint: variables[index] == target.

Definition at line 945 of file cp_model.cc.

◆ Build()

const CpModelProto & operations_research::sat::CpModelBuilder::Build ( ) const

inline

Definition at line 1159 of file cp_model.h.

◆ ClearAssumptions()

void operations_research::sat::CpModelBuilder::ClearAssumptions ( )

Remove all assumptions from the model.

Definition at line 1435 of file cp_model.cc.

◆ ClearHints()

void operations_research::sat::CpModelBuilder::ClearHints ( )

Removes all hints.

Definition at line 1421 of file cp_model.cc.

◆ ClearObjective()

void operations_research::sat::CpModelBuilder::ClearObjective ( )

Removes the objective from the model.

Definition at line 1333 of file cp_model.cc.

◆ Clone()

CpModelBuilder operations_research::sat::CpModelBuilder::Clone ( ) const

Returns a cloned version of the current model.

Definition at line 1439 of file cp_model.cc.

◆ ExportToFile()

bool operations_research::sat::CpModelBuilder::ExportToFile ( absl::string_view filename ) const

Export the model to file.

Definition at line 1491 of file cp_model.cc.

◆ FalseVar()

BoolVar operations_research::sat::CpModelBuilder::FalseVar ( )

Creates an always false Boolean variable. If this is called multiple times, the same variable will always be returned.

Definition at line 711 of file cp_model.cc.

◆ FixVariable() [1/2]

void operations_research::sat::CpModelBuilder::FixVariable	(	BoolVar	var,
		bool	value )

Definition at line 770 of file cp_model.cc.

◆ FixVariable() [2/2]

void operations_research::sat::CpModelBuilder::FixVariable	(	IntVar	var,
		int64_t	value )

It is sometime convenient when building a model to create a bunch of variables that will later be fixed. Instead of doing AddEquality(var, value) which add a constraint, these functions modify directly the underlying variable domain.

Note: this ignore completely the original variable domain and just fix the given variable to the given value, even if it was outside the given variable domain. You can still use AddEquality() if this is not what you want.

Definition at line 766 of file cp_model.cc.

◆ GetBoolVarFromProtoIndex()

BoolVar operations_research::sat::CpModelBuilder::GetBoolVarFromProtoIndex ( int index )

Returns the Boolean variable from its index in the proto.

Definition at line 1459 of file cp_model.cc.

◆ GetIntervalVarFromProtoIndex()

IntervalVar operations_research::sat::CpModelBuilder::GetIntervalVarFromProtoIndex ( int index )

Returns the interval variable from its index in the proto.

Definition at line 1481 of file cp_model.cc.

◆ GetIntVarFromProtoIndex()

IntVar operations_research::sat::CpModelBuilder::GetIntVarFromProtoIndex ( int index )

Returns the integer variable from its index in the proto.

Definition at line 1475 of file cp_model.cc.

◆ HasObjective()

bool operations_research::sat::CpModelBuilder::HasObjective ( ) const

Checks whether the model contains an objective.

Definition at line 1338 of file cp_model.cc.

◆ Maximize() [1/2]

void operations_research::sat::CpModelBuilder::Maximize ( const DoubleLinearExpr & expr )

Adds a linear floating point maximization objective.

Note: the coefficients will be internally scaled to integer.

Definition at line 1322 of file cp_model.cc.

◆ Maximize() [2/2]

void operations_research::sat::CpModelBuilder::Maximize ( const LinearExpr & expr )

Adds a linear maximization objective.

Definition at line 1299 of file cp_model.cc.

◆ Minimize() [1/2]

void operations_research::sat::CpModelBuilder::Minimize ( const DoubleLinearExpr & expr )

Adds a linear floating point minimization objective.

Note: the coefficients will be internally scaled to integer.

Definition at line 1311 of file cp_model.cc.

◆ Minimize() [2/2]

void operations_research::sat::CpModelBuilder::Minimize ( const LinearExpr & expr )

Adds a linear minimization objective.

Definition at line 1288 of file cp_model.cc.

◆ MutableProto()

CpModelProto * operations_research::sat::CpModelBuilder::MutableProto ( )

inline

Definition at line 1161 of file cp_model.h.

◆ NewBoolVar()

BoolVar operations_research::sat::CpModelBuilder::NewBoolVar ( )

Creates a Boolean variable.

Definition at line 695 of file cp_model.cc.

◆ NewConstant()

IntVar operations_research::sat::CpModelBuilder::NewConstant ( int64_t value )

Creates a constant variable. This is a shortcut for NewVariable(Domain(value)).but it will return the same variable if used twice with the same constant.

Definition at line 703 of file cp_model.cc.

◆ NewFixedSizeIntervalVar()

IntervalVar operations_research::sat::CpModelBuilder::NewFixedSizeIntervalVar	(	const LinearExpr &	start,
		int64_t	size )

Creates an interval variable with a fixed size.

Definition at line 727 of file cp_model.cc.

◆ NewIntervalVar()

IntervalVar operations_research::sat::CpModelBuilder::NewIntervalVar	(	const LinearExpr &	start,
		const LinearExpr &	size,
		const LinearExpr &	end )

Creates an interval variable from 3 affine expressions.

Definition at line 715 of file cp_model.cc.

◆ NewIntVar()

IntVar operations_research::sat::CpModelBuilder::NewIntVar ( const Domain & domain )

Creates an integer variable with the given domain.

Definition at line 685 of file cp_model.cc.

◆ NewOptionalFixedSizeIntervalVar()

IntervalVar operations_research::sat::CpModelBuilder::NewOptionalFixedSizeIntervalVar	(	const LinearExpr &	start,
		int64_t	size,
		BoolVar	presence )

Creates an optional interval variable with a fixed size.

Definition at line 753 of file cp_model.cc.

◆ NewOptionalIntervalVar()

IntervalVar operations_research::sat::CpModelBuilder::NewOptionalIntervalVar	(	const LinearExpr &	start,
		const LinearExpr &	size,
		const LinearExpr &	end,
		BoolVar	presence )

Creates an optional interval variable from 3 affine expressions and a Boolean variable.

Definition at line 739 of file cp_model.cc.

◆ Proto()

const CpModelProto & operations_research::sat::CpModelBuilder::Proto ( ) const

inline

Definition at line 1160 of file cp_model.h.

◆ SetName()

void operations_research::sat::CpModelBuilder::SetName ( absl::string_view name )

Sets the name of the model.

Definition at line 649 of file cp_model.cc.

◆ TrueVar()

BoolVar operations_research::sat::CpModelBuilder::TrueVar ( )

Creates an always true Boolean variable. If this is called multiple times, the same variable will always be returned.

Definition at line 707 of file cp_model.cc.

◆ CumulativeConstraint

friend class CumulativeConstraint

friend

Definition at line 1179 of file cp_model.h.

◆ IntervalVar

friend class IntervalVar

friend

Definition at line 1181 of file cp_model.h.

◆ IntVar

friend class IntVar

friend

Definition at line 1182 of file cp_model.h.

◆ ReservoirConstraint

friend class ReservoirConstraint

friend

Definition at line 1180 of file cp_model.h.

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

ortools/sat/cp_model.h
ortools/sat/cp_model.cc

Detailed Description

Public Member Functions

Friends

Member Function Documentation

◆ AddAbsEquality()

◆ AddAllDifferent() [1/3]

◆ AddAllDifferent() [2/3]

◆ AddAllDifferent() [3/3]

◆ AddAllowedAssignments() [1/3]

◆ AddAllowedAssignments() [2/3]

◆ AddAllowedAssignments() [3/3]

◆ AddAssumption()

◆ AddAssumptions()

◆ AddAtLeastOne()

◆ AddAtMostOne()

◆ AddAutomaton() [1/3]

◆ AddAutomaton() [2/3]

◆ AddAutomaton() [3/3]

◆ AddBoolAnd()

◆ AddBoolOr()

◆ AddBoolXor()

◆ AddCircuitConstraint()

◆ AddCumulative()

◆ AddDecisionStrategy() [1/4]

◆ AddDecisionStrategy() [2/4]

◆ AddDecisionStrategy() [3/4]

◆ AddDecisionStrategy() [4/4]

◆ AddDivisionEquality()

◆ AddElement() [1/3]

◆ AddElement() [2/3]

◆ AddElement() [3/3]

◆ AddEquality()

◆ AddExactlyOne()

◆ AddForbiddenAssignments() [1/3]

◆ AddForbiddenAssignments() [2/3]

◆ AddForbiddenAssignments() [3/3]

◆ AddGreaterOrEqual()

◆ AddGreaterThan()

◆ AddHint() [1/2]

◆ AddHint() [2/2]

◆ AddImplication() [1/2]

◆ AddImplication() [2/2]

◆ AddInverseConstraint()

◆ AddLessOrEqual()

◆ AddLessThan()

◆ AddLinearConstraint()

◆ AddMaxEquality() [1/3]

◆ AddMaxEquality() [2/3]

◆ AddMaxEquality() [3/3]

◆ AddMinEquality() [1/3]

◆ AddMinEquality() [2/3]

◆ AddMinEquality() [3/3]

◆ AddModuloEquality()

◆ AddMultipleCircuitConstraint()

◆ AddMultiplicationEquality() [1/4]

◆ AddMultiplicationEquality() [2/4]

◆ AddMultiplicationEquality() [3/4]

◆ AddMultiplicationEquality() [4/4]

◆ AddNoOverlap()

◆ AddNoOverlap2D()

◆ AddNotEqual()

◆ AddReservoirConstraint()

◆ AddVariableElement()

◆ Build()

◆ ClearAssumptions()

◆ ClearHints()

◆ ClearObjective()

◆ Clone()

◆ ExportToFile()

◆ FalseVar()

◆ FixVariable() [1/2]

◆ FixVariable() [2/2]

◆ GetBoolVarFromProtoIndex()

◆ GetIntervalVarFromProtoIndex()

◆ GetIntVarFromProtoIndex()

◆ HasObjective()

◆ Maximize() [1/2]

◆ Maximize() [2/2]

◆ Minimize() [1/2]

◆ Minimize() [2/2]