Java Reference

Java Reference

Detailed Description

Definition at line 6 of file CpModelProtoOrBuilder.java.

Public Member Functions

java.lang.String getName ()
 
com.google.protobuf.ByteString getNameBytes ()
 
java.util.List< com.google.ortools.sat.IntegerVariableProtogetVariablesList ()
 
com.google.ortools.sat.IntegerVariableProto getVariables (int index)
 
int getVariablesCount ()
 
java.util.List<? extends com.google.ortools.sat.IntegerVariableProtoOrBuildergetVariablesOrBuilderList ()
 
com.google.ortools.sat.IntegerVariableProtoOrBuilder getVariablesOrBuilder (int index)
 
java.util.List< com.google.ortools.sat.ConstraintProtogetConstraintsList ()
 repeated .operations_research.sat.ConstraintProto constraints = 3; More...
 
com.google.ortools.sat.ConstraintProto getConstraints (int index)
 repeated .operations_research.sat.ConstraintProto constraints = 3; More...
 
int getConstraintsCount ()
 repeated .operations_research.sat.ConstraintProto constraints = 3; More...
 
java.util.List<? extends com.google.ortools.sat.ConstraintProtoOrBuildergetConstraintsOrBuilderList ()
 repeated .operations_research.sat.ConstraintProto constraints = 3; More...
 
com.google.ortools.sat.ConstraintProtoOrBuilder getConstraintsOrBuilder (int index)
 repeated .operations_research.sat.ConstraintProto constraints = 3; More...
 
boolean hasObjective ()
 
com.google.ortools.sat.CpObjectiveProto getObjective ()
 
com.google.ortools.sat.CpObjectiveProtoOrBuilder getObjectiveOrBuilder ()
 
java.util.List< com.google.ortools.sat.DecisionStrategyProtogetSearchStrategyList ()
 
com.google.ortools.sat.DecisionStrategyProto getSearchStrategy (int index)
 
int getSearchStrategyCount ()
 
java.util.List<? extends com.google.ortools.sat.DecisionStrategyProtoOrBuildergetSearchStrategyOrBuilderList ()
 
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 ()
 

Member Function Documentation

◆ 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
indexThe index of the element to return.
Returns
The assumptions at the given index.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ 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.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getAssumptionsList()

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.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getConstraints()

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

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getConstraintsCount()

int getConstraintsCount ( )

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getConstraintsList()

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

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getConstraintsOrBuilder()

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

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getConstraintsOrBuilderList()

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

repeated .operations_research.sat.ConstraintProto constraints = 3;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getName()

java.lang.String getName ( )
For debug/logging only. Can be empty.

string name = 1;

Returns
The name.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getNameBytes()

com.google.protobuf.ByteString getNameBytes ( )
For debug/logging only. Can be empty.

string name = 1;

Returns
The bytes for name.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getObjective()

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

.operations_research.sat.CpObjectiveProto objective = 4;

Returns
The objective.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getObjectiveOrBuilder()

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

.operations_research.sat.CpObjectiveProto objective = 4;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getSearchStrategy()

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;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getSearchStrategyCount()

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;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getSearchStrategyList()

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;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getSearchStrategyOrBuilder()

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;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getSearchStrategyOrBuilderList()

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;

Implemented in CpModelProto.Builder, and 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.

Implemented in CpModelProto.Builder, and 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;

Implemented in CpModelProto.Builder, and 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.

Implemented in CpModelProto.Builder, and 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;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getVariables()

com.google.ortools.sat.IntegerVariableProto getVariables ( int  index)
The associated Protos should be referred by their index in these fields.

repeated .operations_research.sat.IntegerVariableProto variables = 2;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getVariablesCount()

int getVariablesCount ( )
The associated Protos should be referred by their index in these fields.

repeated .operations_research.sat.IntegerVariableProto variables = 2;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getVariablesList()

java.util.List<com.google.ortools.sat.IntegerVariableProto> getVariablesList ( )
The associated Protos should be referred by their index in these fields.

repeated .operations_research.sat.IntegerVariableProto variables = 2;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getVariablesOrBuilder()

com.google.ortools.sat.IntegerVariableProtoOrBuilder getVariablesOrBuilder ( int  index)
The associated Protos should be referred by their index in these fields.

repeated .operations_research.sat.IntegerVariableProto variables = 2;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ getVariablesOrBuilderList()

java.util.List<? extends com.google.ortools.sat.IntegerVariableProtoOrBuilder> getVariablesOrBuilderList ( )
The associated Protos should be referred by their index in these fields.

repeated .operations_research.sat.IntegerVariableProto variables = 2;

Implemented in CpModelProto.Builder, and CpModelProto.

◆ hasObjective()

boolean hasObjective ( )
The objective to minimize. Can be empty for pure decision problems.

.operations_research.sat.CpObjectiveProto objective = 4;

Returns
Whether the objective field is set.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ hasSolutionHint()

boolean hasSolutionHint ( )
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
Whether the solutionHint field is set.

Implemented in CpModelProto.Builder, and CpModelProto.

◆ hasSymmetry()

boolean hasSymmetry ( )
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
Whether the symmetry field is set.

Implemented in CpModelProto.Builder, and CpModelProto.


The documentation for this interface was generated from the following file: