Package com.google.ortools.linearsolver

Class MPVariableProto

  • All Implemented Interfaces:
    MPVariableProtoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class MPVariableProto
extends com.google.protobuf.GeneratedMessageV3
implements MPVariableProtoOrBuilder
     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 type operations_research.MPVariableProto
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MPVariableProto.Builder
      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.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      int getBranchingPriority()
      optional int32 branching_priority = 6 [default = 0];
      static MPVariableProto getDefaultInstance()  
      MPVariableProto getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getIsInteger()
      True if the variable is constrained to be integer.
      double getLowerBound()
      lower_bound must be <= upper_bound.
      java.lang.String getName()
      The name of the variable.
      com.google.protobuf.ByteString getNameBytes()
      The name of the variable.
      double getObjectiveCoefficient()
      The coefficient of the variable in the objective.
      com.google.protobuf.Parser<MPVariableProto> getParserForType()  
      int getSerializedSize()  
      double getUpperBound()
      optional double upper_bound = 2 [default = inf];
      boolean hasBranchingPriority()
      optional int32 branching_priority = 6 [default = 0];
      int hashCode()  
      boolean hasIsInteger()
      True if the variable is constrained to be integer.
      boolean hasLowerBound()
      lower_bound must be <= upper_bound.
      boolean hasName()
      The name of the variable.
      boolean hasObjectiveCoefficient()
      The coefficient of the variable in the objective.
      boolean hasUpperBound()
      optional double upper_bound = 2 [default = inf];
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MPVariableProto.Builder newBuilder()  
      static MPVariableProto.Builder newBuilder​(MPVariableProto prototype)  
      MPVariableProto.Builder newBuilderForType()  
      protected MPVariableProto.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static MPVariableProto parseDelimitedFrom​(java.io.InputStream input)  
      static MPVariableProto parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MPVariableProto parseFrom​(byte[] data)  
      static MPVariableProto parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MPVariableProto parseFrom​(com.google.protobuf.ByteString data)  
      static MPVariableProto parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MPVariableProto parseFrom​(com.google.protobuf.CodedInputStream input)  
      static MPVariableProto parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MPVariableProto parseFrom​(java.io.InputStream input)  
      static MPVariableProto parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MPVariableProto parseFrom​(java.nio.ByteBuffer data)  
      static MPVariableProto parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<MPVariableProto> parser()  
      MPVariableProto.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • LOWER_BOUND_FIELD_NUMBER

        public static final int LOWER_BOUND_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPPER_BOUND_FIELD_NUMBER

        public static final int UPPER_BOUND_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OBJECTIVE_COEFFICIENT_FIELD_NUMBER

        public static final int OBJECTIVE_COEFFICIENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_INTEGER_FIELD_NUMBER

        public static final int IS_INTEGER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BRANCHING_PRIORITY_FIELD_NUMBER

        public static final int BRANCHING_PRIORITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARSER

        @Deprecated
public static final com.google.protobuf.Parser<MPVariableProto> PARSER
        Deprecated.

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • hasLowerBound

        public boolean hasLowerBound()
         lower_bound must be <= upper_bound.
        optional double lower_bound = 1 [default = -inf];
        Specified by:
        hasLowerBound in interface MPVariableProtoOrBuilder
        Returns:
        Whether the lowerBound field is set.

      • getLowerBound

        public double getLowerBound()
         lower_bound must be <= upper_bound.
        optional double lower_bound = 1 [default = -inf];
        Specified by:
        getLowerBound in interface MPVariableProtoOrBuilder
        Returns:
        The lowerBound.

      • hasUpperBound

        public boolean hasUpperBound()
        optional double upper_bound = 2 [default = inf];
        Specified by:
        hasUpperBound in interface MPVariableProtoOrBuilder
        Returns:
        Whether the upperBound field is set.

      • getUpperBound

        public double getUpperBound()
        optional double upper_bound = 2 [default = inf];
        Specified by:
        getUpperBound in interface MPVariableProtoOrBuilder
        Returns:
        The upperBound.

      • hasObjectiveCoefficient

        public boolean hasObjectiveCoefficient()
         The coefficient of the variable in the objective. Must be finite.
        optional double objective_coefficient = 3 [default = 0];
        Specified by:
        hasObjectiveCoefficient in interface MPVariableProtoOrBuilder
        Returns:
        Whether the objectiveCoefficient field is set.

      • getObjectiveCoefficient

        public double getObjectiveCoefficient()
         The coefficient of the variable in the objective. Must be finite.
        optional double objective_coefficient = 3 [default = 0];
        Specified by:
        getObjectiveCoefficient in interface MPVariableProtoOrBuilder
        Returns:
        The objectiveCoefficient.

      • hasIsInteger

        public boolean hasIsInteger()
         True if the variable is constrained to be integer.
 Ignored if MPModelProto::solver_type is *LINEAR_PROGRAMMING*.
        optional bool is_integer = 4 [default = false];
        Specified by:
        hasIsInteger in interface MPVariableProtoOrBuilder
        Returns:
        Whether the isInteger field is set.

      • getIsInteger

        public boolean getIsInteger()
         True if the variable is constrained to be integer.
 Ignored if MPModelProto::solver_type is *LINEAR_PROGRAMMING*.
        optional bool is_integer = 4 [default = false];
        Specified by:
        getIsInteger in interface MPVariableProtoOrBuilder
        Returns:
        The isInteger.

      • hasName

        public boolean hasName()
         The name of the variable.
        optional string name = 5 [default = ""];
        Specified by:
        hasName in interface MPVariableProtoOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         The name of the variable.
        optional string name = 5 [default = ""];
        Specified by:
        getName in interface MPVariableProtoOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the variable.
        optional string name = 5 [default = ""];
        Specified by:
        getNameBytes in interface MPVariableProtoOrBuilder
        Returns:
        The bytes for name.

      • hasBranchingPriority

        public boolean hasBranchingPriority()
        optional int32 branching_priority = 6 [default = 0];
        Specified by:
        hasBranchingPriority in interface MPVariableProtoOrBuilder
        Returns:
        Whether the branchingPriority field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static MPVariableProto parseFrom​(java.nio.ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MPVariableProto parseFrom​(java.nio.ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MPVariableProto parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MPVariableProto parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MPVariableProto parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MPVariableProto parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MPVariableProto parseFrom​(java.io.InputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MPVariableProto parseFrom​(java.io.InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static MPVariableProto parseDelimitedFrom​(java.io.InputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static MPVariableProto parseDelimitedFrom​(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MPVariableProto parseFrom​(com.google.protobuf.CodedInputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static MPVariableProto parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public MPVariableProto.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public MPVariableProto.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected MPVariableProto.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<MPVariableProto> parser()

      • getParserForType

        public com.google.protobuf.Parser<MPVariableProto> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public MPVariableProto getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder