Detailed Description

A constraint programming problem.

Protobuf type

operations_research.sat.CpModelProto

Definition at line 13 of file CpModelProto.java.

Classes
class	Builder

Public Member Functions
.lang.Override final com.google.protobuf.UnknownFieldSet	getUnknownFields ()

.lang.Override java.lang.String	getName ()

.lang.Override com.google.protobuf.ByteString	getNameBytes ()

.lang.Override java.util.List< com.google.ortools.sat.IntegerVariableProto >	getVariablesList ()

.lang.Override java.util.List<? extends com.google.ortools.sat.IntegerVariableProtoOrBuilder >	getVariablesOrBuilderList ()

.lang.Override int	getVariablesCount ()

.lang.Override com.google.ortools.sat.IntegerVariableProto	getVariables (int index)

.lang.Override com.google.ortools.sat.IntegerVariableProtoOrBuilder	getVariablesOrBuilder (int index)

.lang.Override java.util.List< com.google.ortools.sat.ConstraintProto >	getConstraintsList ()
	`repeated .operations_research.sat.ConstraintProto constraints = 3;` More...

.lang.Override java.util.List<? extends com.google.ortools.sat.ConstraintProtoOrBuilder >	getConstraintsOrBuilderList ()
	`repeated .operations_research.sat.ConstraintProto constraints = 3;` More...

.lang.Override int	getConstraintsCount ()
	`repeated .operations_research.sat.ConstraintProto constraints = 3;` More...

.lang.Override com.google.ortools.sat.ConstraintProto	getConstraints (int index)
	`repeated .operations_research.sat.ConstraintProto constraints = 3;` More...

.lang.Override com.google.ortools.sat.ConstraintProtoOrBuilder	getConstraintsOrBuilder (int index)
	`repeated .operations_research.sat.ConstraintProto constraints = 3;` More...

.lang.Override boolean	hasObjective ()

.lang.Override com.google.ortools.sat.CpObjectiveProto	getObjective ()

.lang.Override com.google.ortools.sat.CpObjectiveProtoOrBuilder	getObjectiveOrBuilder ()

.lang.Override java.util.List< com.google.ortools.sat.DecisionStrategyProto >	getSearchStrategyList ()

.lang.Override java.util.List<? extends com.google.ortools.sat.DecisionStrategyProtoOrBuilder >	getSearchStrategyOrBuilderList ()

.lang.Override int	getSearchStrategyCount ()

.lang.Override com.google.ortools.sat.DecisionStrategyProto	getSearchStrategy (int index)

.lang.Override com.google.ortools.sat.DecisionStrategyProtoOrBuilder	getSearchStrategyOrBuilder (int index)

.lang.Override boolean	hasSolutionHint ()

.lang.Override com.google.ortools.sat.PartialVariableAssignment	getSolutionHint ()

.lang.Override com.google.ortools.sat.PartialVariableAssignmentOrBuilder	getSolutionHintOrBuilder ()

.lang.Override java.util.List< java.lang.Integer >	getAssumptionsList ()

int	getAssumptionsCount ()

int	getAssumptions (int index)

.lang.Override boolean	hasSymmetry ()

.lang.Override com.google.ortools.sat.SymmetryProto	getSymmetry ()

.lang.Override com.google.ortools.sat.SymmetryProtoOrBuilder	getSymmetryOrBuilder ()

.lang.Override final boolean	isInitialized ()

.lang.Override void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException

.lang.Override int	getSerializedSize ()

.lang.Override boolean	equals (final java.lang.Object obj)

.lang.Override int	hashCode ()

.lang.Override Builder	newBuilderForType ()

.lang.Override Builder	toBuilder ()

.lang.Override com.google.protobuf.Parser< CpModelProto >	getParserForType ()

.lang.Override com.google.ortools.sat.CpModelProto	getDefaultInstanceForType ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

static com.google.ortools.sat.CpModelProto	parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException

static com.google.ortools.sat.CpModelProto	parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException

static com.google.ortools.sat.CpModelProto	parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException

static com.google.ortools.sat.CpModelProto	parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException

static com.google.ortools.sat.CpModelProto	parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException

static com.google.ortools.sat.CpModelProto	parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException

static com.google.ortools.sat.CpModelProto	parseFrom (java.io.InputStream input) throws java.io.IOException

static com.google.ortools.sat.CpModelProto	parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException

static com.google.ortools.sat.CpModelProto	parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException

static com.google.ortools.sat.CpModelProto	parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException

static com.google.ortools.sat.CpModelProto	parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException

static com.google.ortools.sat.CpModelProto	parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException

static Builder	newBuilder ()

static Builder	newBuilder (com.google.ortools.sat.CpModelProto prototype)

static com.google.ortools.sat.CpModelProto	getDefaultInstance ()

static com.google.protobuf.Parser< CpModelProto >	parser ()

Static Public Attributes
static final int	NAME_FIELD_NUMBER = 1

static final int	VARIABLES_FIELD_NUMBER = 2

static final int	CONSTRAINTS_FIELD_NUMBER = 3

static final int	OBJECTIVE_FIELD_NUMBER = 4

static final int	SEARCH_STRATEGY_FIELD_NUMBER = 5

static final int	SOLUTION_HINT_FIELD_NUMBER = 6

static final int	ASSUMPTIONS_FIELD_NUMBER = 7

static final int	SYMMETRY_FIELD_NUMBER = 8

Protected Member Functions
.lang.Override java.lang.Object	newInstance (UnusedPrivateParameter unused)

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()

.lang.Override Builder	newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Member Function Documentation

◆ equals()

.lang.Override boolean equals ( final java.lang.Object obj )

Definition at line 760 of file CpModelProto.java.

◆ getAssumptions()

int getAssumptions ( int index )

A list of literals. The model will be solved assuming all these literals
are true. Compared to just fixing the domain of these literals, using this
mechanism is slower but allows in case the model is INFEASIBLE to get a
potentially small subset of them that can be used to explain the
infeasibility.
Think (IIS), except when you are only concerned by the provided
assumptions. This is powerful as it allows to group a set of logicially
related constraint under only one enforcement literal which can potentially
give you a good and interpretable explanation for infeasiblity.
Such infeasibility explanation will be available in the
sufficient_assumptions_for_infeasibility response field.

repeated int32 assumptions = 7;

Parameters

index The index of the element to return.

Returns: The assumptions at the given index.

Implements CpModelProtoOrBuilder.

Definition at line 609 of file CpModelProto.java.

◆ getAssumptionsCount()

int getAssumptionsCount ( )

A list of literals. The model will be solved assuming all these literals
are true. Compared to just fixing the domain of these literals, using this
mechanism is slower but allows in case the model is INFEASIBLE to get a
potentially small subset of them that can be used to explain the
infeasibility.
Think (IIS), except when you are only concerned by the provided
assumptions. This is powerful as it allows to group a set of logicially
related constraint under only one enforcement literal which can potentially
give you a good and interpretable explanation for infeasiblity.
Such infeasibility explanation will be available in the
sufficient_assumptions_for_infeasibility response field.

repeated int32 assumptions = 7;

Returns: The count of assumptions.

Implements CpModelProtoOrBuilder.

Definition at line 587 of file CpModelProto.java.

◆ getAssumptionsList()

.lang.Override java.util.List<java.lang.Integer> getAssumptionsList ( )

A list of literals. The model will be solved assuming all these literals
are true. Compared to just fixing the domain of these literals, using this
mechanism is slower but allows in case the model is INFEASIBLE to get a
potentially small subset of them that can be used to explain the
infeasibility.
Think (IIS), except when you are only concerned by the provided
assumptions. This is powerful as it allows to group a set of logicially
related constraint under only one enforcement literal which can potentially
give you a good and interpretable explanation for infeasiblity.
Such infeasibility explanation will be available in the
sufficient_assumptions_for_infeasibility response field.

repeated int32 assumptions = 7;

Returns: A list containing the assumptions.

Implements CpModelProtoOrBuilder.

Definition at line 566 of file CpModelProto.java.

◆ getConstraints()

.lang.Override com.google.ortools.sat.ConstraintProto getConstraints ( int index )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements CpModelProtoOrBuilder.

Definition at line 332 of file CpModelProto.java.

◆ getConstraintsCount()

.lang.Override int getConstraintsCount ( )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements CpModelProtoOrBuilder.

Definition at line 325 of file CpModelProto.java.

◆ getConstraintsList()

.lang.Override java.util.List<com.google.ortools.sat.ConstraintProto> getConstraintsList ( )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements CpModelProtoOrBuilder.

Definition at line 310 of file CpModelProto.java.

◆ getConstraintsOrBuilder()

.lang.Override com.google.ortools.sat.ConstraintProtoOrBuilder getConstraintsOrBuilder ( int index )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements CpModelProtoOrBuilder.

Definition at line 339 of file CpModelProto.java.

◆ getConstraintsOrBuilderList()

.lang.Override java.util.List<? extends com.google.ortools.sat.ConstraintProtoOrBuilder> getConstraintsOrBuilderList ( )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements CpModelProtoOrBuilder.

Definition at line 318 of file CpModelProto.java.

◆ getDefaultInstance()

static com.google.ortools.sat.CpModelProto getDefaultInstance ( )

static

Definition at line 3135 of file CpModelProto.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.sat.CpModelProto getDefaultInstanceForType ( )

Definition at line 3160 of file CpModelProto.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ( )

static

Definition at line 186 of file CpModelProto.java.

◆ getName()

.lang.Override java.lang.String getName ( )

For debug/logging only. Can be empty.

string name = 1;

Returns: The name.

Implements CpModelProtoOrBuilder.

Definition at line 209 of file CpModelProto.java.

◆ getNameBytes()

.lang.Override com.google.protobuf.ByteString getNameBytes ( )

For debug/logging only. Can be empty.

string name = 1;

Returns: The bytes for name.

Implements CpModelProtoOrBuilder.

Definition at line 231 of file CpModelProto.java.

◆ getObjective()

.lang.Override com.google.ortools.sat.CpObjectiveProto getObjective ( )

The objective to minimize. Can be empty for pure decision problems.

.operations_research.sat.CpObjectiveProto objective = 4;

Returns: The objective.

Implements CpModelProtoOrBuilder.

Definition at line 367 of file CpModelProto.java.

◆ getObjectiveOrBuilder()

.lang.Override com.google.ortools.sat.CpObjectiveProtoOrBuilder getObjectiveOrBuilder ( )

The objective to minimize. Can be empty for pure decision problems.

.operations_research.sat.CpObjectiveProto objective = 4;

Implements CpModelProtoOrBuilder.

Definition at line 378 of file CpModelProto.java.

◆ getParserForType()

.lang.Override com.google.protobuf.Parser<CpModelProto> getParserForType ( )

Definition at line 3155 of file CpModelProto.java.

◆ getSearchStrategy()

.lang.Override com.google.ortools.sat.DecisionStrategyProto getSearchStrategy ( int index )

Defines the strategy that the solver should follow when the
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
is also used as a heuristic when we are not in fixed search.
Advanced Usage: if not all variables appears and the parameter
"instantiate_all_variables" is set to false, then the solver will not try
to instantiate the variables that do not appear. Thus, at the end of the
search, not all variables may be fixed and this is why we have the
solution_lower_bounds and solution_upper_bounds fields in the
CpSolverResponse.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements CpModelProtoOrBuilder.

Definition at line 458 of file CpModelProto.java.

◆ getSearchStrategyCount()

.lang.Override int getSearchStrategyCount ( )

Defines the strategy that the solver should follow when the
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
is also used as a heuristic when we are not in fixed search.
Advanced Usage: if not all variables appears and the parameter
"instantiate_all_variables" is set to false, then the solver will not try
to instantiate the variables that do not appear. Thus, at the end of the
search, not all variables may be fixed and this is why we have the
solution_lower_bounds and solution_upper_bounds fields in the
CpSolverResponse.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements CpModelProtoOrBuilder.

Definition at line 439 of file CpModelProto.java.

◆ getSearchStrategyList()

.lang.Override java.util.List<com.google.ortools.sat.DecisionStrategyProto> getSearchStrategyList ( )

Defines the strategy that the solver should follow when the
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
is also used as a heuristic when we are not in fixed search.
Advanced Usage: if not all variables appears and the parameter
"instantiate_all_variables" is set to false, then the solver will not try
to instantiate the variables that do not appear. Thus, at the end of the
search, not all variables may be fixed and this is why we have the
solution_lower_bounds and solution_upper_bounds fields in the
CpSolverResponse.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements CpModelProtoOrBuilder.

Definition at line 400 of file CpModelProto.java.

◆ getSearchStrategyOrBuilder()

.lang.Override com.google.ortools.sat.DecisionStrategyProtoOrBuilder getSearchStrategyOrBuilder ( int index )

Defines the strategy that the solver should follow when the
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
is also used as a heuristic when we are not in fixed search.
Advanced Usage: if not all variables appears and the parameter
"instantiate_all_variables" is set to false, then the solver will not try
to instantiate the variables that do not appear. Thus, at the end of the
search, not all variables may be fixed and this is why we have the
solution_lower_bounds and solution_upper_bounds fields in the
CpSolverResponse.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements CpModelProtoOrBuilder.

Definition at line 477 of file CpModelProto.java.

◆ getSearchStrategyOrBuilderList()

.lang.Override java.util.List<? extends com.google.ortools.sat.DecisionStrategyProtoOrBuilder> getSearchStrategyOrBuilderList ( )

Defines the strategy that the solver should follow when the
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
is also used as a heuristic when we are not in fixed search.
Advanced Usage: if not all variables appears and the parameter
"instantiate_all_variables" is set to false, then the solver will not try
to instantiate the variables that do not appear. Thus, at the end of the
search, not all variables may be fixed and this is why we have the
solution_lower_bounds and solution_upper_bounds fields in the
CpSolverResponse.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements CpModelProtoOrBuilder.

Definition at line 420 of file CpModelProto.java.

◆ getSerializedSize()

.lang.Override int getSerializedSize ( )

Definition at line 708 of file CpModelProto.java.

◆ getSolutionHint()

.lang.Override com.google.ortools.sat.PartialVariableAssignment getSolutionHint ( )

Solution hint.
If a feasible or almost-feasible solution to the problem is already known,
it may be helpful to pass it to the solver so that it can be used. The
solver will try to use this information to create its initial feasible
solution.
Note that it may not always be faster to give a hint like this to the
solver. There is also no guarantee that the solver will use this hint or
try to return a solution "close" to this assignment in case of multiple
optimal solutions.

.operations_research.sat.PartialVariableAssignment solution_hint = 6;

Returns: The solutionHint.

Implements CpModelProtoOrBuilder.

Definition at line 521 of file CpModelProto.java.

◆ getSolutionHintOrBuilder()

.lang.Override com.google.ortools.sat.PartialVariableAssignmentOrBuilder getSolutionHintOrBuilder ( )

Solution hint.
If a feasible or almost-feasible solution to the problem is already known,
it may be helpful to pass it to the solver so that it can be used. The
solver will try to use this information to create its initial feasible
solution.
Note that it may not always be faster to give a hint like this to the
solver. There is also no guarantee that the solver will use this hint or
try to return a solution "close" to this assignment in case of multiple
optimal solutions.

.operations_research.sat.PartialVariableAssignment solution_hint = 6;

Implements CpModelProtoOrBuilder.

Definition at line 540 of file CpModelProto.java.

◆ getSymmetry()

.lang.Override com.google.ortools.sat.SymmetryProto getSymmetry ( )

For now, this is not meant to be filled by a client writing a model, but
by our preprocessing step.
Information about the symmetries of the feasible solution space.
These usually leaves the objective invariant.

.operations_research.sat.SymmetryProto symmetry = 8;

Returns: The symmetry.

Implements CpModelProtoOrBuilder.

Definition at line 643 of file CpModelProto.java.

◆ getSymmetryOrBuilder()

.lang.Override com.google.ortools.sat.SymmetryProtoOrBuilder getSymmetryOrBuilder ( )

For now, this is not meant to be filled by a client writing a model, but
by our preprocessing step.
Information about the symmetries of the feasible solution space.
These usually leaves the objective invariant.

.operations_research.sat.SymmetryProto symmetry = 8;

Implements CpModelProtoOrBuilder.

Definition at line 657 of file CpModelProto.java.

◆ getUnknownFields()

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ( )

Definition at line 39 of file CpModelProto.java.