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

Inheritance diagram for com.google.ortools.sat.CircuitConstraintProto.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.sat.CircuitConstraintProto	getDefaultInstanceForType ()
com.google.ortools.sat.CircuitConstraintProto	build ()
com.google.ortools.sat.CircuitConstraintProto	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.sat.CircuitConstraintProto other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.util.List< java.lang.Integer >	getTailsList ()
int	getTailsCount ()
int	getTails (int index)
Builder	setTails (int index, int value)
Builder	addTails (int value)
Builder	addAllTails (java.lang.Iterable<? extends java.lang.Integer > values)
Builder	clearTails ()
java.util.List< java.lang.Integer >	getHeadsList ()
int	getHeadsCount ()
int	getHeads (int index)
Builder	setHeads (int index, int value)
Builder	addHeads (int value)
Builder	addAllHeads (java.lang.Iterable<? extends java.lang.Integer > values)
Builder	clearHeads ()
java.util.List< java.lang.Integer >	getLiteralsList ()
int	getLiteralsCount ()
int	getLiterals (int index)
Builder	setLiterals (int index, int value)
Builder	addLiterals (int value)
Builder	addAllLiterals (java.lang.Iterable<? extends java.lang.Integer > values)
Builder	clearLiterals ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()

Member Function Documentation

◆ addAllHeads()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.addAllHeads ( java.lang.Iterable<? extends java.lang.Integer > values )

repeated int32 heads = 4;

Parameters

values The heads to add.

Returns: This builder for chaining.

Definition at line 759 of file CircuitConstraintProto.java.

◆ addAllLiterals()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.addAllLiterals ( java.lang.Iterable<? extends java.lang.Integer > values )

repeated int32 literals = 5;

Parameters

values The literals to add.

Returns: This builder for chaining.

Definition at line 843 of file CircuitConstraintProto.java.

◆ addAllTails()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.addAllTails ( java.lang.Iterable<? extends java.lang.Integer > values )

repeated int32 tails = 3;

Parameters

values The tails to add.

Returns: This builder for chaining.

Definition at line 675 of file CircuitConstraintProto.java.

◆ addHeads()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.addHeads ( int value )

repeated int32 heads = 4;

Parameters

value The heads to add.

Returns: This builder for chaining.

Definition at line 746 of file CircuitConstraintProto.java.

◆ addLiterals()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.addLiterals ( int value )

repeated int32 literals = 5;

Parameters

value The literals to add.

Returns: This builder for chaining.

Definition at line 830 of file CircuitConstraintProto.java.

◆ addTails()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.addTails ( int value )

repeated int32 tails = 3;

Parameters

value The tails to add.

Returns: This builder for chaining.

Definition at line 662 of file CircuitConstraintProto.java.

◆ build()

com.google.ortools.sat.CircuitConstraintProto com.google.ortools.sat.CircuitConstraintProto.Builder.build ( )

Definition at line 443 of file CircuitConstraintProto.java.

◆ buildPartial()

com.google.ortools.sat.CircuitConstraintProto com.google.ortools.sat.CircuitConstraintProto.Builder.buildPartial ( )

Definition at line 452 of file CircuitConstraintProto.java.

◆ clear()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.clear ( )

Definition at line 422 of file CircuitConstraintProto.java.

◆ clearHeads()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.clearHeads ( )

repeated int32 heads = 4;

Returns: This builder for chaining.

Definition at line 772 of file CircuitConstraintProto.java.

◆ clearLiterals()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.clearLiterals ( )

repeated int32 literals = 5;

Returns: This builder for chaining.

Definition at line 856 of file CircuitConstraintProto.java.

◆ clearTails()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.clearTails ( )

repeated int32 tails = 3;

Returns: This builder for chaining.

Definition at line 688 of file CircuitConstraintProto.java.

◆ getDefaultInstanceForType()

com.google.ortools.sat.CircuitConstraintProto com.google.ortools.sat.CircuitConstraintProto.Builder.getDefaultInstanceForType ( )

Definition at line 438 of file CircuitConstraintProto.java.

◆ getDescriptor()

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

static

Definition at line 399 of file CircuitConstraintProto.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.CircuitConstraintProto.Builder.getDescriptorForType ( )

Definition at line 433 of file CircuitConstraintProto.java.

◆ getHeads()

int com.google.ortools.sat.CircuitConstraintProto.Builder.getHeads ( int index )

repeated int32 heads = 4;

Parameters

index The index of the element to return.

Returns: The heads at the given index.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 723 of file CircuitConstraintProto.java.

◆ getHeadsCount()

int com.google.ortools.sat.CircuitConstraintProto.Builder.getHeadsCount ( )

repeated int32 heads = 4;

Returns: The count of heads.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 715 of file CircuitConstraintProto.java.

◆ getHeadsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.CircuitConstraintProto.Builder.getHeadsList ( )

repeated int32 heads = 4;

Returns: A list containing the heads.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 707 of file CircuitConstraintProto.java.

◆ getLiterals()

int com.google.ortools.sat.CircuitConstraintProto.Builder.getLiterals ( int index )

repeated int32 literals = 5;

Parameters

index The index of the element to return.

Returns: The literals at the given index.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 807 of file CircuitConstraintProto.java.

◆ getLiteralsCount()

int com.google.ortools.sat.CircuitConstraintProto.Builder.getLiteralsCount ( )

repeated int32 literals = 5;

Returns: The count of literals.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 799 of file CircuitConstraintProto.java.

◆ getLiteralsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.CircuitConstraintProto.Builder.getLiteralsList ( )

repeated int32 literals = 5;

Returns: A list containing the literals.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 791 of file CircuitConstraintProto.java.

◆ getTails()

int com.google.ortools.sat.CircuitConstraintProto.Builder.getTails ( int index )

repeated int32 tails = 3;

Parameters

index The index of the element to return.

Returns: The tails at the given index.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 639 of file CircuitConstraintProto.java.

◆ getTailsCount()

int com.google.ortools.sat.CircuitConstraintProto.Builder.getTailsCount ( )

repeated int32 tails = 3;

Returns: The count of tails.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 631 of file CircuitConstraintProto.java.

◆ getTailsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.CircuitConstraintProto.Builder.getTailsList ( )

repeated int32 tails = 3;

Returns: A list containing the tails.

Implements com.google.ortools.sat.CircuitConstraintProtoOrBuilder.

Definition at line 623 of file CircuitConstraintProto.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.sat.CircuitConstraintProto.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 405 of file CircuitConstraintProto.java.

◆ isInitialized()

final boolean com.google.ortools.sat.CircuitConstraintProto.Builder.isInitialized ( )

Definition at line 526 of file CircuitConstraintProto.java.

◆ mergeFrom() [1/3]

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.mergeFrom ( com.google.ortools.sat.CircuitConstraintProto other )

Definition at line 485 of file CircuitConstraintProto.java.

◆ mergeFrom() [2/3]

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

Definition at line 531 of file CircuitConstraintProto.java.

◆ mergeFrom() [3/3]

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.mergeFrom ( com.google.protobuf.Message other )

Definition at line 476 of file CircuitConstraintProto.java.

◆ setHeads()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.setHeads	(	int	index,
		int	value )

repeated int32 heads = 4;

Parameters

index	The index to set the value at.
value	The heads to set.

Returns: This builder for chaining.

Definition at line 732 of file CircuitConstraintProto.java.

◆ setLiterals()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.setLiterals	(	int	index,
		int	value )

repeated int32 literals = 5;

Parameters

index	The index to set the value at.
value	The literals to set.

Returns: This builder for chaining.

Definition at line 816 of file CircuitConstraintProto.java.

◆ setTails()

Builder com.google.ortools.sat.CircuitConstraintProto.Builder.setTails	(	int	index,
		int	value )

repeated int32 tails = 3;

Parameters

index	The index to set the value at.
value	The tails to set.

Returns: This builder for chaining.

Definition at line 648 of file CircuitConstraintProto.java.

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

build/java/ortools-java/src/main/java/com/google/ortools/sat/CircuitConstraintProto.java

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Function Documentation

◆ addAllHeads()

◆ addAllLiterals()

◆ addAllTails()

◆ addHeads()

◆ addLiterals()

◆ addTails()

◆ build()

◆ buildPartial()

◆ clear()

◆ clearHeads()

◆ clearLiterals()

◆ clearTails()

◆ getDefaultInstanceForType()

◆ getDescriptor()

◆ getDescriptorForType()

◆ getHeads()

◆ getHeadsCount()

◆ getHeadsList()

◆ getLiterals()

◆ getLiteralsCount()

◆ getLiteralsList()

◆ getTails()

◆ getTailsCount()

◆ getTailsList()

◆ internalGetFieldAccessorTable()

◆ isInitialized()

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

◆ mergeFrom() [3/3]

◆ setHeads()

◆ setLiterals()

◆ setTails()