Java Reference

Java Reference

Detailed Description

The circuit constraint is defined on a graph where the arc presence are
controlled by literals. Each arc is given by an index in the
tails/heads/literals lists that must have the same size.
For now, we ignore node indices with no incident arc. All the other nodes
must have exactly one incoming and one outgoing selected arc (i.e. literal at
true). All the selected arcs that are not self-loops must form a single
circuit. Note that multi-arcs are allowed, but only one of them will be true
at the same time. Multi-self loop are disallowed though.

Protobuf type

operations_research.sat.CircuitConstraintProto

Definition at line 20 of file CircuitConstraintProto.java.

Classes

class  Builder
 

Public Member Functions

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ()
 
.lang.Override java.util.List< java.lang.Integer > getTailsList ()
 repeated int32 tails = 3; More...
 
int getTailsCount ()
 repeated int32 tails = 3; More...
 
int getTails (int index)
 repeated int32 tails = 3; More...
 
.lang.Override java.util.List< java.lang.Integer > getHeadsList ()
 repeated int32 heads = 4; More...
 
int getHeadsCount ()
 repeated int32 heads = 4; More...
 
int getHeads (int index)
 repeated int32 heads = 4; More...
 
.lang.Override java.util.List< java.lang.Integer > getLiteralsList ()
 repeated int32 literals = 5; More...
 
int getLiteralsCount ()
 repeated int32 literals = 5; More...
 
int getLiterals (int index)
 repeated int32 literals = 5; More...
 
.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< CircuitConstraintProtogetParserForType ()
 
.lang.Override com.google.ortools.sat.CircuitConstraintProto getDefaultInstanceForType ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.sat.CircuitConstraintProto parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.sat.CircuitConstraintProto parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.sat.CircuitConstraintProto parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
 
static com.google.ortools.sat.CircuitConstraintProto 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.CircuitConstraintProto prototype)
 
static com.google.ortools.sat.CircuitConstraintProto getDefaultInstance ()
 
static com.google.protobuf.Parser< CircuitConstraintProtoparser ()
 

Static Public Attributes

static final int TAILS_FIELD_NUMBER = 3
 
static final int HEADS_FIELD_NUMBER = 4
 
static final int LITERALS_FIELD_NUMBER = 5
 

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 347 of file CircuitConstraintProto.java.

◆ getDefaultInstance()

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

Definition at line 943 of file CircuitConstraintProto.java.

◆ getDefaultInstanceForType()

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

Definition at line 968 of file CircuitConstraintProto.java.

◆ getDescriptor()

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

Definition at line 158 of file CircuitConstraintProto.java.

◆ getHeads()

int getHeads ( int  index)

repeated int32 heads = 4;

Parameters
indexThe index of the element to return.
Returns
The heads at the given index.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 221 of file CircuitConstraintProto.java.

◆ getHeadsCount()

int getHeadsCount ( )

repeated int32 heads = 4;

Returns
The count of heads.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 213 of file CircuitConstraintProto.java.

◆ getHeadsList()

.lang.Override java.util.List<java.lang.Integer> getHeadsList ( )

repeated int32 heads = 4;

Returns
A list containing the heads.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 206 of file CircuitConstraintProto.java.

◆ getLiterals()

int getLiterals ( int  index)

repeated int32 literals = 5;

Parameters
indexThe index of the element to return.
Returns
The literals at the given index.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 249 of file CircuitConstraintProto.java.

◆ getLiteralsCount()

int getLiteralsCount ( )

repeated int32 literals = 5;

Returns
The count of literals.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 241 of file CircuitConstraintProto.java.

◆ getLiteralsList()

.lang.Override java.util.List<java.lang.Integer> getLiteralsList ( )

repeated int32 literals = 5;

Returns
A list containing the literals.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 234 of file CircuitConstraintProto.java.

◆ getParserForType()

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

Definition at line 963 of file CircuitConstraintProto.java.

◆ getSerializedSize()

.lang.Override int getSerializedSize ( )

Definition at line 294 of file CircuitConstraintProto.java.

◆ getTails()

int getTails ( int  index)

repeated int32 tails = 3;

Parameters
indexThe index of the element to return.
Returns
The tails at the given index.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 193 of file CircuitConstraintProto.java.

◆ getTailsCount()

int getTailsCount ( )

repeated int32 tails = 3;

Returns
The count of tails.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 185 of file CircuitConstraintProto.java.

◆ getTailsList()

.lang.Override java.util.List<java.lang.Integer> getTailsList ( )

repeated int32 tails = 3;

Returns
A list containing the tails.

Implements CircuitConstraintProtoOrBuilder.

Definition at line 178 of file CircuitConstraintProto.java.

◆ getUnknownFields()

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

Definition at line 44 of file CircuitConstraintProto.java.

◆ hashCode()

.lang.Override int hashCode ( )

Definition at line 367 of file CircuitConstraintProto.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 164 of file CircuitConstraintProto.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )

Definition at line 256 of file CircuitConstraintProto.java.

◆ newBuilder() [1/2]

static Builder newBuilder ( )
static

Definition at line 462 of file CircuitConstraintProto.java.

◆ newBuilder() [2/2]

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

Definition at line 465 of file CircuitConstraintProto.java.

◆ newBuilderForType() [1/2]

.lang.Override Builder newBuilderForType ( )

Definition at line 461 of file CircuitConstraintProto.java.

◆ newBuilderForType() [2/2]

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

Definition at line 475 of file CircuitConstraintProto.java.

◆ newInstance()

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

Definition at line 37 of file CircuitConstraintProto.java.

◆ parseDelimitedFrom() [1/2]

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

Definition at line 434 of file CircuitConstraintProto.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 439 of file CircuitConstraintProto.java.

◆ parseFrom() [1/10]

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

Definition at line 412 of file CircuitConstraintProto.java.

◆ parseFrom() [2/10]

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

Definition at line 416 of file CircuitConstraintProto.java.

◆ parseFrom() [3/10]

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

Definition at line 401 of file CircuitConstraintProto.java.

◆ parseFrom() [4/10]

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

Definition at line 406 of file CircuitConstraintProto.java.

◆ parseFrom() [5/10]

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

Definition at line 446 of file CircuitConstraintProto.java.

◆ parseFrom() [6/10]

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

Definition at line 452 of file CircuitConstraintProto.java.

◆ parseFrom() [7/10]

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

Definition at line 422 of file CircuitConstraintProto.java.

◆ parseFrom() [8/10]

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

Definition at line 427 of file CircuitConstraintProto.java.

◆ parseFrom() [9/10]

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

Definition at line 390 of file CircuitConstraintProto.java.

◆ parseFrom() [10/10]

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

Definition at line 395 of file CircuitConstraintProto.java.

◆ parser()

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

Definition at line 958 of file CircuitConstraintProto.java.

◆ toBuilder()

.lang.Override Builder toBuilder ( )

Definition at line 469 of file CircuitConstraintProto.java.

◆ writeTo()

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

Definition at line 266 of file CircuitConstraintProto.java.

Member Data Documentation

◆ HEADS_FIELD_NUMBER

final int HEADS_FIELD_NUMBER = 4
static

Definition at line 198 of file CircuitConstraintProto.java.

◆ LITERALS_FIELD_NUMBER

final int LITERALS_FIELD_NUMBER = 5
static

Definition at line 226 of file CircuitConstraintProto.java.

◆ TAILS_FIELD_NUMBER

final int TAILS_FIELD_NUMBER = 3
static

Definition at line 170 of file CircuitConstraintProto.java.


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