Class MPSosConstraint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.linearsolver.MPSosConstraint
All Implemented Interfaces:
MPSosConstraintOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MPSosConstraint extends com.google.protobuf.GeneratedMessage implements MPSosConstraintOrBuilder
 Special Ordered Set (SOS) constraints of type 1 or 2.
 See https://en.wikipedia.org/wiki/Special_ordered_set
 As of 2019/04, only SCIP and Gurobi support this constraint type.
Protobuf type operations_research.MPSosConstraint
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MPSosConstraint.Builder
    Special Ordered Set (SOS) constraints of type 1 or 2.
    static enum 
    MPSosConstraint.Type
    Protobuf enum operations_research.MPSosConstraint.Type

    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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    TYPE_FIELD_NUMBER
     
    static final int
    VAR_INDEX_FIELD_NUMBER
     
    static final int
    WEIGHT_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

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static MPSosConstraint
    getDefaultInstance()
     
    MPSosConstraint
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<MPSosConstraint>
    getParserForType()
     
    int
    getSerializedSize()
     
    MPSosConstraint.Type
    getType()
    optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT];
    int
    getVarIndex(int index)
    Variable index (w.r.t. the "variable" field of MPModelProto) of the variables in the SOS.
    int
    getVarIndexCount()
    Variable index (w.r.t. the "variable" field of MPModelProto) of the variables in the SOS.
    List<Integer>
    getVarIndexList()
    Variable index (w.r.t. the "variable" field of MPModelProto) of the variables in the SOS.
    double
    getWeight(int index)
    Optional: SOS weights.
    int
    getWeightCount()
    Optional: SOS weights.
    List<Double>
    getWeightList()
    Optional: SOS weights.
    int
    hashCode()
     
    boolean
    hasType()
    optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT];
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MPSosConstraint.Builder
    newBuilder()
     
    static MPSosConstraint.Builder
    newBuilder(MPSosConstraint prototype)
     
    MPSosConstraint.Builder
    newBuilderForType()
     
    protected MPSosConstraint.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static MPSosConstraint
    parseDelimitedFrom(InputStream input)
     
    static MPSosConstraint
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPSosConstraint
    parseFrom(byte[] data)
     
    static MPSosConstraint
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPSosConstraint
    parseFrom(com.google.protobuf.ByteString data)
     
    static MPSosConstraint
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPSosConstraint
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MPSosConstraint
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPSosConstraint
    parseFrom(InputStream input)
     
    static MPSosConstraint
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MPSosConstraint
    parseFrom(ByteBuffer data)
     
    static MPSosConstraint
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MPSosConstraint>
    parser()
     
    MPSosConstraint.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.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 Details

  • Method Details

    • 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

    • hasType

      public boolean hasType()
      optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT];
      Specified by:
      hasType in interface MPSosConstraintOrBuilder
      Returns:
      Whether the type field is set.

    • getType

      public MPSosConstraint.Type getType()
      optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT];
      Specified by:
      getType in interface MPSosConstraintOrBuilder
      Returns:
      The type.

    • getVarIndexList

      public List<Integer> getVarIndexList()
       Variable index (w.r.t. the "variable" field of MPModelProto) of the
 variables in the SOS.
      repeated int32 var_index = 2;
      Specified by:
      getVarIndexList in interface MPSosConstraintOrBuilder
      Returns:
      A list containing the varIndex.

    • getVarIndexCount

      public int getVarIndexCount()
       Variable index (w.r.t. the "variable" field of MPModelProto) of the
 variables in the SOS.
      repeated int32 var_index = 2;
      Specified by:
      getVarIndexCount in interface MPSosConstraintOrBuilder
      Returns:
      The count of varIndex.

    • getVarIndex

      public int getVarIndex(int index)
       Variable index (w.r.t. the "variable" field of MPModelProto) of the
 variables in the SOS.
      repeated int32 var_index = 2;
      Specified by:
      getVarIndex in interface MPSosConstraintOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The varIndex at the given index.

    • getWeightList

      public List<Double> getWeightList()
       Optional: SOS weights. If non-empty, must be of the same size as
 "var_index", and strictly increasing. If empty and required by the
 underlying solver, the 1..n sequence will be given as weights.
 SUBTLE: The weights can help the solver make branch-and-bound decisions
 that fit the underlying optimization model: after each LP relaxation, it
 will compute the "average weight" of the SOS variables, weighted by value
 (this is confusing: here we're using the values as weights), and the binary
 branch decision will be: is the non-zero variable above or below that?
 (weights are strictly monotonous, so the "cutoff" average weight
 corresponds to a "cutoff" index in the var_index sequence).
      repeated double weight = 3;
      Specified by:
      getWeightList in interface MPSosConstraintOrBuilder
      Returns:
      A list containing the weight.

    • getWeightCount

      public int getWeightCount()
       Optional: SOS weights. If non-empty, must be of the same size as
 "var_index", and strictly increasing. If empty and required by the
 underlying solver, the 1..n sequence will be given as weights.
 SUBTLE: The weights can help the solver make branch-and-bound decisions
 that fit the underlying optimization model: after each LP relaxation, it
 will compute the "average weight" of the SOS variables, weighted by value
 (this is confusing: here we're using the values as weights), and the binary
 branch decision will be: is the non-zero variable above or below that?
 (weights are strictly monotonous, so the "cutoff" average weight
 corresponds to a "cutoff" index in the var_index sequence).
      repeated double weight = 3;
      Specified by:
      getWeightCount in interface MPSosConstraintOrBuilder
      Returns:
      The count of weight.

    • getWeight

      public double getWeight(int index)
       Optional: SOS weights. If non-empty, must be of the same size as
 "var_index", and strictly increasing. If empty and required by the
 underlying solver, the 1..n sequence will be given as weights.
 SUBTLE: The weights can help the solver make branch-and-bound decisions
 that fit the underlying optimization model: after each LP relaxation, it
 will compute the "average weight" of the SOS variables, weighted by value
 (this is confusing: here we're using the values as weights), and the binary
 branch decision will be: is the non-zero variable above or below that?
 (weights are strictly monotonous, so the "cutoff" average weight
 corresponds to a "cutoff" index in the var_index sequence).
      repeated double weight = 3;
      Specified by:
      getWeight in interface MPSosConstraintOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The weight at the given index.

    • isInitialized

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

    • writeTo

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

    • getSerializedSize

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

    • equals

      public boolean equals(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 MPSosConstraint parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MPSosConstraint parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static MPSosConstraint parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPSosConstraint parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MPSosConstraint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MPSosConstraint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPSosConstraint parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MPSosConstraint parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static MPSosConstraint.Builder newBuilder()

    • newBuilder

      public static MPSosConstraint.Builder newBuilder(MPSosConstraint prototype)

    • toBuilder

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

    • newBuilderForType

      protected MPSosConstraint.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MPSosConstraint getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<MPSosConstraint> 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.GeneratedMessage

    • getDefaultInstanceForType

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