Java Reference

Java Reference

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 21 of file SymmetryProto.java.

Classes

class  Builder
 

Public Member Functions

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ()
 
.lang.Override java.util.List< com.google.ortools.sat.SparsePermutationProtogetPermutationsList ()
 
.lang.Override java.util.List<? extends com.google.ortools.sat.SparsePermutationProtoOrBuildergetPermutationsOrBuilderList ()
 
.lang.Override int getPermutationsCount ()
 
.lang.Override com.google.ortools.sat.SparsePermutationProto getPermutations (int index)
 
.lang.Override com.google.ortools.sat.SparsePermutationProtoOrBuilder getPermutationsOrBuilder (int index)
 
.lang.Override java.util.List< com.google.ortools.sat.DenseMatrixProtogetOrbitopesList ()
 
.lang.Override java.util.List<? extends com.google.ortools.sat.DenseMatrixProtoOrBuildergetOrbitopesOrBuilderList ()
 
.lang.Override int getOrbitopesCount ()
 
.lang.Override com.google.ortools.sat.DenseMatrixProto getOrbitopes (int index)
 
.lang.Override com.google.ortools.sat.DenseMatrixProtoOrBuilder getOrbitopesOrBuilder (int index)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
 
.lang.Override int getSerializedSize ()
 
.lang.Override boolean equals (final java.lang.Object obj)
 
.lang.Override int hashCode ()
 
.lang.Override Builder newBuilderForType ()
 
.lang.Override Builder toBuilder ()
 
.lang.Override com.google.protobuf.Parser< SymmetryProtogetParserForType ()
 
.lang.Override 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< SymmetryProtoparser ()
 

Static Public Attributes

static final int PERMUTATIONS_FIELD_NUMBER = 1
 
static final int ORBITOPES_FIELD_NUMBER = 2
 

Protected Member Functions

.lang.Override java.lang.Object newInstance (UnusedPrivateParameter unused)
 
.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 
.lang.Override Builder newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
 

Member Function Documentation

◆ equals()

.lang.Override boolean equals ( final java.lang.Object  obj)

Definition at line 330 of file SymmetryProto.java.

◆ getDefaultInstance()

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

Definition at line 1503 of file SymmetryProto.java.

◆ getDefaultInstanceForType()

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

Definition at line 1528 of file SymmetryProto.java.

◆ getDescriptor()

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

Definition at line 110 of file SymmetryProto.java.

◆ getOrbitopes()

.lang.Override com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 264 of file SymmetryProto.java.

◆ getOrbitopesCount()

.lang.Override 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;

Implements SymmetryProtoOrBuilder.

Definition at line 246 of file SymmetryProto.java.

◆ getOrbitopesList()

.lang.Override java.util.List<com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 209 of file SymmetryProto.java.

◆ getOrbitopesOrBuilder()

.lang.Override com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 282 of file SymmetryProto.java.

◆ getOrbitopesOrBuilderList()

.lang.Override java.util.List<? extends com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 228 of file SymmetryProto.java.

◆ getParserForType()

.lang.Override com.google.protobuf.Parser<SymmetryProto> getParserForType ( )

Definition at line 1523 of file SymmetryProto.java.

◆ getPermutations()

.lang.Override com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 174 of file SymmetryProto.java.

◆ getPermutationsCount()

.lang.Override 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;

Implements SymmetryProtoOrBuilder.

Definition at line 161 of file SymmetryProto.java.

◆ getPermutationsList()

.lang.Override java.util.List<com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 134 of file SymmetryProto.java.

◆ getPermutationsOrBuilder()

.lang.Override com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 187 of file SymmetryProto.java.

◆ getPermutationsOrBuilderList()

.lang.Override java.util.List<? extends com.google.ortools.sat.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;

Implements SymmetryProtoOrBuilder.

Definition at line 148 of file SymmetryProto.java.

◆ getSerializedSize()

.lang.Override int getSerializedSize ( )

Definition at line 311 of file SymmetryProto.java.

◆ getUnknownFields()

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ( )

Definition at line 44 of file SymmetryProto.java.

◆ hashCode()

.lang.Override int hashCode ( )

Definition at line 348 of file SymmetryProto.java.

◆ internalGetFieldAccessorTable()

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ( )
protected

Definition at line 116 of file SymmetryProto.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )

Definition at line 289 of file SymmetryProto.java.

◆ newBuilder() [1/2]

static Builder newBuilder ( )
static

Definition at line 439 of file SymmetryProto.java.

◆ newBuilder() [2/2]

static Builder newBuilder ( com.google.ortools.sat.SymmetryProto  prototype)
static

Definition at line 442 of file SymmetryProto.java.

◆ newBuilderForType() [1/2]

.lang.Override Builder newBuilderForType ( )

Definition at line 438 of file SymmetryProto.java.

◆ newBuilderForType() [2/2]

.lang.Override Builder newBuilderForType ( com.google.protobuf.GeneratedMessageV3.BuilderParent  parent)
protected

Definition at line 452 of file SymmetryProto.java.

◆ newInstance()

.lang.Override java.lang.Object newInstance ( UnusedPrivateParameter  unused)
protected

Definition at line 37 of file SymmetryProto.java.

◆ parseDelimitedFrom() [1/2]

static com.google.ortools.sat.SymmetryProto parseDelimitedFrom ( java.io.InputStream  input) throws java.io.IOException
static

Definition at line 411 of file SymmetryProto.java.

◆ parseDelimitedFrom() [2/2]

static com.google.ortools.sat.SymmetryProto parseDelimitedFrom ( java.io.InputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
static

Definition at line 416 of file SymmetryProto.java.

◆ parseFrom() [1/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( byte[]  data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 389 of file SymmetryProto.java.

◆ parseFrom() [2/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( byte[]  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 393 of file SymmetryProto.java.

◆ parseFrom() [3/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( com.google.protobuf.ByteString  data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 378 of file SymmetryProto.java.

◆ parseFrom() [4/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( com.google.protobuf.ByteString  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 383 of file SymmetryProto.java.

◆ parseFrom() [5/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( com.google.protobuf.CodedInputStream  input) throws java.io.IOException
static

Definition at line 423 of file SymmetryProto.java.

◆ parseFrom() [6/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
static

Definition at line 429 of file SymmetryProto.java.

◆ parseFrom() [7/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( java.io.InputStream  input) throws java.io.IOException
static

Definition at line 399 of file SymmetryProto.java.

◆ parseFrom() [8/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( java.io.InputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
static

Definition at line 404 of file SymmetryProto.java.

◆ parseFrom() [9/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( java.nio.ByteBuffer  data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 367 of file SymmetryProto.java.

◆ parseFrom() [10/10]

static com.google.ortools.sat.SymmetryProto parseFrom ( java.nio.ByteBuffer  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 372 of file SymmetryProto.java.

◆ parser()

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

Definition at line 1518 of file SymmetryProto.java.

◆ toBuilder()

.lang.Override Builder toBuilder ( )

Definition at line 446 of file SymmetryProto.java.

◆ writeTo()

.lang.Override void writeTo ( com.google.protobuf.CodedOutputStream  output) throws java.io.IOException

Definition at line 299 of file SymmetryProto.java.

Member Data Documentation

◆ ORBITOPES_FIELD_NUMBER

final int ORBITOPES_FIELD_NUMBER = 2
static

Definition at line 192 of file SymmetryProto.java.

◆ PERMUTATIONS_FIELD_NUMBER

final int PERMUTATIONS_FIELD_NUMBER = 1
static

Definition at line 122 of file SymmetryProto.java.


The documentation for this class was generated from the following file: