com.google.ortools.sat.CpSolverResponse.Builder Class Reference

Inheritance diagram for com.google.ortools.sat.CpSolverResponse.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.sat.CpSolverResponse	getDefaultInstanceForType ()
com.google.ortools.sat.CpSolverResponse	build ()
com.google.ortools.sat.CpSolverResponse	buildPartial ()
Builder	clone ()
Builder	setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Builder	clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
Builder	clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
Builder	setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Builder	addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.sat.CpSolverResponse other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
int	getStatusValue ()
Builder	setStatusValue (int value)
com.google.ortools.sat.CpSolverStatus	getStatus ()
Builder	setStatus (com.google.ortools.sat.CpSolverStatus value)
Builder	clearStatus ()
java.util.List< java.lang.Long >	getSolutionList ()
int	getSolutionCount ()
long	getSolution (int index)
Builder	setSolution (int index, long value)
Builder	addSolution (long value)
Builder	addAllSolution (java.lang.Iterable<? extends java.lang.Long > values)
Builder	clearSolution ()
double	getObjectiveValue ()
Builder	setObjectiveValue (double value)
Builder	clearObjectiveValue ()
double	getBestObjectiveBound ()
Builder	setBestObjectiveBound (double value)
Builder	clearBestObjectiveBound ()
java.util.List< com.google.ortools.sat.CpSolverSolution >	getAdditionalSolutionsList ()
int	getAdditionalSolutionsCount ()
com.google.ortools.sat.CpSolverSolution	getAdditionalSolutions (int index)
Builder	setAdditionalSolutions (int index, com.google.ortools.sat.CpSolverSolution value)
Builder	setAdditionalSolutions (int index, com.google.ortools.sat.CpSolverSolution.Builder builderForValue)
Builder	addAdditionalSolutions (com.google.ortools.sat.CpSolverSolution value)
Builder	addAdditionalSolutions (int index, com.google.ortools.sat.CpSolverSolution value)
Builder	addAdditionalSolutions (com.google.ortools.sat.CpSolverSolution.Builder builderForValue)
Builder	addAdditionalSolutions (int index, com.google.ortools.sat.CpSolverSolution.Builder builderForValue)
Builder	addAllAdditionalSolutions (java.lang.Iterable<? extends com.google.ortools.sat.CpSolverSolution > values)
Builder	clearAdditionalSolutions ()
Builder	removeAdditionalSolutions (int index)
com.google.ortools.sat.CpSolverSolution.Builder	getAdditionalSolutionsBuilder (int index)
com.google.ortools.sat.CpSolverSolutionOrBuilder	getAdditionalSolutionsOrBuilder (int index)
java.util.List<? extends com.google.ortools.sat.CpSolverSolutionOrBuilder >	getAdditionalSolutionsOrBuilderList ()
com.google.ortools.sat.CpSolverSolution.Builder	addAdditionalSolutionsBuilder ()
com.google.ortools.sat.CpSolverSolution.Builder	addAdditionalSolutionsBuilder (int index)
java.util.List< com.google.ortools.sat.CpSolverSolution.Builder >	getAdditionalSolutionsBuilderList ()
java.util.List< com.google.ortools.sat.IntegerVariableProto >	getTightenedVariablesList ()
int	getTightenedVariablesCount ()
com.google.ortools.sat.IntegerVariableProto	getTightenedVariables (int index)
Builder	setTightenedVariables (int index, com.google.ortools.sat.IntegerVariableProto value)
Builder	setTightenedVariables (int index, com.google.ortools.sat.IntegerVariableProto.Builder builderForValue)
Builder	addTightenedVariables (com.google.ortools.sat.IntegerVariableProto value)
Builder	addTightenedVariables (int index, com.google.ortools.sat.IntegerVariableProto value)
Builder	addTightenedVariables (com.google.ortools.sat.IntegerVariableProto.Builder builderForValue)
Builder	addTightenedVariables (int index, com.google.ortools.sat.IntegerVariableProto.Builder builderForValue)
Builder	addAllTightenedVariables (java.lang.Iterable<? extends com.google.ortools.sat.IntegerVariableProto > values)
Builder	clearTightenedVariables ()
Builder	removeTightenedVariables (int index)
com.google.ortools.sat.IntegerVariableProto.Builder	getTightenedVariablesBuilder (int index)
com.google.ortools.sat.IntegerVariableProtoOrBuilder	getTightenedVariablesOrBuilder (int index)
java.util.List<? extends com.google.ortools.sat.IntegerVariableProtoOrBuilder >	getTightenedVariablesOrBuilderList ()
com.google.ortools.sat.IntegerVariableProto.Builder	addTightenedVariablesBuilder ()
com.google.ortools.sat.IntegerVariableProto.Builder	addTightenedVariablesBuilder (int index)
java.util.List< com.google.ortools.sat.IntegerVariableProto.Builder >	getTightenedVariablesBuilderList ()
java.util.List< java.lang.Integer >	getSufficientAssumptionsForInfeasibilityList ()
int	getSufficientAssumptionsForInfeasibilityCount ()
int	getSufficientAssumptionsForInfeasibility (int index)
Builder	setSufficientAssumptionsForInfeasibility (int index, int value)
Builder	addSufficientAssumptionsForInfeasibility (int value)
Builder	addAllSufficientAssumptionsForInfeasibility (java.lang.Iterable<? extends java.lang.Integer > values)
Builder	clearSufficientAssumptionsForInfeasibility ()
boolean	hasIntegerObjective ()
com.google.ortools.sat.CpObjectiveProto	getIntegerObjective ()
Builder	setIntegerObjective (com.google.ortools.sat.CpObjectiveProto value)
Builder	setIntegerObjective (com.google.ortools.sat.CpObjectiveProto.Builder builderForValue)
Builder	mergeIntegerObjective (com.google.ortools.sat.CpObjectiveProto value)
Builder	clearIntegerObjective ()
com.google.ortools.sat.CpObjectiveProto.Builder	getIntegerObjectiveBuilder ()
com.google.ortools.sat.CpObjectiveProtoOrBuilder	getIntegerObjectiveOrBuilder ()
long	getInnerObjectiveLowerBound ()
Builder	setInnerObjectiveLowerBound (long value)
Builder	clearInnerObjectiveLowerBound ()
long	getNumIntegers ()
Builder	setNumIntegers (long value)
Builder	clearNumIntegers ()
long	getNumBooleans ()
Builder	setNumBooleans (long value)
Builder	clearNumBooleans ()
long	getNumConflicts ()
Builder	setNumConflicts (long value)
Builder	clearNumConflicts ()
long	getNumBranches ()
Builder	setNumBranches (long value)
Builder	clearNumBranches ()
long	getNumBinaryPropagations ()
Builder	setNumBinaryPropagations (long value)
Builder	clearNumBinaryPropagations ()
long	getNumIntegerPropagations ()
Builder	setNumIntegerPropagations (long value)
Builder	clearNumIntegerPropagations ()
long	getNumRestarts ()
Builder	setNumRestarts (long value)
Builder	clearNumRestarts ()
long	getNumLpIterations ()
Builder	setNumLpIterations (long value)
Builder	clearNumLpIterations ()
double	getWallTime ()
Builder	setWallTime (double value)
Builder	clearWallTime ()
double	getUserTime ()
Builder	setUserTime (double value)
Builder	clearUserTime ()
double	getDeterministicTime ()
Builder	setDeterministicTime (double value)
Builder	clearDeterministicTime ()
double	getGapIntegral ()
Builder	setGapIntegral (double value)
Builder	clearGapIntegral ()
java.lang.String	getSolutionInfo ()
com.google.protobuf.ByteString	getSolutionInfoBytes ()
Builder	setSolutionInfo (java.lang.String value)
Builder	clearSolutionInfo ()
Builder	setSolutionInfoBytes (com.google.protobuf.ByteString value)
java.lang.String	getSolveLog ()
com.google.protobuf.ByteString	getSolveLogBytes ()
Builder	setSolveLog (java.lang.String value)
Builder	clearSolveLog ()
Builder	setSolveLogBytes (com.google.protobuf.ByteString value)
final Builder	setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
final Builder	mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)

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

Protected Member Functions
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()

Detailed Description

The response returned by a solver trying to solve a CpModelProto.

Next id: 31

Protobuf type operations_research.sat.CpSolverResponse

Definition at line 1244 of file CpSolverResponse.java.

Member Function Documentation

addAdditionalSolutions() [1/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAdditionalSolutions

(

com.google.ortools.sat.CpSolverSolution

value

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2265 of file CpSolverResponse.java.

addAdditionalSolutions() [2/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAdditionalSolutions

(

com.google.ortools.sat.CpSolverSolution.Builder

builderForValue

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2316 of file CpSolverResponse.java.

addAdditionalSolutions() [3/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAdditionalSolutions	(	int	index,
		com.google.ortools.sat.CpSolverSolution	value )

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2290 of file CpSolverResponse.java.

addAdditionalSolutions() [4/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAdditionalSolutions	(	int	index,
		com.google.ortools.sat.CpSolverSolution.Builder	builderForValue )

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2339 of file CpSolverResponse.java.

addAdditionalSolutionsBuilder() [1/2]

com.google.ortools.sat.CpSolverSolution.Builder com.google.ortools.sat.CpSolverResponse.Builder.addAdditionalSolutionsBuilder

(

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2485 of file CpSolverResponse.java.

addAdditionalSolutionsBuilder() [2/2]

com.google.ortools.sat.CpSolverSolution.Builder com.google.ortools.sat.CpSolverResponse.Builder.addAdditionalSolutionsBuilder

(

int

index

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2501 of file CpSolverResponse.java.

addAllAdditionalSolutions()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAllAdditionalSolutions

(

java.lang.Iterable<? extends com.google.ortools.sat.CpSolverSolution >

values

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2362 of file CpSolverResponse.java.

addAllSolution()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAllSolution

(

java.lang.Iterable<? extends java.lang.Long >

values

)

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Parameters

values

The solution to add.

Returns

This builder for chaining.

Definition at line 2005 of file CpSolverResponse.java.

addAllSufficientAssumptionsForInfeasibility()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAllSufficientAssumptionsForInfeasibility

(

java.lang.Iterable<? extends java.lang.Integer >

values

)

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Parameters

values

The sufficientAssumptionsForInfeasibility to add.

Returns

This builder for chaining.

Definition at line 3243 of file CpSolverResponse.java.

addAllTightenedVariables()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addAllTightenedVariables

(

java.lang.Iterable<? extends com.google.ortools.sat.IntegerVariableProto >

values

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2824 of file CpSolverResponse.java.

addRepeatedField()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addRepeatedField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		java.lang.Object	value )

Definition at line 1476 of file CpSolverResponse.java.

addSolution()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addSolution

(

long

value

)

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Parameters

value

The solution to add.

Returns

This builder for chaining.

Definition at line 1985 of file CpSolverResponse.java.

addSufficientAssumptionsForInfeasibility()

Builder com.google.ortools.sat.CpSolverResponse.Builder.addSufficientAssumptionsForInfeasibility

(

int

value

)

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Parameters

value

The sufficientAssumptionsForInfeasibility to add.

Returns

This builder for chaining.

Definition at line 3208 of file CpSolverResponse.java.

addTightenedVariables() [1/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addTightenedVariables

(

com.google.ortools.sat.IntegerVariableProto

value

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2703 of file CpSolverResponse.java.

addTightenedVariables() [2/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addTightenedVariables

(

com.google.ortools.sat.IntegerVariableProto.Builder

builderForValue

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2766 of file CpSolverResponse.java.

addTightenedVariables() [3/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addTightenedVariables	(	int	index,
		com.google.ortools.sat.IntegerVariableProto	value )

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2734 of file CpSolverResponse.java.

addTightenedVariables() [4/4]

Builder com.google.ortools.sat.CpSolverResponse.Builder.addTightenedVariables	(	int	index,
		com.google.ortools.sat.IntegerVariableProto.Builder	builderForValue )

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2795 of file CpSolverResponse.java.

addTightenedVariablesBuilder() [1/2]

com.google.ortools.sat.IntegerVariableProto.Builder com.google.ortools.sat.CpSolverResponse.Builder.addTightenedVariablesBuilder

(

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2983 of file CpSolverResponse.java.

addTightenedVariablesBuilder() [2/2]

com.google.ortools.sat.IntegerVariableProto.Builder com.google.ortools.sat.CpSolverResponse.Builder.addTightenedVariablesBuilder

(

int

index

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 3005 of file CpSolverResponse.java.

build()

com.google.ortools.sat.CpSolverResponse com.google.ortools.sat.CpSolverResponse.Builder.build

(

)

Definition at line 1337 of file CpSolverResponse.java.

buildPartial()

com.google.ortools.sat.CpSolverResponse com.google.ortools.sat.CpSolverResponse.Builder.buildPartial

(

)

Definition at line 1346 of file CpSolverResponse.java.

clear()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clear

(

)

Definition at line 1280 of file CpSolverResponse.java.

clearAdditionalSolutions()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearAdditionalSolutions

(

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2386 of file CpSolverResponse.java.

clearBestObjectiveBound()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearBestObjectiveBound

(

)

Only make sense for an optimization problem. A proven lower-bound on the
objective for a minimization problem, or a proven upper-bound for a
maximization problem.

double best_objective_bound = 4;

Returns

This builder for chaining.

Definition at line 2128 of file CpSolverResponse.java.

clearDeterministicTime()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearDeterministicTime

(

)

double deterministic_time = 17;

Returns

This builder for chaining.

Definition at line 3900 of file CpSolverResponse.java.

clearField()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearField

(

com.google.protobuf.Descriptors.FieldDescriptor

field

)

Definition at line 1460 of file CpSolverResponse.java.

clearGapIntegral()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearGapIntegral

(

)

The integral of log(1 + absolute_objective_gap) over time.

double gap_integral = 22;

Returns

This builder for chaining.

Definition at line 3944 of file CpSolverResponse.java.

clearInnerObjectiveLowerBound()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearInnerObjectiveLowerBound

(

)

Advanced usage.

A lower bound on the inner integer expression of the objective. This is
either a bound on the expression in the returned integer_objective or on
the integer expression of the original objective if the problem already has
an integer objective.

int64 inner_objective_lower_bound = 29;

Returns

This builder for chaining.

Definition at line 3512 of file CpSolverResponse.java.

clearIntegerObjective()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearIntegerObjective

(

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Definition at line 3396 of file CpSolverResponse.java.

clearNumBinaryPropagations()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumBinaryPropagations

(

)

int64 num_binary_propagations = 13;

Returns

This builder for chaining.

Definition at line 3696 of file CpSolverResponse.java.

clearNumBooleans()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumBooleans

(

)

int64 num_booleans = 10;

Returns

This builder for chaining.

Definition at line 3600 of file CpSolverResponse.java.

clearNumBranches()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumBranches

(

)

int64 num_branches = 12;

Returns

This builder for chaining.

Definition at line 3664 of file CpSolverResponse.java.

clearNumConflicts()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumConflicts

(

)

int64 num_conflicts = 11;

Returns

This builder for chaining.

Definition at line 3632 of file CpSolverResponse.java.

clearNumIntegerPropagations()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumIntegerPropagations

(

)

int64 num_integer_propagations = 14;

Returns

This builder for chaining.

Definition at line 3728 of file CpSolverResponse.java.

clearNumIntegers()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumIntegers

(

)

Some statistics about the solve.

Important: in multithread, this correspond the statistics of the first
subsolver. Which is usually the one with the user defined parameters. Or
the default-search if none are specified.

int64 num_integers = 30;

Returns

This builder for chaining.

Definition at line 3568 of file CpSolverResponse.java.

clearNumLpIterations()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumLpIterations

(

)

int64 num_lp_iterations = 25;

Returns

This builder for chaining.

Definition at line 3792 of file CpSolverResponse.java.

clearNumRestarts()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearNumRestarts

(

)

int64 num_restarts = 24;

Returns

This builder for chaining.

Definition at line 3760 of file CpSolverResponse.java.

clearObjectiveValue()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearObjectiveValue

(

)

Only make sense for an optimization problem. The objective value of the
returned solution if it is non-empty. If there is no solution, then for a
minimization problem, this will be an upper-bound of the objective of any
feasible solution, and a lower-bound for a maximization problem.

double objective_value = 3;

Returns

This builder for chaining.

Definition at line 2078 of file CpSolverResponse.java.

clearOneof()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearOneof

(

com.google.protobuf.Descriptors.OneofDescriptor

oneof

)

Definition at line 1465 of file CpSolverResponse.java.

clearSolution()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearSolution

(

)

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Returns

This builder for chaining.

Definition at line 2025 of file CpSolverResponse.java.

clearSolutionInfo()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearSolutionInfo

(

)

Additional information about how the solution was found. It also stores
model or parameters errors that caused the model to be invalid.

string solution_info = 20;

Returns

This builder for chaining.

Definition at line 4022 of file CpSolverResponse.java.

clearSolveLog()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearSolveLog

(

)

The solve log will be filled if the parameter log_to_response is set to
true.

string solve_log = 26;

Returns

This builder for chaining.

Definition at line 4119 of file CpSolverResponse.java.

clearStatus()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearStatus

(

)

The status of the solve.

.operations_research.sat.CpSolverStatus status = 1;

Returns

This builder for chaining.

Definition at line 1892 of file CpSolverResponse.java.

clearSufficientAssumptionsForInfeasibility()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearSufficientAssumptionsForInfeasibility

(

)

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Returns

This builder for chaining.

Definition at line 3278 of file CpSolverResponse.java.

clearTightenedVariables()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearTightenedVariables

(

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2854 of file CpSolverResponse.java.

clearUserTime()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearUserTime

(

)

double user_time = 16;

Returns

This builder for chaining.

Definition at line 3868 of file CpSolverResponse.java.

clearWallTime()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clearWallTime

(

)

The time counted from the beginning of the Solve() call.

double wall_time = 15;

Returns

This builder for chaining.

Definition at line 3836 of file CpSolverResponse.java.

clone()

Builder com.google.ortools.sat.CpSolverResponse.Builder.clone

(

)

Definition at line 1450 of file CpSolverResponse.java.

getAdditionalSolutions()

com.google.ortools.sat.CpSolverSolution com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutions

(

int

index

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2197 of file CpSolverResponse.java.

getAdditionalSolutionsBuilder()

com.google.ortools.sat.CpSolverSolution.Builder com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutionsBuilder

(

int

index

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2430 of file CpSolverResponse.java.

getAdditionalSolutionsBuilderList()

java.util.List< com.google.ortools.sat.CpSolverSolution.Builder > com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutionsBuilderList

(

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2519 of file CpSolverResponse.java.

getAdditionalSolutionsCount()

int com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutionsCount

(

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2178 of file CpSolverResponse.java.

getAdditionalSolutionsList()

java.util.List< com.google.ortools.sat.CpSolverSolution > com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutionsList

(

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2159 of file CpSolverResponse.java.

getAdditionalSolutionsOrBuilder()

com.google.ortools.sat.CpSolverSolutionOrBuilder com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutionsOrBuilder

(

int

index

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2446 of file CpSolverResponse.java.

getAdditionalSolutionsOrBuilderList()

java.util.List<? extends com.google.ortools.sat.CpSolverSolutionOrBuilder > com.google.ortools.sat.CpSolverResponse.Builder.getAdditionalSolutionsOrBuilderList

(

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2466 of file CpSolverResponse.java.

getBestObjectiveBound()

double com.google.ortools.sat.CpSolverResponse.Builder.getBestObjectiveBound

(

)

Only make sense for an optimization problem. A proven lower-bound on the
objective for a minimization problem, or a proven upper-bound for a
maximization problem.

double best_objective_bound = 4;

Returns

The bestObjectiveBound.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2097 of file CpSolverResponse.java.

getDefaultInstanceForType()

com.google.ortools.sat.CpSolverResponse com.google.ortools.sat.CpSolverResponse.Builder.getDefaultInstanceForType

(

)

Definition at line 1332 of file CpSolverResponse.java.

getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.CpSolverResponse.Builder.getDescriptor ( )

static

Definition at line 1249 of file CpSolverResponse.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.CpSolverResponse.Builder.getDescriptorForType

(

)

Definition at line 1327 of file CpSolverResponse.java.

getDeterministicTime()

double com.google.ortools.sat.CpSolverResponse.Builder.getDeterministicTime

(

)

double deterministic_time = 17;

Returns

The deterministicTime.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3881 of file CpSolverResponse.java.

getGapIntegral()

double com.google.ortools.sat.CpSolverResponse.Builder.getGapIntegral

(

)

The integral of log(1 + absolute_objective_gap) over time.

double gap_integral = 22;

Returns

The gapIntegral.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3917 of file CpSolverResponse.java.

getInnerObjectiveLowerBound()

long com.google.ortools.sat.CpSolverResponse.Builder.getInnerObjectiveLowerBound

(

)

Advanced usage.

A lower bound on the inner integer expression of the objective. This is
either a bound on the expression in the returned integer_objective or on
the integer expression of the original objective if the problem already has
an integer objective.

int64 inner_objective_lower_bound = 29;

Returns

The innerObjectiveLowerBound.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3475 of file CpSolverResponse.java.

getIntegerObjective()

com.google.ortools.sat.CpObjectiveProto com.google.ortools.sat.CpSolverResponse.Builder.getIntegerObjective

(

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Returns

The integerObjective.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3311 of file CpSolverResponse.java.

getIntegerObjectiveBuilder()

com.google.ortools.sat.CpObjectiveProto.Builder com.google.ortools.sat.CpSolverResponse.Builder.getIntegerObjectiveBuilder

(

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Definition at line 3415 of file CpSolverResponse.java.

getIntegerObjectiveOrBuilder()

com.google.ortools.sat.CpObjectiveProtoOrBuilder com.google.ortools.sat.CpSolverResponse.Builder.getIntegerObjectiveOrBuilder

(

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3429 of file CpSolverResponse.java.

getNumBinaryPropagations()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumBinaryPropagations

(

)

int64 num_binary_propagations = 13;

Returns

The numBinaryPropagations.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3677 of file CpSolverResponse.java.

getNumBooleans()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumBooleans

(

)

int64 num_booleans = 10;

Returns

The numBooleans.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3581 of file CpSolverResponse.java.

getNumBranches()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumBranches

(

)

int64 num_branches = 12;

Returns

The numBranches.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3645 of file CpSolverResponse.java.

getNumConflicts()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumConflicts

(

)

int64 num_conflicts = 11;

Returns

The numConflicts.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3613 of file CpSolverResponse.java.

getNumIntegerPropagations()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumIntegerPropagations

(

)

int64 num_integer_propagations = 14;

Returns

The numIntegerPropagations.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3709 of file CpSolverResponse.java.

getNumIntegers()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumIntegers

(

)

Some statistics about the solve.

Important: in multithread, this correspond the statistics of the first
subsolver. Which is usually the one with the user defined parameters. Or
the default-search if none are specified.

int64 num_integers = 30;

Returns

The numIntegers.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3533 of file CpSolverResponse.java.

getNumLpIterations()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumLpIterations

(

)

int64 num_lp_iterations = 25;

Returns

The numLpIterations.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3773 of file CpSolverResponse.java.

getNumRestarts()

long com.google.ortools.sat.CpSolverResponse.Builder.getNumRestarts

(

)

int64 num_restarts = 24;

Returns

The numRestarts.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3741 of file CpSolverResponse.java.

getObjectiveValue()

double com.google.ortools.sat.CpSolverResponse.Builder.getObjectiveValue

(

)

Only make sense for an optimization problem. The objective value of the
returned solution if it is non-empty. If there is no solution, then for a
minimization problem, this will be an upper-bound of the objective of any
feasible solution, and a lower-bound for a maximization problem.

double objective_value = 3;

Returns

The objectiveValue.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2045 of file CpSolverResponse.java.

getSolution()

long com.google.ortools.sat.CpSolverResponse.Builder.getSolution

(

int

index

)

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Parameters

index

The index of the element to return.

Returns

The solution at the given index.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 1948 of file CpSolverResponse.java.

getSolutionCount()

int com.google.ortools.sat.CpSolverResponse.Builder.getSolutionCount

(

)

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Returns

The count of solution.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 1933 of file CpSolverResponse.java.

getSolutionInfo()

java.lang.String com.google.ortools.sat.CpSolverResponse.Builder.getSolutionInfo

(

)

Additional information about how the solution was found. It also stores
model or parameters errors that caused the model to be invalid.

string solution_info = 20;

Returns

The solutionInfo.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3961 of file CpSolverResponse.java.

getSolutionInfoBytes()

com.google.protobuf.ByteString com.google.ortools.sat.CpSolverResponse.Builder.getSolutionInfoBytes

(

)

Additional information about how the solution was found. It also stores
model or parameters errors that caused the model to be invalid.

string solution_info = 20;

Returns

The bytes for solutionInfo.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3983 of file CpSolverResponse.java.

getSolutionList()

java.util.List< java.lang.Long > com.google.ortools.sat.CpSolverResponse.Builder.getSolutionList

(

)

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Returns

A list containing the solution.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 1918 of file CpSolverResponse.java.

getSolveLog()

java.lang.String com.google.ortools.sat.CpSolverResponse.Builder.getSolveLog

(

)

The solve log will be filled if the parameter log_to_response is set to
true.

string solve_log = 26;

Returns

The solveLog.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 4058 of file CpSolverResponse.java.

getSolveLogBytes()

com.google.protobuf.ByteString com.google.ortools.sat.CpSolverResponse.Builder.getSolveLogBytes

(

)

The solve log will be filled if the parameter log_to_response is set to
true.

string solve_log = 26;

Returns

The bytes for solveLog.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 4080 of file CpSolverResponse.java.

getStatus()

com.google.ortools.sat.CpSolverStatus com.google.ortools.sat.CpSolverResponse.Builder.getStatus

(

)

The status of the solve.

.operations_research.sat.CpSolverStatus status = 1;

Returns

The status.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 1862 of file CpSolverResponse.java.

getStatusValue()

int com.google.ortools.sat.CpSolverResponse.Builder.getStatusValue

(

)

The status of the solve.

.operations_research.sat.CpSolverStatus status = 1;

Returns

The enum numeric value on the wire for status.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 1835 of file CpSolverResponse.java.

getSufficientAssumptionsForInfeasibility()

int com.google.ortools.sat.CpSolverResponse.Builder.getSufficientAssumptionsForInfeasibility

(

int

index

)

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Parameters

index

The index of the element to return.

Returns

The sufficientAssumptionsForInfeasibility at the given index.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3141 of file CpSolverResponse.java.

getSufficientAssumptionsForInfeasibilityCount()

int com.google.ortools.sat.CpSolverResponse.Builder.getSufficientAssumptionsForInfeasibilityCount

(

)

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Returns

The count of sufficientAssumptionsForInfeasibility.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3111 of file CpSolverResponse.java.

getSufficientAssumptionsForInfeasibilityList()

java.util.List< java.lang.Integer > com.google.ortools.sat.CpSolverResponse.Builder.getSufficientAssumptionsForInfeasibilityList

(

)

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Returns

A list containing the sufficientAssumptionsForInfeasibility.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3081 of file CpSolverResponse.java.

getTightenedVariables()

com.google.ortools.sat.IntegerVariableProto com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariables

(

int

index

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2617 of file CpSolverResponse.java.

getTightenedVariablesBuilder()

com.google.ortools.sat.IntegerVariableProto.Builder com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariablesBuilder

(

int

index

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2910 of file CpSolverResponse.java.

getTightenedVariablesBuilderList()

java.util.List< com.google.ortools.sat.IntegerVariableProto.Builder > com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariablesBuilderList

(

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 3029 of file CpSolverResponse.java.

getTightenedVariablesCount()

int com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariablesCount

(

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2592 of file CpSolverResponse.java.

getTightenedVariablesList()

java.util.List< com.google.ortools.sat.IntegerVariableProto > com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariablesList

(

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2567 of file CpSolverResponse.java.

getTightenedVariablesOrBuilder()

com.google.ortools.sat.IntegerVariableProtoOrBuilder com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariablesOrBuilder

(

int

index

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2932 of file CpSolverResponse.java.

getTightenedVariablesOrBuilderList()

java.util.List<? extends com.google.ortools.sat.IntegerVariableProtoOrBuilder > com.google.ortools.sat.CpSolverResponse.Builder.getTightenedVariablesOrBuilderList

(

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2958 of file CpSolverResponse.java.

getUserTime()

double com.google.ortools.sat.CpSolverResponse.Builder.getUserTime

(

)

double user_time = 16;

Returns

The userTime.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3849 of file CpSolverResponse.java.

getWallTime()

double com.google.ortools.sat.CpSolverResponse.Builder.getWallTime

(

)

The time counted from the beginning of the Solve() call.

double wall_time = 15;

Returns

The wallTime.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3809 of file CpSolverResponse.java.

hasIntegerObjective()

boolean com.google.ortools.sat.CpSolverResponse.Builder.hasIntegerObjective

(

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Returns

Whether the integerObjective field is set.

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3298 of file CpSolverResponse.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessageV3.FieldAccessorTable com.google.ortools.sat.CpSolverResponse.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 1255 of file CpSolverResponse.java.

isInitialized()

final boolean com.google.ortools.sat.CpSolverResponse.Builder.isInitialized

(

)

Definition at line 1634 of file CpSolverResponse.java.

mergeFrom() [1/3]

Builder com.google.ortools.sat.CpSolverResponse.Builder.mergeFrom

(

com.google.ortools.sat.CpSolverResponse

other

)

Definition at line 1491 of file CpSolverResponse.java.

mergeFrom() [2/3]

Builder com.google.ortools.sat.CpSolverResponse.Builder.mergeFrom	(	com.google.protobuf.CodedInputStream	input,
		com.google.protobuf.ExtensionRegistryLite	extensionRegistry ) throws java.io.IOException

Definition at line 1639 of file CpSolverResponse.java.

mergeFrom() [3/3]

Builder com.google.ortools.sat.CpSolverResponse.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 1482 of file CpSolverResponse.java.

mergeIntegerObjective()

Builder com.google.ortools.sat.CpSolverResponse.Builder.mergeIntegerObjective

(

com.google.ortools.sat.CpObjectiveProto

value

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Definition at line 3369 of file CpSolverResponse.java.

mergeUnknownFields()

final Builder com.google.ortools.sat.CpSolverResponse.Builder.mergeUnknownFields

(

final com.google.protobuf.UnknownFieldSet

unknownFields

)

Definition at line 4151 of file CpSolverResponse.java.

removeAdditionalSolutions()

Builder com.google.ortools.sat.CpSolverResponse.Builder.removeAdditionalSolutions

(

int

index

)

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2408 of file CpSolverResponse.java.

removeTightenedVariables()

Builder com.google.ortools.sat.CpSolverResponse.Builder.removeTightenedVariables

(

int

index

)

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2882 of file CpSolverResponse.java.

setAdditionalSolutions() [1/2]

Builder com.google.ortools.sat.CpSolverResponse.Builder.setAdditionalSolutions	(	int	index,
		com.google.ortools.sat.CpSolverSolution	value )

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2216 of file CpSolverResponse.java.

setAdditionalSolutions() [2/2]

Builder com.google.ortools.sat.CpSolverResponse.Builder.setAdditionalSolutions	(	int	index,
		com.google.ortools.sat.CpSolverSolution.Builder	builderForValue )

If the parameter fill_additional_solutions_in_response is set, then we
copy all the solutions from our internal solution pool here.

Note that the one returned in the solution field will likely appear here
too. Do not rely on the solutions order as it depends on our internal
representation (after postsolve).

repeated .operations_research.sat.CpSolverSolution additional_solutions = 27;

Definition at line 2242 of file CpSolverResponse.java.

setBestObjectiveBound()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setBestObjectiveBound

(

double

value

)

Only make sense for an optimization problem. A proven lower-bound on the
objective for a minimization problem, or a proven upper-bound for a
maximization problem.

double best_objective_bound = 4;

Parameters

value

The bestObjectiveBound to set.

Returns

This builder for chaining.

Definition at line 2111 of file CpSolverResponse.java.

setDeterministicTime()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setDeterministicTime

(

double

value

)

double deterministic_time = 17;

Parameters

value

The deterministicTime to set.

Returns

This builder for chaining.

Definition at line 3889 of file CpSolverResponse.java.

setField()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		java.lang.Object	value )

Definition at line 1454 of file CpSolverResponse.java.

setGapIntegral()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setGapIntegral

(

double

value

)

The integral of log(1 + absolute_objective_gap) over time.

double gap_integral = 22;

Parameters

value

The gapIntegral to set.

Returns

This builder for chaining.

Definition at line 3929 of file CpSolverResponse.java.

setInnerObjectiveLowerBound()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setInnerObjectiveLowerBound

(

long

value

)

Advanced usage.

A lower bound on the inner integer expression of the objective. This is
either a bound on the expression in the returned integer_objective or on
the integer expression of the original objective if the problem already has
an integer objective.

int64 inner_objective_lower_bound = 29;

Parameters

value

The innerObjectiveLowerBound to set.

Returns

This builder for chaining.

Definition at line 3492 of file CpSolverResponse.java.

setIntegerObjective() [1/2]

Builder com.google.ortools.sat.CpSolverResponse.Builder.setIntegerObjective

(

com.google.ortools.sat.CpObjectiveProto

value

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Definition at line 3327 of file CpSolverResponse.java.

setIntegerObjective() [2/2]

Builder com.google.ortools.sat.CpSolverResponse.Builder.setIntegerObjective

(

com.google.ortools.sat.CpObjectiveProto.Builder

builderForValue

)

Contains the integer objective optimized internally. This is only filled if
the problem had a floating point objective, and on the final response, not
the ones given to callbacks.

.operations_research.sat.CpObjectiveProto integer_objective = 28;

Definition at line 3349 of file CpSolverResponse.java.

setNumBinaryPropagations()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumBinaryPropagations

(

long

value

)

int64 num_binary_propagations = 13;

Parameters

value

The numBinaryPropagations to set.

Returns

This builder for chaining.

Definition at line 3685 of file CpSolverResponse.java.

setNumBooleans()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumBooleans

(

long

value

)

int64 num_booleans = 10;

Parameters

value

The numBooleans to set.

Returns

This builder for chaining.

Definition at line 3589 of file CpSolverResponse.java.

setNumBranches()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumBranches

(

long

value

)

int64 num_branches = 12;

Parameters

value

The numBranches to set.

Returns

This builder for chaining.

Definition at line 3653 of file CpSolverResponse.java.

setNumConflicts()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumConflicts

(

long

value

)

int64 num_conflicts = 11;

Parameters

value

The numConflicts to set.

Returns

This builder for chaining.

Definition at line 3621 of file CpSolverResponse.java.

setNumIntegerPropagations()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumIntegerPropagations

(

long

value

)

int64 num_integer_propagations = 14;

Parameters

value

The numIntegerPropagations to set.

Returns

This builder for chaining.

Definition at line 3717 of file CpSolverResponse.java.

setNumIntegers()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumIntegers

(

long

value

)

Some statistics about the solve.

Important: in multithread, this correspond the statistics of the first
subsolver. Which is usually the one with the user defined parameters. Or
the default-search if none are specified.

int64 num_integers = 30;

Parameters

value

The numIntegers to set.

Returns

This builder for chaining.

Definition at line 3549 of file CpSolverResponse.java.

setNumLpIterations()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumLpIterations

(

long

value

)

int64 num_lp_iterations = 25;

Parameters

value

The numLpIterations to set.

Returns

This builder for chaining.

Definition at line 3781 of file CpSolverResponse.java.

setNumRestarts()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setNumRestarts

(

long

value

)

int64 num_restarts = 24;

Parameters

value

The numRestarts to set.

Returns

This builder for chaining.

Definition at line 3749 of file CpSolverResponse.java.

setObjectiveValue()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setObjectiveValue

(

double

value

)

Only make sense for an optimization problem. The objective value of the
returned solution if it is non-empty. If there is no solution, then for a
minimization problem, this will be an upper-bound of the objective of any
feasible solution, and a lower-bound for a maximization problem.

double objective_value = 3;

Parameters

value

The objectiveValue to set.

Returns

This builder for chaining.

Definition at line 2060 of file CpSolverResponse.java.

setRepeatedField()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setRepeatedField	(	com.google.protobuf.Descriptors.FieldDescriptor	field,
		int	index,
		java.lang.Object	value )

Definition at line 1470 of file CpSolverResponse.java.

setSolution()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setSolution	(	int	index,
		long	value )

A feasible solution to the given problem. Depending on the returned status
it may be optimal or just feasible. This is in one-to-one correspondence
with a CpModelProto::variables repeated field and list the values of all
the variables.

repeated int64 solution = 2;

Parameters

index	The index to set the value at.
value	The solution to set.

Returns

This builder for chaining.

Definition at line 1964 of file CpSolverResponse.java.

setSolutionInfo()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setSolutionInfo

(

java.lang.String

value

)

Additional information about how the solution was found. It also stores
model or parameters errors that caused the model to be invalid.

string solution_info = 20;

Parameters

value

The solutionInfo to set.

Returns

This builder for chaining.

Definition at line 4005 of file CpSolverResponse.java.

setSolutionInfoBytes()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setSolutionInfoBytes

(

com.google.protobuf.ByteString

value

)

Additional information about how the solution was found. It also stores
model or parameters errors that caused the model to be invalid.

string solution_info = 20;

Parameters

value

The bytes for solutionInfo to set.

Returns

This builder for chaining.

Definition at line 4038 of file CpSolverResponse.java.

setSolveLog()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setSolveLog

(

java.lang.String

value

)

The solve log will be filled if the parameter log_to_response is set to
true.

string solve_log = 26;

Parameters

value

The solveLog to set.

Returns

This builder for chaining.

Definition at line 4102 of file CpSolverResponse.java.

setSolveLogBytes()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setSolveLogBytes

(

com.google.protobuf.ByteString

value

)

The solve log will be filled if the parameter log_to_response is set to
true.

string solve_log = 26;

Parameters

value

The bytes for solveLog to set.

Returns

This builder for chaining.

Definition at line 4135 of file CpSolverResponse.java.

setStatus()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setStatus

(

com.google.ortools.sat.CpSolverStatus

value

)

The status of the solve.

.operations_research.sat.CpSolverStatus status = 1;

Parameters

value

The status to set.

Returns

This builder for chaining.

Definition at line 1875 of file CpSolverResponse.java.

setStatusValue()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setStatusValue

(

int

value

)

The status of the solve.

.operations_research.sat.CpSolverStatus status = 1;

Parameters

value

The enum numeric value on the wire for status to set.

Returns

This builder for chaining.

Definition at line 1847 of file CpSolverResponse.java.

setSufficientAssumptionsForInfeasibility()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setSufficientAssumptionsForInfeasibility	(	int	index,
		int	value )

A subset of the model "assumptions" field. This will only be filled if the
status is INFEASIBLE. This subset of assumption will be enough to still get
an infeasible problem.

This is related to what is called the irreducible inconsistent subsystem or
IIS. Except one is only concerned by the provided assumptions. There is
also no guarantee that we return an irreducible (aka minimal subset).
However, this is based on SAT explanation and there is a good chance it is
not too large.

If you really want a minimal subset, a possible way to get one is by
changing your model to minimize the number of assumptions at false, but
this is likely an harder problem to solve.

Important: Currently, this is minimized only in single-thread and if the
problem is not an optimization problem, otherwise, it will always include
all the assumptions.

TODO(user): Allows for returning multiple core at once.

repeated int32 sufficient_assumptions_for_infeasibility = 23;

Parameters

index	The index to set the value at.
value	The sufficientAssumptionsForInfeasibility to set.

Returns

This builder for chaining.

Definition at line 3172 of file CpSolverResponse.java.

setTightenedVariables() [1/2]

Builder com.google.ortools.sat.CpSolverResponse.Builder.setTightenedVariables	(	int	index,
		com.google.ortools.sat.IntegerVariableProto	value )

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2642 of file CpSolverResponse.java.

setTightenedVariables() [2/2]

Builder com.google.ortools.sat.CpSolverResponse.Builder.setTightenedVariables	(	int	index,
		com.google.ortools.sat.IntegerVariableProto.Builder	builderForValue )

Advanced usage.

If the option fill_tightened_domains_in_response is set, then this field
will be a copy of the CpModelProto.variables where each domain has been
reduced using the information the solver was able to derive. Note that this
is only filled with the info derived during a normal search and we do not
have any dedicated algorithm to improve it.

If the problem is a feasibility problem, then these bounds will be valid
for any feasible solution. If the problem is an optimization problem, then
these bounds will only be valid for any OPTIMAL solutions, it can exclude
sub-optimal feasible ones.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2674 of file CpSolverResponse.java.

setUnknownFields()

final Builder com.google.ortools.sat.CpSolverResponse.Builder.setUnknownFields

(

final com.google.protobuf.UnknownFieldSet

unknownFields

)

Definition at line 4145 of file CpSolverResponse.java.

setUserTime()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setUserTime

(

double

value

)

double user_time = 16;

Parameters

value

The userTime to set.

Returns

This builder for chaining.

Definition at line 3857 of file CpSolverResponse.java.

setWallTime()

Builder com.google.ortools.sat.CpSolverResponse.Builder.setWallTime

(

double

value

)

The time counted from the beginning of the Solve() call.

double wall_time = 15;

Parameters

value

The wallTime to set.

Returns

This builder for chaining.

Definition at line 3821 of file CpSolverResponse.java.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/sat/CpSolverResponse.java