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	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)
Public Member Functions inherited from com.google.ortools.sat.CpSolverResponseOrBuilder

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

Protected Member Functions
com.google.protobuf.GeneratedMessage.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 1266 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 2255 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 2306 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 2280 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 2329 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 2475 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 2491 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 2352 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 1995 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 3305 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2854 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 1975 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 3270 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2717 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2788 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2752 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2821 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 3037 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 3063 of file CpSolverResponse.java.

build()

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

(

)

Definition at line 1359 of file CpSolverResponse.java.

buildPartial()

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

(

)

Definition at line 1368 of file CpSolverResponse.java.

clear()

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

(

)

Definition at line 1302 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 2376 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 2118 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 3962 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 4006 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 3574 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 3458 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 3758 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 3662 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 3726 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 3694 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 3790 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 3630 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 3854 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 3822 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 2068 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 2015 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 4084 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 4181 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 1882 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 3340 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2888 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 3930 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 3898 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 2187 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 2420 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 2509 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 2168 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 2149 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 2436 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 2456 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 2087 of file CpSolverResponse.java.

getDefaultInstanceForType()

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

(

)

Definition at line 1354 of file CpSolverResponse.java.

getDescriptor()

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

static

Definition at line 1271 of file CpSolverResponse.java.

getDescriptorForType()

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

(

)

Definition at line 1349 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 3943 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 3979 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 3537 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 3373 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 3477 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 3491 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 3739 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 3643 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 3707 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 3675 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 3771 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 3595 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 3835 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 3803 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 2035 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 1938 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 1923 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 4023 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 4045 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 1908 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 4120 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 4142 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 1852 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 1825 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 3203 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 3173 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 3143 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2619 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2952 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 3091 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2590 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2561 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 2978 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Implements com.google.ortools.sat.CpSolverResponseOrBuilder.

Definition at line 3008 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 3911 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 3871 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 3360 of file CpSolverResponse.java.

internalGetFieldAccessorTable()

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

protected

Definition at line 1277 of file CpSolverResponse.java.

isInitialized()

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

(

)

Definition at line 1624 of file CpSolverResponse.java.

mergeFrom() [1/3]

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

(

com.google.ortools.sat.CpSolverResponse

other

)

Definition at line 1481 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 1629 of file CpSolverResponse.java.

mergeFrom() [3/3]

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

(

com.google.protobuf.Message

other

)

Definition at line 1472 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 3431 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 2398 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2920 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 2206 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 2232 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 2101 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 3951 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 3991 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 3554 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 3389 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 3411 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 3747 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 3651 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 3715 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 3683 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 3779 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 3611 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 3843 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 3811 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 2050 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 1954 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 4067 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 4100 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 4164 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 4197 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 1865 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 1837 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 3234 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2648 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.

Warning: if you didn't set keep_all_feasible_solutions_in_presolve, then
these domains might exclude valid feasible solution. Otherwise for a
feasibility problem, all feasible solution should be there.

Warning: For an optimization problem, these will correspond to valid bounds
for the problem of finding an improving solution to the best one found so
far. It might be better to solve a feasibility version if one just want to
explore the feasible region.

repeated .operations_research.sat.IntegerVariableProto tightened_variables = 21;

Definition at line 2684 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 3919 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 3883 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