Class SymmetryProto

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.sat.SymmetryProto
All Implemented Interfaces:
SymmetryProtoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SymmetryProto extends com.google.protobuf.GeneratedMessage implements SymmetryProtoOrBuilder
 EXPERIMENTAL. For now, this is meant to be used by the solver and not filled
 by clients.

 Hold symmetry information about the set of feasible solutions. If we permute
 the variable values of any feasible solution using one of the permutation
 described here, we should always get another feasible solution.

 We usually also enforce that the objective of the new solution is the same.

 The group of permutations encoded here is usually computed from the encoding
 of the model, so it is not meant to be a complete representation of the
 feasible solution symmetries, just a valid subgroup.
Protobuf type operations_research.sat.SymmetryProto
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SymmetryProto.Builder
    EXPERIMENTAL.

    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
    ORBITOPES_FIELD_NUMBER
     
    static final int
    PERMUTATIONS_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 SymmetryProto
    getDefaultInstance()
     
    SymmetryProto
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    DenseMatrixProto
    getOrbitopes(int index)
    An orbitope is a special symmetry structure of the solution space.
    int
    getOrbitopesCount()
    An orbitope is a special symmetry structure of the solution space.
    List<DenseMatrixProto>
    getOrbitopesList()
    An orbitope is a special symmetry structure of the solution space.
    DenseMatrixProtoOrBuilder
    getOrbitopesOrBuilder(int index)
    An orbitope is a special symmetry structure of the solution space.
    List<? extends DenseMatrixProtoOrBuilder>
    getOrbitopesOrBuilderList()
    An orbitope is a special symmetry structure of the solution space.
    com.google.protobuf.Parser<SymmetryProto>
    getParserForType()
     
    SparsePermutationProto
    getPermutations(int index)
    A list of variable indices permutations that leave the feasible space of solution invariant.
    int
    getPermutationsCount()
    A list of variable indices permutations that leave the feasible space of solution invariant.
    List<SparsePermutationProto>
    getPermutationsList()
    A list of variable indices permutations that leave the feasible space of solution invariant.
    SparsePermutationProtoOrBuilder
    getPermutationsOrBuilder(int index)
    A list of variable indices permutations that leave the feasible space of solution invariant.
    List<? extends SparsePermutationProtoOrBuilder>
    getPermutationsOrBuilderList()
    A list of variable indices permutations that leave the feasible space of solution invariant.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SymmetryProto.Builder
    newBuilder()
     
    static SymmetryProto.Builder
    newBuilder(SymmetryProto prototype)
     
    SymmetryProto.Builder
    newBuilderForType()
     
    protected SymmetryProto.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SymmetryProto
    parseDelimitedFrom(InputStream input)
     
    static SymmetryProto
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SymmetryProto
    parseFrom(byte[] data)
     
    static SymmetryProto
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SymmetryProto
    parseFrom(com.google.protobuf.ByteString data)
     
    static SymmetryProto
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SymmetryProto
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SymmetryProto
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SymmetryProto
    parseFrom(InputStream input)
     
    static SymmetryProto
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SymmetryProto
    parseFrom(ByteBuffer data)
     
    static SymmetryProto
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SymmetryProto>
    parser()
     
    SymmetryProto.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

    • PERMUTATIONS_FIELD_NUMBER

      public static final int PERMUTATIONS_FIELD_NUMBER
      See Also:

    • ORBITOPES_FIELD_NUMBER

      public static final int ORBITOPES_FIELD_NUMBER
      See Also:

  • 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

    • getPermutationsList

      public List<SparsePermutationProto> getPermutationsList()
       A list of variable indices permutations that leave the feasible space of
 solution invariant. Usually, we only encode a set of generators of the
 group.
      repeated .operations_research.sat.SparsePermutationProto permutations = 1;
      Specified by:
      getPermutationsList in interface SymmetryProtoOrBuilder

    • getPermutationsOrBuilderList

      public List<? extends SparsePermutationProtoOrBuilder> getPermutationsOrBuilderList()
       A list of variable indices permutations that leave the feasible space of
 solution invariant. Usually, we only encode a set of generators of the
 group.
      repeated .operations_research.sat.SparsePermutationProto permutations = 1;
      Specified by:
      getPermutationsOrBuilderList in interface SymmetryProtoOrBuilder

    • getPermutationsCount

      public int getPermutationsCount()
       A list of variable indices permutations that leave the feasible space of
 solution invariant. Usually, we only encode a set of generators of the
 group.
      repeated .operations_research.sat.SparsePermutationProto permutations = 1;
      Specified by:
      getPermutationsCount in interface SymmetryProtoOrBuilder

    • getPermutations

      public SparsePermutationProto getPermutations(int index)
       A list of variable indices permutations that leave the feasible space of
 solution invariant. Usually, we only encode a set of generators of the
 group.
      repeated .operations_research.sat.SparsePermutationProto permutations = 1;
      Specified by:
      getPermutations in interface SymmetryProtoOrBuilder

    • getPermutationsOrBuilder

      public SparsePermutationProtoOrBuilder getPermutationsOrBuilder(int index)
       A list of variable indices permutations that leave the feasible space of
 solution invariant. Usually, we only encode a set of generators of the
 group.
      repeated .operations_research.sat.SparsePermutationProto permutations = 1;
      Specified by:
      getPermutationsOrBuilder in interface SymmetryProtoOrBuilder

    • getOrbitopesList

      public List<DenseMatrixProto> getOrbitopesList()
       An orbitope is a special symmetry structure of the solution space. If the
 variable indices are arranged in a matrix (with no duplicates), then any
 permutation of the columns will be a valid permutation of the feasible
 space.

 This arise quite often. The typical example is a graph coloring problem
 where for each node i, you have j booleans to indicate its color. If the
 variables color_of_i_is_j are arranged in a matrix[i][j], then any columns
 permutations leave the problem invariant.
      repeated .operations_research.sat.DenseMatrixProto orbitopes = 2;
      Specified by:
      getOrbitopesList in interface SymmetryProtoOrBuilder

    • getOrbitopesOrBuilderList

      public List<? extends DenseMatrixProtoOrBuilder> getOrbitopesOrBuilderList()
       An orbitope is a special symmetry structure of the solution space. If the
 variable indices are arranged in a matrix (with no duplicates), then any
 permutation of the columns will be a valid permutation of the feasible
 space.

 This arise quite often. The typical example is a graph coloring problem
 where for each node i, you have j booleans to indicate its color. If the
 variables color_of_i_is_j are arranged in a matrix[i][j], then any columns
 permutations leave the problem invariant.
      repeated .operations_research.sat.DenseMatrixProto orbitopes = 2;
      Specified by:
      getOrbitopesOrBuilderList in interface SymmetryProtoOrBuilder

    • getOrbitopesCount

      public int getOrbitopesCount()
       An orbitope is a special symmetry structure of the solution space. If the
 variable indices are arranged in a matrix (with no duplicates), then any
 permutation of the columns will be a valid permutation of the feasible
 space.

 This arise quite often. The typical example is a graph coloring problem
 where for each node i, you have j booleans to indicate its color. If the
 variables color_of_i_is_j are arranged in a matrix[i][j], then any columns
 permutations leave the problem invariant.
      repeated .operations_research.sat.DenseMatrixProto orbitopes = 2;
      Specified by:
      getOrbitopesCount in interface SymmetryProtoOrBuilder

    • getOrbitopes

      public DenseMatrixProto getOrbitopes(int index)
       An orbitope is a special symmetry structure of the solution space. If the
 variable indices are arranged in a matrix (with no duplicates), then any
 permutation of the columns will be a valid permutation of the feasible
 space.

 This arise quite often. The typical example is a graph coloring problem
 where for each node i, you have j booleans to indicate its color. If the
 variables color_of_i_is_j are arranged in a matrix[i][j], then any columns
 permutations leave the problem invariant.
      repeated .operations_research.sat.DenseMatrixProto orbitopes = 2;
      Specified by:
      getOrbitopes in interface SymmetryProtoOrBuilder

    • getOrbitopesOrBuilder

      public DenseMatrixProtoOrBuilder getOrbitopesOrBuilder(int index)
       An orbitope is a special symmetry structure of the solution space. If the
 variable indices are arranged in a matrix (with no duplicates), then any
 permutation of the columns will be a valid permutation of the feasible
 space.

 This arise quite often. The typical example is a graph coloring problem
 where for each node i, you have j booleans to indicate its color. If the
 variables color_of_i_is_j are arranged in a matrix[i][j], then any columns
 permutations leave the problem invariant.
      repeated .operations_research.sat.DenseMatrixProto orbitopes = 2;
      Specified by:
      getOrbitopesOrBuilder in interface SymmetryProtoOrBuilder

    • 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 SymmetryProto parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SymmetryProto.Builder newBuilder()

    • newBuilder

      public static SymmetryProto.Builder newBuilder(SymmetryProto prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SymmetryProto getDefaultInstance()

    • parser

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

    • getParserForType

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