Class IntegerVariableProto

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.sat.IntegerVariableProto
All Implemented Interfaces:
IntegerVariableProtoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class IntegerVariableProto extends com.google.protobuf.GeneratedMessage implements IntegerVariableProtoOrBuilder
 An integer variable.

 It will be referred to by an int32 corresponding to its index in a
 CpModelProto variables field.

 Depending on the context, a reference to a variable whose domain is in [0, 1]
 can also be seen as a Boolean that will be true if the variable value is 1
 and false if it is 0. When used in this context, the field name will always
 contain the word "literal".

 Negative reference (advanced usage): to simplify the creation of a model and
 for efficiency reasons, all the "literal" or "variable" fields can also
 contain a negative index. A negative index i will refer to the negation of
 the integer variable at index -i -1 or to NOT the literal at the same index.

 Ex: A variable index 4 will refer to the integer variable model.variables(4)
 and an index of -5 will refer to the negation of the same variable. A literal
 index 4 will refer to the logical fact that model.variable(4) == 1 and a
 literal index of -5 will refer to the logical fact model.variable(4) == 0.
Protobuf type operations_research.sat.IntegerVariableProto
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    IntegerVariableProto.Builder
    An integer variable.

    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
    DOMAIN_FIELD_NUMBER
     
    static final int
    NAME_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 IntegerVariableProto
    getDefaultInstance()
     
    IntegerVariableProto
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getDomain(int index)
    The variable domain given as a sorted list of n disjoint intervals [min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].
    int
    getDomainCount()
    The variable domain given as a sorted list of n disjoint intervals [min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].
    List<Long>
    getDomainList()
    The variable domain given as a sorted list of n disjoint intervals [min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].
    String
    getName()
    For debug/logging only.
    com.google.protobuf.ByteString
    getNameBytes()
    For debug/logging only.
    com.google.protobuf.Parser<IntegerVariableProto>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static IntegerVariableProto.Builder
    newBuilder()
     
    static IntegerVariableProto.Builder
    newBuilder(IntegerVariableProto prototype)
     
    IntegerVariableProto.Builder
    newBuilderForType()
     
    protected IntegerVariableProto.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static IntegerVariableProto
    parseDelimitedFrom(InputStream input)
     
    static IntegerVariableProto
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IntegerVariableProto
    parseFrom(byte[] data)
     
    static IntegerVariableProto
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IntegerVariableProto
    parseFrom(com.google.protobuf.ByteString data)
     
    static IntegerVariableProto
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IntegerVariableProto
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static IntegerVariableProto
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IntegerVariableProto
    parseFrom(InputStream input)
     
    static IntegerVariableProto
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static IntegerVariableProto
    parseFrom(ByteBuffer data)
     
    static IntegerVariableProto
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<IntegerVariableProto>
    parser()
     
    IntegerVariableProto.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

    • getName

      public String getName()
       For debug/logging only. Can be empty.
      string name = 1;
      Specified by:
      getName in interface IntegerVariableProtoOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       For debug/logging only. Can be empty.
      string name = 1;
      Specified by:
      getNameBytes in interface IntegerVariableProtoOrBuilder
      Returns:
      The bytes for name.

    • getDomainList

      public List<Long> getDomainList()
       The variable domain given as a sorted list of n disjoint intervals
 [min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].

 The most common example being just [min, max].
 If min == max, then this is a constant variable.

 We have:
 - domain_size() is always even.
 - min == domain.front();
 - max == domain.back();
 - for all i < n   :      min_i <= max_i
 - for all i < n-1 :  max_i + 1 < min_{i+1}.

 Note that we check at validation that a variable domain is small enough so
 that we don't run into integer overflow in our algorithms. Because of that,
 you cannot just have "unbounded" variable like [0, kint64max] and should
 try to specify tighter domains.
      repeated int64 domain = 2;
      Specified by:
      getDomainList in interface IntegerVariableProtoOrBuilder
      Returns:
      A list containing the domain.

    • getDomainCount

      public int getDomainCount()
       The variable domain given as a sorted list of n disjoint intervals
 [min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].

 The most common example being just [min, max].
 If min == max, then this is a constant variable.

 We have:
 - domain_size() is always even.
 - min == domain.front();
 - max == domain.back();
 - for all i < n   :      min_i <= max_i
 - for all i < n-1 :  max_i + 1 < min_{i+1}.

 Note that we check at validation that a variable domain is small enough so
 that we don't run into integer overflow in our algorithms. Because of that,
 you cannot just have "unbounded" variable like [0, kint64max] and should
 try to specify tighter domains.
      repeated int64 domain = 2;
      Specified by:
      getDomainCount in interface IntegerVariableProtoOrBuilder
      Returns:
      The count of domain.

    • getDomain

      public long getDomain(int index)
       The variable domain given as a sorted list of n disjoint intervals
 [min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].

 The most common example being just [min, max].
 If min == max, then this is a constant variable.

 We have:
 - domain_size() is always even.
 - min == domain.front();
 - max == domain.back();
 - for all i < n   :      min_i <= max_i
 - for all i < n-1 :  max_i + 1 < min_{i+1}.

 Note that we check at validation that a variable domain is small enough so
 that we don't run into integer overflow in our algorithms. Because of that,
 you cannot just have "unbounded" variable like [0, kint64max] and should
 try to specify tighter domains.
      repeated int64 domain = 2;
      Specified by:
      getDomain in interface IntegerVariableProtoOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The domain 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 IntegerVariableProto parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static IntegerVariableProto.Builder newBuilder()

    • newBuilder

      public static IntegerVariableProto.Builder newBuilder(IntegerVariableProto prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static IntegerVariableProto getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<IntegerVariableProto> 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 IntegerVariableProto getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder