Java Reference
Java Reference
Detailed Description
A variable is always constrained in the form: lower_bound <= x <= upper_bound where lower_bound and upper_bound:
- Can form a singleton: x = constant = lower_bound = upper_bound.
- Can form a finite interval: lower_bound <= x <= upper_bound. (x is boxed.)
- Can form a semi-infinite interval.
- lower_bound = -infinity: x <= upper_bound.
- upper_bound = +infinity: x >= lower_bound.
- Can form the infinite interval: lower_bound = -infinity and
upper_bound = +infinity, x is free.
MPVariableProto furthermore stores:
- The coefficient of the variable in the objective.
- Whether the variable is integer.
Protobuf typeoperations_research.MPVariableProto
Definition at line 25 of file MPVariableProto.java.
Classes | |
| class | Builder |
Public Member Functions | |
| .lang.Override final com.google.protobuf.UnknownFieldSet | getUnknownFields () |
| .lang.Override boolean | hasLowerBound () |
| .lang.Override double | getLowerBound () |
| .lang.Override boolean | hasUpperBound () |
optional double upper_bound = 2 [default = inf]; More... | |
| .lang.Override double | getUpperBound () |
optional double upper_bound = 2 [default = inf]; More... | |
| .lang.Override boolean | hasObjectiveCoefficient () |
| .lang.Override double | getObjectiveCoefficient () |
| .lang.Override boolean | hasIsInteger () |
| .lang.Override boolean | getIsInteger () |
| .lang.Override boolean | hasName () |
| .lang.Override java.lang.String | getName () |
| .lang.Override com.google.protobuf.ByteString | getNameBytes () |
| .lang.Override boolean | hasBranchingPriority () |
optional int32 branching_priority = 6 [default = 0]; More... | |
| .lang.Override int | getBranchingPriority () |
optional int32 branching_priority = 6 [default = 0]; More... | |
| .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< MPVariableProto > | getParserForType () |
| .lang.Override com.google.ortools.linearsolver.MPVariableProto | getDefaultInstanceForType () |
Static Public Member Functions | |
| static final com.google.protobuf.Descriptors.Descriptor | getDescriptor () |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (java.io.InputStream input) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPVariableProto | parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPVariableProto | parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPVariableProto | parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException |
| static com.google.ortools.linearsolver.MPVariableProto | 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.MPVariableProto prototype) |
| static com.google.ortools.linearsolver.MPVariableProto | getDefaultInstance () |
| static com.google.protobuf.Parser< MPVariableProto > | parser () |
Static Public Attributes | |
| static final int | LOWER_BOUND_FIELD_NUMBER = 1 |
| static final int | UPPER_BOUND_FIELD_NUMBER = 2 |
| static final int | OBJECTIVE_COEFFICIENT_FIELD_NUMBER = 3 |
| static final int | IS_INTEGER_FIELD_NUMBER = 4 |
| static final int | NAME_FIELD_NUMBER = 5 |
| static final int | BRANCHING_PRIORITY_FIELD_NUMBER = 6 |
| .lang.Deprecated static final com.google.protobuf.Parser< MPVariableProto > | PARSER |
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()
|
inline |
Definition at line 386 of file MPVariableProto.java.
◆ getBranchingPriority()
|
inline |
optional int32 branching_priority = 6 [default = 0];
- Returns
- The branchingPriority.
Implements MPVariableProtoOrBuilder.
Definition at line 312 of file MPVariableProto.java.
◆ getDefaultInstance()
|
inlinestatic |
Definition at line 1155 of file MPVariableProto.java.
◆ getDefaultInstanceForType()
|
inline |
Definition at line 1180 of file MPVariableProto.java.
◆ getDescriptor()
|
inlinestatic |
Definition at line 122 of file MPVariableProto.java.
◆ getIsInteger()
|
inline |
True if the variable is constrained to be integer. Ignored if MPModelProto::solver_type is *LINEAR_PROGRAMMING*.
optional bool is_integer = 4 [default = false];
- Returns
- The isInteger.
Implements MPVariableProtoOrBuilder.
Definition at line 233 of file MPVariableProto.java.
◆ getLowerBound()
|
inline |
lower_bound must be <= upper_bound.
optional double lower_bound = 1 [default = -inf];
- Returns
- The lowerBound.
Implements MPVariableProtoOrBuilder.
Definition at line 158 of file MPVariableProto.java.
◆ getName()
|
inline |
The name of the variable.
optional string name = 5 [default = ""];
- Returns
- The name.
Implements MPVariableProtoOrBuilder.
Definition at line 260 of file MPVariableProto.java.
◆ getNameBytes()
|
inline |
The name of the variable.
optional string name = 5 [default = ""];
- Returns
- The bytes for name.
Implements MPVariableProtoOrBuilder.
Definition at line 284 of file MPVariableProto.java.
◆ getObjectiveCoefficient()
|
inline |
The coefficient of the variable in the objective. Must be finite.
optional double objective_coefficient = 3 [default = 0];
- Returns
- The objectiveCoefficient.
Implements MPVariableProtoOrBuilder.
Definition at line 204 of file MPVariableProto.java.
◆ getParserForType()
|
inline |
Definition at line 1175 of file MPVariableProto.java.
◆ getSerializedSize()
|
inline |
Definition at line 352 of file MPVariableProto.java.
◆ getUnknownFields()
|
inline |
Definition at line 49 of file MPVariableProto.java.
◆ getUpperBound()
|
inline |
optional double upper_bound = 2 [default = inf];
- Returns
- The upperBound.
Implements MPVariableProtoOrBuilder.
Definition at line 177 of file MPVariableProto.java.
◆ hasBranchingPriority()
|
inline |
optional int32 branching_priority = 6 [default = 0];
- Returns
- Whether the branchingPriority field is set.
Implements MPVariableProtoOrBuilder.
Definition at line 304 of file MPVariableProto.java.
◆ hashCode()
|
inline |
Definition at line 433 of file MPVariableProto.java.
◆ hasIsInteger()
|
inline |
True if the variable is constrained to be integer. Ignored if MPModelProto::solver_type is *LINEAR_PROGRAMMING*.
optional bool is_integer = 4 [default = false];
- Returns
- Whether the isInteger field is set.
Implements MPVariableProtoOrBuilder.
Definition at line 220 of file MPVariableProto.java.
◆ hasLowerBound()
|
inline |
lower_bound must be <= upper_bound.
optional double lower_bound = 1 [default = -inf];
- Returns
- Whether the lowerBound field is set.
Implements MPVariableProtoOrBuilder.
Definition at line 146 of file MPVariableProto.java.
◆ hasName()
|
inline |
The name of the variable.
optional string name = 5 [default = ""];
- Returns
- Whether the name field is set.
Implements MPVariableProtoOrBuilder.
Definition at line 248 of file MPVariableProto.java.
◆ hasObjectiveCoefficient()
|
inline |
The coefficient of the variable in the objective. Must be finite.
optional double objective_coefficient = 3 [default = 0];
- Returns
- Whether the objectiveCoefficient field is set.
Implements MPVariableProtoOrBuilder.
Definition at line 192 of file MPVariableProto.java.
◆ hasUpperBound()
|
inline |
optional double upper_bound = 2 [default = inf];
- Returns
- Whether the upperBound field is set.
Implements MPVariableProtoOrBuilder.
Definition at line 169 of file MPVariableProto.java.
◆ internalGetFieldAccessorTable()
|
inlineprotected |
Definition at line 128 of file MPVariableProto.java.
◆ isInitialized()
|
inline |
Definition at line 318 of file MPVariableProto.java.
◆ newBuilder() [1/2]
|
inlinestatic |
Definition at line 544 of file MPVariableProto.java.
◆ newBuilder() [2/2]
|
inlinestatic |
Definition at line 547 of file MPVariableProto.java.
◆ newBuilderForType() [1/2]
|
inline |
Definition at line 543 of file MPVariableProto.java.
◆ newBuilderForType() [2/2]
|
inlineprotected |
Definition at line 557 of file MPVariableProto.java.
◆ newInstance()
|
inlineprotected |
Definition at line 42 of file MPVariableProto.java.
◆ parseDelimitedFrom() [1/2]
|
inlinestatic |
Definition at line 516 of file MPVariableProto.java.
◆ parseDelimitedFrom() [2/2]
|
inlinestatic |
Definition at line 521 of file MPVariableProto.java.
◆ parseFrom() [1/10]
|
inlinestatic |
Definition at line 494 of file MPVariableProto.java.
◆ parseFrom() [2/10]
|
inlinestatic |
Definition at line 498 of file MPVariableProto.java.
◆ parseFrom() [3/10]
|
inlinestatic |
Definition at line 483 of file MPVariableProto.java.
◆ parseFrom() [4/10]
|
inlinestatic |
Definition at line 488 of file MPVariableProto.java.
◆ parseFrom() [5/10]
|
inlinestatic |
Definition at line 528 of file MPVariableProto.java.
◆ parseFrom() [6/10]
|
inlinestatic |
Definition at line 534 of file MPVariableProto.java.
◆ parseFrom() [7/10]
|
inlinestatic |
Definition at line 504 of file MPVariableProto.java.
◆ parseFrom() [8/10]
|
inlinestatic |
Definition at line 509 of file MPVariableProto.java.
◆ parseFrom() [9/10]
|
inlinestatic |
Definition at line 472 of file MPVariableProto.java.
◆ parseFrom() [10/10]
|
inlinestatic |
Definition at line 477 of file MPVariableProto.java.
◆ parser()
|
inlinestatic |
Definition at line 1170 of file MPVariableProto.java.
◆ toBuilder()
|
inline |
Definition at line 551 of file MPVariableProto.java.
◆ writeTo()
|
inline |
Definition at line 328 of file MPVariableProto.java.
Member Data Documentation
◆ BRANCHING_PRIORITY_FIELD_NUMBER
|
static |
Definition at line 297 of file MPVariableProto.java.
◆ IS_INTEGER_FIELD_NUMBER
|
static |
Definition at line 208 of file MPVariableProto.java.
◆ LOWER_BOUND_FIELD_NUMBER
|
static |
Definition at line 135 of file MPVariableProto.java.
◆ NAME_FIELD_NUMBER
|
static |
Definition at line 237 of file MPVariableProto.java.
◆ OBJECTIVE_COEFFICIENT_FIELD_NUMBER
|
static |
Definition at line 181 of file MPVariableProto.java.
◆ PARSER
|
static |
Definition at line 1160 of file MPVariableProto.java.
◆ UPPER_BOUND_FIELD_NUMBER
|
static |
Definition at line 162 of file MPVariableProto.java.
The documentation for this class was generated from the following file: