Detailed Description

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

Definition at line 27 of file SymmetryProto.java.

Inheritance diagram for com.google.ortools.sat.SymmetryProto:

Classes
class	Builder

Public Member Functions
java.util.List< com.google.ortools.sat.SparsePermutationProto >	getPermutationsList ()
java.util.List<? extends com.google.ortools.sat.SparsePermutationProtoOrBuilder >	getPermutationsOrBuilderList ()
int	getPermutationsCount ()
com.google.ortools.sat.SparsePermutationProto	getPermutations (int index)
com.google.ortools.sat.SparsePermutationProtoOrBuilder	getPermutationsOrBuilder (int index)
java.util.List< com.google.ortools.sat.DenseMatrixProto >	getOrbitopesList ()
java.util.List<? extends com.google.ortools.sat.DenseMatrixProtoOrBuilder >	getOrbitopesOrBuilderList ()
int	getOrbitopesCount ()
com.google.ortools.sat.DenseMatrixProto	getOrbitopes (int index)
com.google.ortools.sat.DenseMatrixProtoOrBuilder	getOrbitopesOrBuilder (int index)
final boolean	isInitialized ()
void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int	getSerializedSize ()
boolean	equals (final java.lang.Object obj)
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
com.google.protobuf.Parser< SymmetryProto >	getParserForType ()
com.google.ortools.sat.SymmetryProto	getDefaultInstanceForType ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()
static com.google.ortools.sat.SymmetryProto	parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.SymmetryProto	parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.SymmetryProto	parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.SymmetryProto	parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.SymmetryProto	parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.SymmetryProto	parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
static com.google.ortools.sat.SymmetryProto	parseFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.sat.SymmetryProto	parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.sat.SymmetryProto	parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
static com.google.ortools.sat.SymmetryProto	parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static com.google.ortools.sat.SymmetryProto	parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
static com.google.ortools.sat.SymmetryProto	parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
static Builder	newBuilder ()
static Builder	newBuilder (com.google.ortools.sat.SymmetryProto prototype)
static com.google.ortools.sat.SymmetryProto	getDefaultInstance ()
static com.google.protobuf.Parser< SymmetryProto >	parser ()

Static Public Attributes
static final int	PERMUTATIONS_FIELD_NUMBER = 1
static final int	ORBITOPES_FIELD_NUMBER = 2

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()
Builder	newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Member Function Documentation

◆ equals()

boolean com.google.ortools.sat.SymmetryProto.equals ( final java.lang.Object obj )

Definition at line 278 of file SymmetryProto.java.

◆ getDefaultInstance()

com.google.ortools.sat.SymmetryProto com.google.ortools.sat.SymmetryProto.getDefaultInstance ( )

static

Definition at line 1473 of file SymmetryProto.java.

◆ getDefaultInstanceForType()

com.google.ortools.sat.SymmetryProto com.google.ortools.sat.SymmetryProto.getDefaultInstanceForType ( )

Definition at line 1509 of file SymmetryProto.java.

◆ getDescriptor()

final com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.SymmetryProto.getDescriptor ( )

static

Definition at line 51 of file SymmetryProto.java.

◆ getOrbitopes()

com.google.ortools.sat.DenseMatrixProto com.google.ortools.sat.SymmetryProto.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.