Java Reference

Java Reference

ReservoirConstraintProto.Builder

Detailed Description

Maintain a reservoir level within bounds. The water level starts at 0, and at
any time >= 0, it must be within min_level, and max_level. Furthermore, this
constraints expect all times variables to be >= 0.
If the variable actives[i] is true, and if the variable times[i] is assigned
a value t, then the current level changes by demands[i] (which is constant)
at the time t.
Note that level min can be > 0, or level max can be < 0. It just forces
some demands to be executed at time 0 to make sure that we are within those
bounds with the executed demands. Therefore, at any time t >= 0:
     sum(demands[i] * actives[i] if times[i] <= t) in [min_level, max_level]
The array of boolean variables 'actives', if defined, indicates which actions
are actually performed. If this array is not defined, then it is assumed that
all actions will be performed.

Protobuf type

operations_research.sat.ReservoirConstraintProto

Definition at line 596 of file ReservoirConstraintProto.java.

Public Member Functions

.lang.Override Builder clear ()
 
.lang.Override com.google.protobuf.Descriptors.Descriptor getDescriptorForType ()
 
.lang.Override com.google.ortools.sat.ReservoirConstraintProto getDefaultInstanceForType ()
 
.lang.Override com.google.ortools.sat.ReservoirConstraintProto build ()
 
.lang.Override com.google.ortools.sat.ReservoirConstraintProto 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.ReservoirConstraintProto other)
 
.lang.Override final boolean isInitialized ()
 
.lang.Override Builder mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
.lang.Override long getMinLevel ()
 int64 min_level = 1; More...
 
Builder setMinLevel (long value)
 int64 min_level = 1; More...
 
Builder clearMinLevel ()
 int64 min_level = 1; More...
 
.lang.Override long getMaxLevel ()
 int64 max_level = 2; More...
 
Builder setMaxLevel (long value)
 int64 max_level = 2; More...
 
Builder clearMaxLevel ()
 int64 max_level = 2; More...
 
java.util.List< java.lang.Integer > getTimesList ()
 
int getTimesCount ()
 
int getTimes (int index)
 
Builder setTimes (int index, int value)
 
Builder addTimes (int value)
 
Builder addAllTimes (java.lang.Iterable<? extends java.lang.Integer > values)
 
Builder clearTimes ()
 
java.util.List< java.lang.Long > getDemandsList ()
 
int getDemandsCount ()
 
long getDemands (int index)
 
Builder setDemands (int index, long value)
 
Builder addDemands (long value)
 
Builder addAllDemands (java.lang.Iterable<? extends java.lang.Long > values)
 
Builder clearDemands ()
 
java.util.List< java.lang.Integer > getActivesList ()
 
int getActivesCount ()
 
int getActives (int index)
 
Builder setActives (int index, int value)
 
Builder addActives (int value)
 
Builder addAllActives (java.lang.Iterable<? extends java.lang.Integer > values)
 
Builder clearActives ()
 
.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

◆ addActives()

Builder addActives ( int  value)
inline
literals.

repeated int32 actives = 5;

Parameters
valueThe actives to add.
Returns
This builder for chaining.

Definition at line 1144 of file ReservoirConstraintProto.java.

◆ addAllActives()

Builder addAllActives ( java.lang.Iterable<? extends java.lang.Integer >  values)
inline
literals.

repeated int32 actives = 5;

Parameters
valuesThe actives to add.
Returns
This builder for chaining.

Definition at line 1159 of file ReservoirConstraintProto.java.

◆ addAllDemands()

Builder addAllDemands ( java.lang.Iterable<? extends java.lang.Long >  values)
inline
constants, can be negative.

repeated int64 demands = 4;

Parameters
valuesThe demands to add.
Returns
This builder for chaining.

Definition at line 1052 of file ReservoirConstraintProto.java.

◆ addAllTimes()

Builder addAllTimes ( java.lang.Iterable<? extends java.lang.Integer >  values)
inline
variables.

repeated int32 times = 3;

Parameters
valuesThe times to add.
Returns
This builder for chaining.

Definition at line 945 of file ReservoirConstraintProto.java.

◆ addDemands()

Builder addDemands ( long  value)
inline
constants, can be negative.

repeated int64 demands = 4;

Parameters
valueThe demands to add.
Returns
This builder for chaining.

Definition at line 1037 of file ReservoirConstraintProto.java.

◆ addRepeatedField()

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

Definition at line 716 of file ReservoirConstraintProto.java.

◆ addTimes()

Builder addTimes ( int  value)
inline
variables.

repeated int32 times = 3;

Parameters
valueThe times to add.
Returns
This builder for chaining.

Definition at line 930 of file ReservoirConstraintProto.java.

◆ build()

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

Definition at line 656 of file ReservoirConstraintProto.java.

◆ buildPartial()

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

Definition at line 665 of file ReservoirConstraintProto.java.

◆ clear()

.lang.Override Builder clear ( )
inline

Definition at line 629 of file ReservoirConstraintProto.java.

◆ clearActives()

Builder clearActives ( )
inline
literals.

repeated int32 actives = 5;

Returns
This builder for chaining.

Definition at line 1175 of file ReservoirConstraintProto.java.

◆ clearDemands()

Builder clearDemands ( )
inline
constants, can be negative.

repeated int64 demands = 4;

Returns
This builder for chaining.

Definition at line 1068 of file ReservoirConstraintProto.java.

◆ clearField()

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

Definition at line 700 of file ReservoirConstraintProto.java.

◆ clearMaxLevel()

Builder clearMaxLevel ( )
inline

int64 max_level = 2;

Returns
This builder for chaining.

Definition at line 854 of file ReservoirConstraintProto.java.

◆ clearMinLevel()

Builder clearMinLevel ( )
inline

int64 min_level = 1;

Returns
This builder for chaining.

Definition at line 823 of file ReservoirConstraintProto.java.

◆ clearOneof()

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

Definition at line 705 of file ReservoirConstraintProto.java.

◆ clearTimes()

Builder clearTimes ( )
inline
variables.

repeated int32 times = 3;

Returns
This builder for chaining.

Definition at line 961 of file ReservoirConstraintProto.java.

◆ clone()

.lang.Override Builder clone ( )
inline

Definition at line 690 of file ReservoirConstraintProto.java.

◆ getActives()

int getActives ( int  index)
inline
literals.

repeated int32 actives = 5;

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

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 1115 of file ReservoirConstraintProto.java.

◆ getActivesCount()

int getActivesCount ( )
inline
literals.

repeated int32 actives = 5;

Returns
The count of actives.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 1103 of file ReservoirConstraintProto.java.

◆ getActivesList()

java.util.List<java.lang.Integer> getActivesList ( )
inline
literals.

repeated int32 actives = 5;

Returns
A list containing the actives.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 1091 of file ReservoirConstraintProto.java.

◆ getDefaultInstanceForType()

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

Definition at line 651 of file ReservoirConstraintProto.java.

◆ getDemands()

long getDemands ( int  index)
inline
constants, can be negative.

repeated int64 demands = 4;

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

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 1008 of file ReservoirConstraintProto.java.

◆ getDemandsCount()

int getDemandsCount ( )
inline
constants, can be negative.

repeated int64 demands = 4;

Returns
The count of demands.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 996 of file ReservoirConstraintProto.java.

◆ getDemandsList()

java.util.List<java.lang.Long> getDemandsList ( )
inline
constants, can be negative.

repeated int64 demands = 4;

Returns
A list containing the demands.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 984 of file ReservoirConstraintProto.java.

◆ getDescriptor()

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

Definition at line 601 of file ReservoirConstraintProto.java.

◆ getDescriptorForType()

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

Definition at line 646 of file ReservoirConstraintProto.java.

◆ getMaxLevel()

.lang.Override long getMaxLevel ( )
inline

int64 max_level = 2;

Returns
The maxLevel.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 836 of file ReservoirConstraintProto.java.

◆ getMinLevel()

.lang.Override long getMinLevel ( )
inline

int64 min_level = 1;

Returns
The minLevel.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 805 of file ReservoirConstraintProto.java.

◆ getTimes()

int getTimes ( int  index)
inline
variables.

repeated int32 times = 3;

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

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 901 of file ReservoirConstraintProto.java.

◆ getTimesCount()

int getTimesCount ( )
inline
variables.

repeated int32 times = 3;

Returns
The count of times.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 889 of file ReservoirConstraintProto.java.

◆ getTimesList()

java.util.List<java.lang.Integer> getTimesList ( )
inline
variables.

repeated int32 times = 3;

Returns
A list containing the times.

Implements ReservoirConstraintProtoOrBuilder.

Definition at line 877 of file ReservoirConstraintProto.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 607 of file ReservoirConstraintProto.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 775 of file ReservoirConstraintProto.java.

◆ mergeFrom() [1/3]

Definition at line 731 of file ReservoirConstraintProto.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 780 of file ReservoirConstraintProto.java.

◆ mergeFrom() [3/3]

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

Definition at line 722 of file ReservoirConstraintProto.java.

◆ mergeUnknownFields()

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

Definition at line 1188 of file ReservoirConstraintProto.java.

◆ setActives()

Builder setActives ( int  index,
int  value 
)
inline
literals.

repeated int32 actives = 5;

Parameters
indexThe index to set the value at.
valueThe actives to set.
Returns
This builder for chaining.

Definition at line 1128 of file ReservoirConstraintProto.java.

◆ setDemands()

Builder setDemands ( int  index,
long  value 
)
inline
constants, can be negative.

repeated int64 demands = 4;

Parameters
indexThe index to set the value at.
valueThe demands to set.
Returns
This builder for chaining.

Definition at line 1021 of file ReservoirConstraintProto.java.

◆ setField()

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

Definition at line 694 of file ReservoirConstraintProto.java.

◆ setMaxLevel()

Builder setMaxLevel ( long  value)
inline

int64 max_level = 2;

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

Definition at line 844 of file ReservoirConstraintProto.java.

◆ setMinLevel()

Builder setMinLevel ( long  value)
inline

int64 min_level = 1;

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

Definition at line 813 of file ReservoirConstraintProto.java.

◆ setRepeatedField()

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

Definition at line 710 of file ReservoirConstraintProto.java.

◆ setTimes()

Builder setTimes ( int  index,
int  value 
)
inline
variables.

repeated int32 times = 3;

Parameters
indexThe index to set the value at.
valueThe times to set.
Returns
This builder for chaining.

Definition at line 914 of file ReservoirConstraintProto.java.

◆ setUnknownFields()

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

Definition at line 1182 of file ReservoirConstraintProto.java.


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