Detailed Description

A constraint programming problem.

Protobuf type operations_research.sat.CpModelProto

Definition at line 16 of file CpModelProto.java.

Inheritance diagram for com.google.ortools.sat.CpModelProto:

Classes
class	Builder

Public Member Functions
java.lang.String	getName ()
com.google.protobuf.ByteString	getNameBytes ()
java.util.List< com.google.ortools.sat.IntegerVariableProto >	getVariablesList ()
java.util.List<? extends com.google.ortools.sat.IntegerVariableProtoOrBuilder >	getVariablesOrBuilderList ()
int	getVariablesCount ()
com.google.ortools.sat.IntegerVariableProto	getVariables (int index)
com.google.ortools.sat.IntegerVariableProtoOrBuilder	getVariablesOrBuilder (int index)
java.util.List< com.google.ortools.sat.ConstraintProto >	getConstraintsList ()
java.util.List<? extends com.google.ortools.sat.ConstraintProtoOrBuilder >	getConstraintsOrBuilderList ()
int	getConstraintsCount ()
com.google.ortools.sat.ConstraintProto	getConstraints (int index)
com.google.ortools.sat.ConstraintProtoOrBuilder	getConstraintsOrBuilder (int index)
boolean	hasObjective ()
com.google.ortools.sat.CpObjectiveProto	getObjective ()
com.google.ortools.sat.CpObjectiveProtoOrBuilder	getObjectiveOrBuilder ()
boolean	hasFloatingPointObjective ()
com.google.ortools.sat.FloatObjectiveProto	getFloatingPointObjective ()
com.google.ortools.sat.FloatObjectiveProtoOrBuilder	getFloatingPointObjectiveOrBuilder ()
java.util.List< com.google.ortools.sat.DecisionStrategyProto >	getSearchStrategyList ()
java.util.List<? extends com.google.ortools.sat.DecisionStrategyProtoOrBuilder >	getSearchStrategyOrBuilderList ()
int	getSearchStrategyCount ()
com.google.ortools.sat.DecisionStrategyProto	getSearchStrategy (int index)
com.google.ortools.sat.DecisionStrategyProtoOrBuilder	getSearchStrategyOrBuilder (int index)
boolean	hasSolutionHint ()
com.google.ortools.sat.PartialVariableAssignment	getSolutionHint ()
com.google.ortools.sat.PartialVariableAssignmentOrBuilder	getSolutionHintOrBuilder ()
java.util.List< java.lang.Integer >	getAssumptionsList ()
int	getAssumptionsCount ()
int	getAssumptions (int index)
boolean	hasSymmetry ()
com.google.ortools.sat.SymmetryProto	getSymmetry ()
com.google.ortools.sat.SymmetryProtoOrBuilder	getSymmetryOrBuilder ()
final boolean	isInitialized ()
void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int	getSerializedSize ()
boolean	equals (final java.lang.Object obj)
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
com.google.protobuf.Parser< CpModelProto >	getParserForType ()
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	FLOATING_POINT_OBJECTIVE_FIELD_NUMBER = 9
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
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()
Builder	newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Member Function Documentation

◆ equals()

boolean com.google.ortools.sat.CpModelProto.equals ( final java.lang.Object obj )

Definition at line 720 of file CpModelProto.java.

◆ getAssumptions()

int com.google.ortools.sat.CpModelProto.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 logically
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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 559 of file CpModelProto.java.

◆ getAssumptionsCount()

int com.google.ortools.sat.CpModelProto.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 logically
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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 535 of file CpModelProto.java.

◆ getAssumptionsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.CpModelProto.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 logically
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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 512 of file CpModelProto.java.

◆ getConstraints()

com.google.ortools.sat.ConstraintProto com.google.ortools.sat.CpModelProto.getConstraints ( int index )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 193 of file CpModelProto.java.

◆ getConstraintsCount()

int com.google.ortools.sat.CpModelProto.getConstraintsCount ( )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 186 of file CpModelProto.java.

◆ getConstraintsList()

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

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 171 of file CpModelProto.java.

◆ getConstraintsOrBuilder()

com.google.ortools.sat.ConstraintProtoOrBuilder com.google.ortools.sat.CpModelProto.getConstraintsOrBuilder ( int index )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 200 of file CpModelProto.java.

◆ getConstraintsOrBuilderList()

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

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 179 of file CpModelProto.java.

◆ getDefaultInstance()

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

static

Definition at line 3509 of file CpModelProto.java.

◆ getDefaultInstanceForType()

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

Definition at line 3545 of file CpModelProto.java.

◆ getDescriptor()

final com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.CpModelProto.getDescriptor ( )

static

Definition at line 43 of file CpModelProto.java.

◆ getFloatingPointObjective()

com.google.ortools.sat.FloatObjectiveProto com.google.ortools.sat.CpModelProto.getFloatingPointObjective ( )

Advanced usage.
It is invalid to have both an objective and a floating point objective.

The objective of the model, in floating point format. The solver will
automatically scale this to integer during expansion and thus convert it to
a normal CpObjectiveProto. See the mip* parameters to control how this is
scaled. In most situation the precision will be good enough, but you can
see the logs to see what are the precision guaranteed when this is
converted to a fixed point representation.

Note that even if the precision is bad, the returned objective_value and
best_objective_bound will be computed correctly. So at the end of the solve
you can check the gap if you only want precise optimal.

.operations_research.sat.FloatObjectiveProto floating_point_objective = 9;

Returns: The floatingPointObjective.

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 290 of file CpModelProto.java.

◆ getFloatingPointObjectiveOrBuilder()

com.google.ortools.sat.FloatObjectiveProtoOrBuilder com.google.ortools.sat.CpModelProto.getFloatingPointObjectiveOrBuilder ( )

Advanced usage.
It is invalid to have both an objective and a floating point objective.

The objective of the model, in floating point format. The solver will
automatically scale this to integer during expansion and thus convert it to
a normal CpObjectiveProto. See the mip* parameters to control how this is
scaled. In most situation the precision will be good enough, but you can
see the logs to see what are the precision guaranteed when this is
converted to a fixed point representation.

Note that even if the precision is bad, the returned objective_value and
best_objective_bound will be computed correctly. So at the end of the solve
you can check the gap if you only want precise optimal.

.operations_research.sat.FloatObjectiveProto floating_point_objective = 9;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 313 of file CpModelProto.java.

◆ getName()

java.lang.String com.google.ortools.sat.CpModelProto.getName ( )

For debug/logging only. Can be empty.

string name = 1;

Returns: The name.

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 68 of file CpModelProto.java.

◆ getNameBytes()

com.google.protobuf.ByteString com.google.ortools.sat.CpModelProto.getNameBytes ( )

For debug/logging only. Can be empty.

string name = 1;

Returns: The bytes for name.

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 90 of file CpModelProto.java.

◆ getObjective()

com.google.ortools.sat.CpObjectiveProto com.google.ortools.sat.CpModelProto.getObjective ( )

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

.operations_research.sat.CpObjectiveProto objective = 4;

Returns: The objective.

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 228 of file CpModelProto.java.

◆ getObjectiveOrBuilder()

com.google.ortools.sat.CpObjectiveProtoOrBuilder com.google.ortools.sat.CpModelProto.getObjectiveOrBuilder ( )

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

.operations_research.sat.CpObjectiveProto objective = 4;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 239 of file CpModelProto.java.

◆ getParserForType()

com.google.protobuf.Parser< CpModelProto > com.google.ortools.sat.CpModelProto.getParserForType ( )

Definition at line 3540 of file CpModelProto.java.

◆ getSearchStrategy()

com.google.ortools.sat.DecisionStrategyProto com.google.ortools.sat.CpModelProto.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. Currently, we will set them to
their lower bound in the solution.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 394 of file CpModelProto.java.

◆ getSearchStrategyCount()

int com.google.ortools.sat.CpModelProto.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. Currently, we will set them to
their lower bound in the solution.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 375 of file CpModelProto.java.

◆ getSearchStrategyList()

java.util.List< com.google.ortools.sat.DecisionStrategyProto > com.google.ortools.sat.CpModelProto.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. Currently, we will set them to
their lower bound in the solution.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 336 of file CpModelProto.java.

◆ getSearchStrategyOrBuilder()

com.google.ortools.sat.DecisionStrategyProtoOrBuilder com.google.ortools.sat.CpModelProto.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. Currently, we will set them to
their lower bound in the solution.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 413 of file CpModelProto.java.

◆ getSearchStrategyOrBuilderList()

java.util.List<? extends com.google.ortools.sat.DecisionStrategyProtoOrBuilder > com.google.ortools.sat.CpModelProto.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. Currently, we will set them to
their lower bound in the solution.

repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;

Implements com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 356 of file CpModelProto.java.

◆ getSerializedSize()

int com.google.ortools.sat.CpModelProto.getSerializedSize ( )

Definition at line 664 of file CpModelProto.java.

◆ getSolutionHint()

com.google.ortools.sat.PartialVariableAssignment com.google.ortools.sat.CpModelProto.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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 461 of file CpModelProto.java.

◆ getSolutionHintOrBuilder()

com.google.ortools.sat.PartialVariableAssignmentOrBuilder com.google.ortools.sat.CpModelProto.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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 482 of file CpModelProto.java.

◆ getSymmetry()

com.google.ortools.sat.SymmetryProto com.google.ortools.sat.CpModelProto.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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 595 of file CpModelProto.java.

◆ getSymmetryOrBuilder()

com.google.ortools.sat.SymmetryProtoOrBuilder com.google.ortools.sat.CpModelProto.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 com.google.ortools.sat.CpModelProtoOrBuilder.

Definition at line 610 of file CpModelProto.java.

◆ getVariables()

com.google.ortools.sat.IntegerVariableProto com.google.ortools.sat.CpModelProto.getVariables ( int index )

The associated Protos should be referred by their index in these fields.