CpSolverResponse (com.google.ortools:ortools-java 9.12.9999 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.google.ortools.sat.CpSolverResponse

All Implemented Interfaces:

CpSolverResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
```
public final class CpSolverResponse
extends com.google.protobuf.GeneratedMessage
implements CpSolverResponseOrBuilder
```
```
 The response returned by a solver trying to solve a CpModelProto.

 Next id: 32
 
```
Protobuf type operations_research.sat.CpSolverResponse
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CpSolverResponse.Builder
The response returned by a solver trying to solve a CpModelProto.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
  com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
  com.google.protobuf.AbstractMessage.BuilderParent
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`CpSolverResponse.Builder` The response returned by a solver trying to solve a CpModelProto.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADDITIONAL_SOLUTIONS_FIELD_NUMBER`
`static int`	`BEST_OBJECTIVE_BOUND_FIELD_NUMBER`
`static int`	`DETERMINISTIC_TIME_FIELD_NUMBER`
`static int`	`GAP_INTEGRAL_FIELD_NUMBER`
`static int`	`INNER_OBJECTIVE_LOWER_BOUND_FIELD_NUMBER`
`static int`	`INTEGER_OBJECTIVE_FIELD_NUMBER`
`static int`	`NUM_BINARY_PROPAGATIONS_FIELD_NUMBER`
`static int`	`NUM_BOOLEANS_FIELD_NUMBER`
`static int`	`NUM_BRANCHES_FIELD_NUMBER`
`static int`	`NUM_CONFLICTS_FIELD_NUMBER`
`static int`	`NUM_FIXED_BOOLEANS_FIELD_NUMBER`
`static int`	`NUM_INTEGER_PROPAGATIONS_FIELD_NUMBER`
`static int`	`NUM_INTEGERS_FIELD_NUMBER`
`static int`	`NUM_LP_ITERATIONS_FIELD_NUMBER`
`static int`	`NUM_RESTARTS_FIELD_NUMBER`
`static int`	`OBJECTIVE_VALUE_FIELD_NUMBER`
`static int`	`SOLUTION_FIELD_NUMBER`
`static int`	`SOLUTION_INFO_FIELD_NUMBER`
`static int`	`SOLVE_LOG_FIELD_NUMBER`
`static int`	`STATUS_FIELD_NUMBER`
`static int`	`SUFFICIENT_ASSUMPTIONS_FOR_INFEASIBILITY_FIELD_NUMBER`
`static int`	`TIGHTENED_VARIABLES_FIELD_NUMBER`
`static int`	`USER_TIME_FIELD_NUMBER`
`static int`	`WALL_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`CpSolverSolution`	`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.
`int`	`getAdditionalSolutionsCount()` If the parameter fill_additional_solutions_in_response is set, then we copy all the solutions from our internal solution pool here.
`java.util.List<CpSolverSolution>`	`getAdditionalSolutionsList()` If the parameter fill_additional_solutions_in_response is set, then we copy all the solutions from our internal solution pool here.
`CpSolverSolutionOrBuilder`	`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.
`java.util.List<? extends CpSolverSolutionOrBuilder>`	`getAdditionalSolutionsOrBuilderList()` If the parameter fill_additional_solutions_in_response is set, then we copy all the solutions from our internal solution pool here.
`double`	`getBestObjectiveBound()` Only make sense for an optimization problem.
`static CpSolverResponse`	`getDefaultInstance()`
`CpSolverResponse`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`double`	`getDeterministicTime()` `double deterministic_time = 17;`
`double`	`getGapIntegral()` The integral of log(1 + absolute_objective_gap) over time.
`long`	`getInnerObjectiveLowerBound()` Advanced usage.
`CpObjectiveProto`	`getIntegerObjective()` Contains the integer objective optimized internally.
`CpObjectiveProtoOrBuilder`	`getIntegerObjectiveOrBuilder()` Contains the integer objective optimized internally.
`long`	`getNumBinaryPropagations()` `int64 num_binary_propagations = 13;`
`long`	`getNumBooleans()` `int64 num_booleans = 10;`
`long`	`getNumBranches()` `int64 num_branches = 12;`
`long`	`getNumConflicts()` `int64 num_conflicts = 11;`
`long`	`getNumFixedBooleans()` `int64 num_fixed_booleans = 31;`
`long`	`getNumIntegerPropagations()` `int64 num_integer_propagations = 14;`
`long`	`getNumIntegers()` Some statistics about the solve.
`long`	`getNumLpIterations()` `int64 num_lp_iterations = 25;`
`long`	`getNumRestarts()` `int64 num_restarts = 24;`
`double`	`getObjectiveValue()` Only make sense for an optimization problem.
`com.google.protobuf.Parser<CpSolverResponse>`	`getParserForType()`
`int`	`getSerializedSize()`
`long`	`getSolution(int index)` A feasible solution to the given problem.
`int`	`getSolutionCount()` A feasible solution to the given problem.
`java.lang.String`	`getSolutionInfo()` Additional information about how the solution was found.
`com.google.protobuf.ByteString`	`getSolutionInfoBytes()` Additional information about how the solution was found.
`java.util.List<java.lang.Long>`	`getSolutionList()` A feasible solution to the given problem.
`java.lang.String`	`getSolveLog()` The solve log will be filled if the parameter log_to_response is set to true.
`com.google.protobuf.ByteString`	`getSolveLogBytes()` The solve log will be filled if the parameter log_to_response is set to true.
`CpSolverStatus`	`getStatus()` The status of the solve.
`int`	`getStatusValue()` The status of the solve.
`int`	`getSufficientAssumptionsForInfeasibility(int index)` A subset of the model "assumptions" field.
`int`	`getSufficientAssumptionsForInfeasibilityCount()` A subset of the model "assumptions" field.
`java.util.List<java.lang.Integer>`	`getSufficientAssumptionsForInfeasibilityList()` A subset of the model "assumptions" field.
`IntegerVariableProto`	`getTightenedVariables(int index)` Advanced usage.
`int`	`getTightenedVariablesCount()` Advanced usage.
`java.util.List<IntegerVariableProto>`	`getTightenedVariablesList()` Advanced usage.
`IntegerVariableProtoOrBuilder`	`getTightenedVariablesOrBuilder(int index)` Advanced usage.
`java.util.List<? extends IntegerVariableProtoOrBuilder>`	`getTightenedVariablesOrBuilderList()` Advanced usage.
`double`	`getUserTime()` `double user_time = 16;`
`double`	`getWallTime()` The time counted from the beginning of the Solve() call.
`int`	`hashCode()`
`boolean`	`hasIntegerObjective()` Contains the integer objective optimized internally.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static CpSolverResponse.Builder`	`newBuilder()`
`static CpSolverResponse.Builder`	`newBuilder(CpSolverResponse prototype)`
`CpSolverResponse.Builder`	`newBuilderForType()`
`protected CpSolverResponse.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static CpSolverResponse`	`parseDelimitedFrom(java.io.InputStream input)`
`static CpSolverResponse`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CpSolverResponse`	`parseFrom(byte[] data)`
`static CpSolverResponse`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CpSolverResponse`	`parseFrom(java.nio.ByteBuffer data)`
`static CpSolverResponse`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CpSolverResponse`	`parseFrom(com.google.protobuf.ByteString data)`
`static CpSolverResponse`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CpSolverResponse`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static CpSolverResponse`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CpSolverResponse`	`parseFrom(java.io.InputStream input)`
`static CpSolverResponse`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<CpSolverResponse>`	`parser()`
`CpSolverResponse.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- STATUS_FIELD_NUMBER
```
public static final int STATUS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOLUTION_FIELD_NUMBER
```
public static final int SOLUTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OBJECTIVE_VALUE_FIELD_NUMBER
```
public static final int OBJECTIVE_VALUE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BEST_OBJECTIVE_BOUND_FIELD_NUMBER
```
public static final int BEST_OBJECTIVE_BOUND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ADDITIONAL_SOLUTIONS_FIELD_NUMBER
```
public static final int ADDITIONAL_SOLUTIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TIGHTENED_VARIABLES_FIELD_NUMBER
```
public static final int TIGHTENED_VARIABLES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SUFFICIENT_ASSUMPTIONS_FOR_INFEASIBILITY_FIELD_NUMBER
```
public static final int SUFFICIENT_ASSUMPTIONS_FOR_INFEASIBILITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INTEGER_OBJECTIVE_FIELD_NUMBER
```
public static final int INTEGER_OBJECTIVE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INNER_OBJECTIVE_LOWER_BOUND_FIELD_NUMBER
```
public static final int INNER_OBJECTIVE_LOWER_BOUND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_INTEGERS_FIELD_NUMBER
```
public static final int NUM_INTEGERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_BOOLEANS_FIELD_NUMBER
```
public static final int NUM_BOOLEANS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_FIXED_BOOLEANS_FIELD_NUMBER
```
public static final int NUM_FIXED_BOOLEANS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_CONFLICTS_FIELD_NUMBER
```
public static final int NUM_CONFLICTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_BRANCHES_FIELD_NUMBER
```
public static final int NUM_BRANCHES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_BINARY_PROPAGATIONS_FIELD_NUMBER
```
public static final int NUM_BINARY_PROPAGATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_INTEGER_PROPAGATIONS_FIELD_NUMBER
```
public static final int NUM_INTEGER_PROPAGATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_RESTARTS_FIELD_NUMBER
```
public static final int NUM_RESTARTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NUM_LP_ITERATIONS_FIELD_NUMBER
```
public static final int NUM_LP_ITERATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WALL_TIME_FIELD_NUMBER
```
public static final int WALL_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USER_TIME_FIELD_NUMBER
```
public static final int USER_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DETERMINISTIC_TIME_FIELD_NUMBER
```
public static final int DETERMINISTIC_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- GAP_INTEGRAL_FIELD_NUMBER
```
public static final int GAP_INTEGRAL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOLUTION_INFO_FIELD_NUMBER
```
public static final int SOLUTION_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOLVE_LOG_FIELD_NUMBER
```
public static final int SOLVE_LOG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getDescriptor

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

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getStatusValue
```
public int getStatusValue()
```
```
 The status of the solve.
 
```
.operations_research.sat.CpSolverStatus status = 1;
Specified by:

getStatusValue in interface CpSolverResponseOrBuilder

Returns:

The enum numeric value on the wire for status.

getStatus
```
public CpSolverStatus getStatus()
```
```
 The status of the solve.
 
```
.operations_research.sat.CpSolverStatus status = 1;
Specified by:

getStatus in interface CpSolverResponseOrBuilder

Returns:

The status.

getSolutionList

public java.util.List<java.lang.Long> 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;

Specified by:: getSolutionList in interface CpSolverResponseOrBuilder
Returns:: A list containing the solution.

getSolutionCount

public int 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;

Specified by:: getSolutionCount in interface CpSolverResponseOrBuilder
Returns:: The count of solution.

getSolution

public long 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;

Specified by:: getSolution in interface CpSolverResponseOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The solution at the given index.

getObjectiveValue

public double 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;

Specified by:: getObjectiveValue in interface CpSolverResponseOrBuilder
Returns:: The objectiveValue.

getBestObjectiveBound

public double 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;

Specified by:: getBestObjectiveBound in interface CpSolverResponseOrBuilder
Returns:: The bestObjectiveBound.

getAdditionalSolutionsList

public java.util.List<CpSolverSolution> 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;

Specified by:: getAdditionalSolutionsList in interface CpSolverResponseOrBuilder

getAdditionalSolutionsOrBuilderList

public java.util.List<? extends CpSolverSolutionOrBuilder> 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;

Specified by:: getAdditionalSolutionsOrBuilderList in interface CpSolverResponseOrBuilder

getAdditionalSolutionsCount

public int 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;

Specified by:: getAdditionalSolutionsCount in interface CpSolverResponseOrBuilder

getAdditionalSolutions

public CpSolverSolution 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;

Specified by:: getAdditionalSolutions in interface CpSolverResponseOrBuilder

getAdditionalSolutionsOrBuilder

public CpSolverSolutionOrBuilder 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;

Specified by:: getAdditionalSolutionsOrBuilder in interface CpSolverResponseOrBuilder