Java Reference

Java Reference

IntegerVariableProto.Builder

Detailed Description

An integer variable.
It will be referred to by an int32 corresponding to its index in a
CpModelProto variables field.
Depending on the context, a reference to a variable whose domain is in [0, 1]
can also be seen as a Boolean that will be true if the variable value is 1
and false if it is 0. When used in this context, the field name will always
contain the word "literal".
Negative reference (advanced usage): to simplify the creation of a model and
for efficiency reasons, all the "literal" or "variable" fields can also
contain a negative index. A negative index i will refer to the negation of
the integer variable at index -i -1 or to NOT the literal at the same index.
Ex: A variable index 4 will refer to the integer variable model.variables(4)
and an index of -5 will refer to the negation of the same variable. A literal
index 4 will refer to the logical fact that model.variable(4) == 1 and a
literal index of -5 will refer to the logical fact model.variable(4) == 0.

Protobuf type

operations_research.sat.IntegerVariableProto

Definition at line 462 of file IntegerVariableProto.java.

Public Member Functions

.lang.Override Builder clear ()
 
.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
.lang.Override com.google.ortools.sat.IntegerVariableProto getDefaultInstanceForType ()
 
.lang.Override com.google.ortools.sat.IntegerVariableProto build ()
 
.lang.Override com.google.ortools.sat.IntegerVariableProto buildPartial ()
 
.lang.Override Builder clone ()
 
.lang.Override Builder setField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder clearField (com.google.protobuf.Descriptors.FieldDescriptor field)
 
.lang.Override Builder clearOneof (com.google.protobuf.Descriptors.OneofDescriptor oneof)
 
.lang.Override Builder setRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
 
.lang.Override Builder addRepeatedField (com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
 
.lang.Override Builder mergeFrom (com.google.protobuf.Message other)
 
Builder mergeFrom (com.google.ortools.sat.IntegerVariableProto other)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override Builder mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
java.lang.String getName ()
 
com.google.protobuf.ByteString getNameBytes ()
 
Builder setName (java.lang.String value)
 
Builder clearName ()
 
Builder setNameBytes (com.google.protobuf.ByteString value)
 
java.util.List< java.lang.Long > getDomainList ()
 
int getDomainCount ()
 
long getDomain (int index)
 
Builder setDomain (int index, long value)
 
Builder addDomain (long value)
 
Builder addAllDomain (java.lang.Iterable<? extends java.lang.Long > values)
 
Builder clearDomain ()
 
.lang.Override final Builder setUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 
.lang.Override final Builder mergeUnknownFields (final com.google.protobuf.UnknownFieldSet unknownFields)
 

Static Public Member Functions

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

Protected Member Functions

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

Member Function Documentation

◆ addAllDomain()

Builder addAllDomain ( java.lang.Iterable<? extends java.lang.Long >  values)
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Parameters
valuesThe domain to add.
Returns
This builder for chaining.

Definition at line 884 of file IntegerVariableProto.java.

◆ addDomain()

Builder addDomain ( long  value)
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Parameters
valueThe domain to add.
Returns
This builder for chaining.

Definition at line 856 of file IntegerVariableProto.java.

◆ addRepeatedField()

.lang.Override Builder addRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 565 of file IntegerVariableProto.java.

◆ build()

.lang.Override com.google.ortools.sat.IntegerVariableProto build ( )
inline

Definition at line 516 of file IntegerVariableProto.java.

◆ buildPartial()

.lang.Override com.google.ortools.sat.IntegerVariableProto buildPartial ( )
inline

Definition at line 525 of file IntegerVariableProto.java.

◆ clear()

.lang.Override Builder clear ( )
inline

Definition at line 495 of file IntegerVariableProto.java.

◆ clearDomain()

Builder clearDomain ( )
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Returns
This builder for chaining.

Definition at line 913 of file IntegerVariableProto.java.

◆ clearField()

.lang.Override Builder clearField ( com.google.protobuf.Descriptors.FieldDescriptor  field)
inline

Definition at line 549 of file IntegerVariableProto.java.

◆ clearName()

Builder clearName ( )
inline
For debug/logging only. Can be empty.

string name = 1;

Returns
This builder for chaining.

Definition at line 695 of file IntegerVariableProto.java.

◆ clearOneof()

.lang.Override Builder clearOneof ( com.google.protobuf.Descriptors.OneofDescriptor  oneof)
inline

Definition at line 554 of file IntegerVariableProto.java.

◆ clone()

.lang.Override Builder clone ( )
inline

Definition at line 539 of file IntegerVariableProto.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.sat.IntegerVariableProto getDefaultInstanceForType ( )
inline

Definition at line 511 of file IntegerVariableProto.java.

◆ getDescriptor()

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

Definition at line 467 of file IntegerVariableProto.java.

◆ getDescriptorForType()

.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ( )
inline

Definition at line 506 of file IntegerVariableProto.java.

◆ getDomain()

long getDomain ( int  index)
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Parameters
indexThe index of the element to return.
Returns
The domain at the given index.

Implements IntegerVariableProtoOrBuilder.

Definition at line 801 of file IntegerVariableProto.java.

◆ getDomainCount()

int getDomainCount ( )
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Returns
The count of domain.

Implements IntegerVariableProtoOrBuilder.

Definition at line 776 of file IntegerVariableProto.java.

◆ getDomainList()

java.util.List<java.lang.Long> getDomainList ( )
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Returns
A list containing the domain.

Implements IntegerVariableProtoOrBuilder.

Definition at line 751 of file IntegerVariableProto.java.

◆ getName()

java.lang.String getName ( )
inline
For debug/logging only. Can be empty.

string name = 1;

Returns
The name.

Implements IntegerVariableProtoOrBuilder.

Definition at line 635 of file IntegerVariableProto.java.

◆ getNameBytes()

com.google.protobuf.ByteString getNameBytes ( )
inline
For debug/logging only. Can be empty.

string name = 1;

Returns
The bytes for name.

Implements IntegerVariableProtoOrBuilder.

Definition at line 656 of file IntegerVariableProto.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 473 of file IntegerVariableProto.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 602 of file IntegerVariableProto.java.

◆ mergeFrom() [1/3]

Definition at line 580 of file IntegerVariableProto.java.

◆ mergeFrom() [2/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inline

Definition at line 607 of file IntegerVariableProto.java.

◆ mergeFrom() [3/3]

.lang.Override Builder mergeFrom ( com.google.protobuf.Message  other)
inline

Definition at line 571 of file IntegerVariableProto.java.

◆ mergeUnknownFields()

.lang.Override final Builder mergeUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 926 of file IntegerVariableProto.java.

◆ setDomain()

Builder setDomain ( int  index,
long  value 
)
inline
The variable domain given as a sorted list of n disjoint intervals
[min, max] and encoded as [min_0, max_0,  ..., min_{n-1}, max_{n-1}].
The most common example being just [min, max].
If min == max, then this is a constant variable.
We have:
  • domain_size() is always even.
  • min == domain.front();
  • max == domain.back();
  • for all i < n : min_i <= max_i
  • for all i < n-1 : max_i + 1 < min_{i+1}. Note that we check at validation that a variable domain is small enough so that we don't run into integer overflow in our algorithms. Because of that, you cannot just have "unbounded" variable like [0, kint64max] and should try to specify tighter domains.
repeated int64 domain = 2;
Parameters
indexThe index to set the value at.
valueThe domain to set.
Returns
This builder for chaining.

Definition at line 827 of file IntegerVariableProto.java.

◆ setField()

.lang.Override Builder setField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
java.lang.Object  value 
)
inline

Definition at line 543 of file IntegerVariableProto.java.

◆ setName()

Builder setName ( java.lang.String  value)
inline
For debug/logging only. Can be empty.

string name = 1;

Parameters
valueThe name to set.
Returns
This builder for chaining.

Definition at line 677 of file IntegerVariableProto.java.

◆ setNameBytes()

Builder setNameBytes ( com.google.protobuf.ByteString  value)
inline
For debug/logging only. Can be empty.

string name = 1;

Parameters
valueThe bytes for name to set.
Returns
This builder for chaining.

Definition at line 710 of file IntegerVariableProto.java.

◆ setRepeatedField()

.lang.Override Builder setRepeatedField ( com.google.protobuf.Descriptors.FieldDescriptor  field,
int  index,
java.lang.Object  value 
)
inline

Definition at line 559 of file IntegerVariableProto.java.

◆ setUnknownFields()

.lang.Override final Builder setUnknownFields ( final com.google.protobuf.UnknownFieldSet  unknownFields)
inline

Definition at line 920 of file IntegerVariableProto.java.


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