Java Reference

Java Reference

MPSolutionResponse

Detailed Description

Protobuf type.

operations_research.MPSolutionResponse

Definition at line 9 of file MPSolutionResponse.java.

Classes

class  Builder
 Protobuf type. More...
 

Public Member Functions

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ()
 
.lang.Override boolean hasStatus ()
 
.lang.Override com.google.ortools.linearsolver.MPSolverResponseStatus getStatus ()
 
.lang.Override boolean hasStatusStr ()
 
.lang.Override java.lang.String getStatusStr ()
 
.lang.Override com.google.protobuf.ByteString getStatusStrBytes ()
 
.lang.Override boolean hasObjectiveValue ()
 
.lang.Override double getObjectiveValue ()
 
.lang.Override boolean hasBestObjectiveBound ()
 
.lang.Override double getBestObjectiveBound ()
 
.lang.Override java.util.List< java.lang.Double > getVariableValueList ()
 
int getVariableValueCount ()
 
double getVariableValue (int index)
 
.lang.Override java.util.List< java.lang.Double > getDualValueList ()
 
int getDualValueCount ()
 
double getDualValue (int index)
 
.lang.Override java.util.List< java.lang.Double > getReducedCostList ()
 
int getReducedCostCount ()
 
double getReducedCost (int index)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
 
.lang.Override int getSerializedSize ()
 
.lang.Override boolean equals (final java.lang.Object obj)
 
.lang.Override int hashCode ()
 
.lang.Override Builder newBuilderForType ()
 
.lang.Override Builder toBuilder ()
 
.lang.Override com.google.protobuf.Parser< MPSolutionResponsegetParserForType ()
 
.lang.Override com.google.ortools.linearsolver.MPSolutionResponse getDefaultInstanceForType ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPSolutionResponse parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static Builder newBuilder ()
 
static Builder newBuilder (com.google.ortools.linearsolver.MPSolutionResponse prototype)
 
static com.google.ortools.linearsolver.MPSolutionResponse getDefaultInstance ()
 
static com.google.protobuf.Parser< MPSolutionResponseparser ()
 

Static Public Attributes

static final int STATUS_FIELD_NUMBER = 1
 
static final int STATUS_STR_FIELD_NUMBER = 7
 
static final int OBJECTIVE_VALUE_FIELD_NUMBER = 2
 
static final int BEST_OBJECTIVE_BOUND_FIELD_NUMBER = 5
 
static final int VARIABLE_VALUE_FIELD_NUMBER = 3
 
static final int DUAL_VALUE_FIELD_NUMBER = 4
 
static final int REDUCED_COST_FIELD_NUMBER = 6
 
.lang.Deprecated static final com.google.protobuf.Parser< MPSolutionResponsePARSER
 

Protected Member Functions

.lang.Override java.lang.Object newInstance (UnusedPrivateParameter unused)
 
.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 
.lang.Override Builder newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
 

Member Function Documentation

◆ equals()

.lang.Override boolean equals ( final java.lang.Object  obj)
inline

Definition at line 619 of file MPSolutionResponse.java.

◆ getBestObjectiveBound()

.lang.Override double getBestObjectiveBound ( )
inline
This field is only filled for MIP problems. For a minimization problem,
this is a lower bound on the optimal objective value. For a maximization
problem, it is an upper bound. It is only filled if the status is OPTIMAL
or FEASIBLE. In the former case, best_objective_bound should be equal to
objective_value (modulo numerical errors).

optional double best_objective_bound = 5;

Returns
The bestObjectiveBound.

Implements MPSolutionResponseOrBuilder.

Definition at line 348 of file MPSolutionResponse.java.

◆ getDefaultInstance()

static com.google.ortools.linearsolver.MPSolutionResponse getDefaultInstance ( )
inlinestatic

Definition at line 1770 of file MPSolutionResponse.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.linearsolver.MPSolutionResponse getDefaultInstanceForType ( )
inline

Definition at line 1795 of file MPSolutionResponse.java.

◆ getDescriptor()

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

Definition at line 177 of file MPSolutionResponse.java.

◆ getDualValue()

double getDualValue ( int  index)
inline
[Advanced usage.]
Values of the dual variables values in the same order as the
MPModelProto::constraint field. This is a dense representation.
These are not set if the problem was solved with a MIP solver (even if
it is actually a linear program).
These are set iff 'status' is OPTIMAL or FEASIBLE.

repeated double dual_value = 4 [packed = true];

Parameters
indexThe index of the element to return.
Returns
The dualValue at the given index.

Implements MPSolutionResponseOrBuilder.

Definition at line 448 of file MPSolutionResponse.java.

◆ getDualValueCount()

int getDualValueCount ( )
inline
[Advanced usage.]
Values of the dual variables values in the same order as the
MPModelProto::constraint field. This is a dense representation.
These are not set if the problem was solved with a MIP solver (even if
it is actually a linear program).
These are set iff 'status' is OPTIMAL or FEASIBLE.

repeated double dual_value = 4 [packed = true];

Returns
The count of dualValue.

Implements MPSolutionResponseOrBuilder.

Definition at line 431 of file MPSolutionResponse.java.

◆ getDualValueList()

.lang.Override java.util.List<java.lang.Double> getDualValueList ( )
inline
[Advanced usage.]
Values of the dual variables values in the same order as the
MPModelProto::constraint field. This is a dense representation.
These are not set if the problem was solved with a MIP solver (even if
it is actually a linear program).
These are set iff 'status' is OPTIMAL or FEASIBLE.

repeated double dual_value = 4 [packed = true];

Returns
A list containing the dualValue.

Implements MPSolutionResponseOrBuilder.

Definition at line 415 of file MPSolutionResponse.java.

◆ getObjectiveValue()

.lang.Override double getObjectiveValue ( )
inline
Objective value corresponding to the "variable_value" below, taking into
account the source "objective_offset" and "objective_coefficient".
This is set iff 'status' is OPTIMAL or FEASIBLE.

optional double objective_value = 2;

Returns
The objectiveValue.

Implements MPSolutionResponseOrBuilder.

Definition at line 313 of file MPSolutionResponse.java.

◆ getParserForType()

.lang.Override com.google.protobuf.Parser<MPSolutionResponse> getParserForType ( )
inline

Definition at line 1790 of file MPSolutionResponse.java.

◆ getReducedCost()

double getReducedCost ( int  index)
inline
[Advanced usage.]
Values of the reduced cost of the variables in the same order as the
MPModelProto::variable. This is a dense representation.
These are not set if the problem was solved with a MIP solver (even if it
is actually a linear program).
These are set iff 'status' is OPTIMAL or FEASIBLE.

repeated double reduced_cost = 6 [packed = true];

Parameters
indexThe index of the element to return.
Returns
The reducedCost at the given index.

Implements MPSolutionResponseOrBuilder.

Definition at line 503 of file MPSolutionResponse.java.

◆ getReducedCostCount()

int getReducedCostCount ( )
inline
[Advanced usage.]
Values of the reduced cost of the variables in the same order as the
MPModelProto::variable. This is a dense representation.
These are not set if the problem was solved with a MIP solver (even if it
is actually a linear program).
These are set iff 'status' is OPTIMAL or FEASIBLE.

repeated double reduced_cost = 6 [packed = true];

Returns
The count of reducedCost.

Implements MPSolutionResponseOrBuilder.

Definition at line 486 of file MPSolutionResponse.java.

◆ getReducedCostList()

.lang.Override java.util.List<java.lang.Double> getReducedCostList ( )
inline
[Advanced usage.]
Values of the reduced cost of the variables in the same order as the
MPModelProto::variable. This is a dense representation.
These are not set if the problem was solved with a MIP solver (even if it
is actually a linear program).
These are set iff 'status' is OPTIMAL or FEASIBLE.

repeated double reduced_cost = 6 [packed = true];

Returns
A list containing the reducedCost.

Implements MPSolutionResponseOrBuilder.

Definition at line 470 of file MPSolutionResponse.java.

◆ getSerializedSize()

.lang.Override int getSerializedSize ( )
inline

Definition at line 560 of file MPSolutionResponse.java.

◆ getStatus()

.lang.Override com.google.ortools.linearsolver.MPSolverResponseStatus getStatus ( )
inline
Result of the optimization.

optional .operations_research.MPSolverResponseStatus status = 1 [default = MPSOLVER_UNKNOWN_STATUS];

Returns
The status.

Implements MPSolutionResponseOrBuilder.

Definition at line 211 of file MPSolutionResponse.java.

◆ getStatusStr()

.lang.Override java.lang.String getStatusStr ( )
inline
Human-readable string giving more details about the status. For example,
when the status is MPSOLVER_INVALID_MODE, this can hold a description of
why the model is invalid.
This isn't always filled: don't depend on its value or even its presence.

optional string status_str = 7;

Returns
The statusStr.

Implements MPSolutionResponseOrBuilder.

Definition at line 246 of file MPSolutionResponse.java.

◆ getStatusStrBytes()

.lang.Override com.google.protobuf.ByteString getStatusStrBytes ( )
inline
Human-readable string giving more details about the status. For example,
when the status is MPSOLVER_INVALID_MODE, this can hold a description of
why the model is invalid.
This isn't always filled: don't depend on its value or even its presence.

optional string status_str = 7;

Returns
The bytes for statusStr.

Implements MPSolutionResponseOrBuilder.

Definition at line 273 of file MPSolutionResponse.java.

◆ getUnknownFields()

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ( )
inline

Definition at line 35 of file MPSolutionResponse.java.

◆ getVariableValue()

double getVariableValue ( int  index)
inline
Variable values in the same order as the MPModelProto::variable field.
This is a dense representation. These are set iff 'status' is OPTIMAL or
FEASIBLE.

repeated double variable_value = 3 [packed = true];

Parameters
indexThe index of the element to return.
Returns
The variableValue at the given index.

Implements MPSolutionResponseOrBuilder.

Definition at line 393 of file MPSolutionResponse.java.

◆ getVariableValueCount()

int getVariableValueCount ( )
inline
Variable values in the same order as the MPModelProto::variable field.
This is a dense representation. These are set iff 'status' is OPTIMAL or
FEASIBLE.

repeated double variable_value = 3 [packed = true];

Returns
The count of variableValue.

Implements MPSolutionResponseOrBuilder.

Definition at line 379 of file MPSolutionResponse.java.

◆ getVariableValueList()

.lang.Override java.util.List<java.lang.Double> getVariableValueList ( )
inline
Variable values in the same order as the MPModelProto::variable field.
This is a dense representation. These are set iff 'status' is OPTIMAL or
FEASIBLE.

repeated double variable_value = 3 [packed = true];

Returns
A list containing the variableValue.

Implements MPSolutionResponseOrBuilder.

Definition at line 366 of file MPSolutionResponse.java.

◆ hasBestObjectiveBound()

.lang.Override boolean hasBestObjectiveBound ( )
inline
This field is only filled for MIP problems. For a minimization problem,
this is a lower bound on the optimal objective value. For a maximization
problem, it is an upper bound. It is only filled if the status is OPTIMAL
or FEASIBLE. In the former case, best_objective_bound should be equal to
objective_value (modulo numerical errors).

optional double best_objective_bound = 5;

Returns
Whether the bestObjectiveBound field is set.

Implements MPSolutionResponseOrBuilder.

Definition at line 332 of file MPSolutionResponse.java.

◆ hashCode()

.lang.Override int hashCode ( )
inline

Definition at line 660 of file MPSolutionResponse.java.

◆ hasObjectiveValue()

.lang.Override boolean hasObjectiveValue ( )
inline
Objective value corresponding to the "variable_value" below, taking into
account the source "objective_offset" and "objective_coefficient".
This is set iff 'status' is OPTIMAL or FEASIBLE.

optional double objective_value = 2;

Returns
Whether the objectiveValue field is set.

Implements MPSolutionResponseOrBuilder.

Definition at line 299 of file MPSolutionResponse.java.

◆ hasStatus()

.lang.Override boolean hasStatus ( )
inline
Result of the optimization.

optional .operations_research.MPSolverResponseStatus status = 1 [default = MPSOLVER_UNKNOWN_STATUS];

Returns
Whether the status field is set.

Implements MPSolutionResponseOrBuilder.

Definition at line 200 of file MPSolutionResponse.java.

◆ hasStatusStr()

.lang.Override boolean hasStatusStr ( )
inline
Human-readable string giving more details about the status. For example,
when the status is MPSOLVER_INVALID_MODE, this can hold a description of
why the model is invalid.
This isn't always filled: don't depend on its value or even its presence.

optional string status_str = 7;

Returns
Whether the statusStr field is set.

Implements MPSolutionResponseOrBuilder.

Definition at line 231 of file MPSolutionResponse.java.

◆ internalGetFieldAccessorTable()

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ( )
inlineprotected

Definition at line 183 of file MPSolutionResponse.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 510 of file MPSolutionResponse.java.

◆ newBuilder() [1/2]

static Builder newBuilder ( )
inlinestatic

Definition at line 773 of file MPSolutionResponse.java.

◆ newBuilder() [2/2]

static Builder newBuilder ( com.google.ortools.linearsolver.MPSolutionResponse  prototype)
inlinestatic

Definition at line 776 of file MPSolutionResponse.java.

◆ newBuilderForType() [1/2]

.lang.Override Builder newBuilderForType ( )
inline

Definition at line 772 of file MPSolutionResponse.java.

◆ newBuilderForType() [2/2]

.lang.Override Builder newBuilderForType ( com.google.protobuf.GeneratedMessageV3.BuilderParent  parent)
inlineprotected

Definition at line 786 of file MPSolutionResponse.java.

◆ newInstance()

.lang.Override java.lang.Object newInstance ( UnusedPrivateParameter  unused)
inlineprotected

Definition at line 28 of file MPSolutionResponse.java.

◆ parseDelimitedFrom() [1/2]

static com.google.ortools.linearsolver.MPSolutionResponse parseDelimitedFrom ( java.io.InputStream  input) throws java.io.IOException
inlinestatic

Definition at line 745 of file MPSolutionResponse.java.

◆ parseDelimitedFrom() [2/2]

static com.google.ortools.linearsolver.MPSolutionResponse parseDelimitedFrom ( java.io.InputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inlinestatic

Definition at line 750 of file MPSolutionResponse.java.

◆ parseFrom() [1/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( byte[]  data) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 723 of file MPSolutionResponse.java.

◆ parseFrom() [2/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( byte[]  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 727 of file MPSolutionResponse.java.

◆ parseFrom() [3/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( com.google.protobuf.ByteString  data) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 712 of file MPSolutionResponse.java.

◆ parseFrom() [4/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( com.google.protobuf.ByteString  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 717 of file MPSolutionResponse.java.

◆ parseFrom() [5/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( com.google.protobuf.CodedInputStream  input) throws java.io.IOException
inlinestatic

Definition at line 757 of file MPSolutionResponse.java.

◆ parseFrom() [6/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inlinestatic

Definition at line 763 of file MPSolutionResponse.java.

◆ parseFrom() [7/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( java.io.InputStream  input) throws java.io.IOException
inlinestatic

Definition at line 733 of file MPSolutionResponse.java.

◆ parseFrom() [8/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( java.io.InputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inlinestatic

Definition at line 738 of file MPSolutionResponse.java.

◆ parseFrom() [9/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( java.nio.ByteBuffer  data) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 701 of file MPSolutionResponse.java.

◆ parseFrom() [10/10]

static com.google.ortools.linearsolver.MPSolutionResponse parseFrom ( java.nio.ByteBuffer  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 706 of file MPSolutionResponse.java.

◆ parser()

static com.google.protobuf.Parser<MPSolutionResponse> parser ( )
inlinestatic

Definition at line 1785 of file MPSolutionResponse.java.

◆ toBuilder()

.lang.Override Builder toBuilder ( )
inline

Definition at line 780 of file MPSolutionResponse.java.

◆ writeTo()

.lang.Override void writeTo ( com.google.protobuf.CodedOutputStream  output) throws java.io.IOException
inline

Definition at line 520 of file MPSolutionResponse.java.

Member Data Documentation

◆ BEST_OBJECTIVE_BOUND_FIELD_NUMBER

final int BEST_OBJECTIVE_BOUND_FIELD_NUMBER = 5
static

Definition at line 317 of file MPSolutionResponse.java.

◆ DUAL_VALUE_FIELD_NUMBER

final int DUAL_VALUE_FIELD_NUMBER = 4
static

Definition at line 398 of file MPSolutionResponse.java.

◆ OBJECTIVE_VALUE_FIELD_NUMBER

final int OBJECTIVE_VALUE_FIELD_NUMBER = 2
static

Definition at line 286 of file MPSolutionResponse.java.

◆ PARSER

.lang.Deprecated static final com.google.protobuf.Parser<MPSolutionResponse> PARSER
static
Initial value:
= new com.google.protobuf.AbstractParser<MPSolutionResponse>() {
@java.lang.Override
public MPSolutionResponse parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new MPSolutionResponse(input, extensionRegistry);
}
}

Definition at line 1775 of file MPSolutionResponse.java.

◆ REDUCED_COST_FIELD_NUMBER

final int REDUCED_COST_FIELD_NUMBER = 6
static

Definition at line 453 of file MPSolutionResponse.java.

◆ STATUS_FIELD_NUMBER

final int STATUS_FIELD_NUMBER = 1
static

Definition at line 190 of file MPSolutionResponse.java.

◆ STATUS_STR_FIELD_NUMBER

final int STATUS_STR_FIELD_NUMBER = 7
static

Definition at line 217 of file MPSolutionResponse.java.

◆ VARIABLE_VALUE_FIELD_NUMBER

final int VARIABLE_VALUE_FIELD_NUMBER = 3
static

Definition at line 352 of file MPSolutionResponse.java.


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