Java Reference
Java Reference
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
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()
|
inline |
literals.
repeated int32 actives = 5;
- Parameters
-
value The actives to add.
- Returns
- This builder for chaining.
Definition at line 1144 of file ReservoirConstraintProto.java.
◆ addAllActives()
|
inline |
literals.
repeated int32 actives = 5;
- Parameters
-
values The actives to add.
- Returns
- This builder for chaining.
Definition at line 1159 of file ReservoirConstraintProto.java.
◆ addAllDemands()
|
inline |
constants, can be negative.
repeated int64 demands = 4;
- Parameters
-
values The demands to add.
- Returns
- This builder for chaining.
Definition at line 1052 of file ReservoirConstraintProto.java.
◆ addAllTimes()
|
inline |
variables.
repeated int32 times = 3;
- Parameters
-
values The times to add.
- Returns
- This builder for chaining.
Definition at line 945 of file ReservoirConstraintProto.java.
◆ addDemands()
|
inline |
constants, can be negative.
repeated int64 demands = 4;
- Parameters
-
value The demands to add.
- Returns
- This builder for chaining.
Definition at line 1037 of file ReservoirConstraintProto.java.
◆ addRepeatedField()
|
inline |
Definition at line 716 of file ReservoirConstraintProto.java.
◆ addTimes()
|
inline |
variables.
repeated int32 times = 3;
- Parameters
-
value The times to add.
- Returns
- This builder for chaining.
Definition at line 930 of file ReservoirConstraintProto.java.
◆ build()
|
inline |
Definition at line 656 of file ReservoirConstraintProto.java.
◆ buildPartial()
|
inline |
Definition at line 665 of file ReservoirConstraintProto.java.
◆ clear()
|
inline |
Definition at line 629 of file ReservoirConstraintProto.java.
◆ clearActives()
|
inline |
literals.
repeated int32 actives = 5;
- Returns
- This builder for chaining.
Definition at line 1175 of file ReservoirConstraintProto.java.
◆ clearDemands()
|
inline |
constants, can be negative.
repeated int64 demands = 4;
- Returns
- This builder for chaining.
Definition at line 1068 of file ReservoirConstraintProto.java.
◆ clearField()
|
inline |
Definition at line 700 of file ReservoirConstraintProto.java.
◆ clearMaxLevel()
|
inline |
int64 max_level = 2;
- Returns
- This builder for chaining.
Definition at line 854 of file ReservoirConstraintProto.java.
◆ clearMinLevel()
|
inline |
int64 min_level = 1;
- Returns
- This builder for chaining.
Definition at line 823 of file ReservoirConstraintProto.java.
◆ clearOneof()
|
inline |
Definition at line 705 of file ReservoirConstraintProto.java.
◆ clearTimes()
|
inline |
variables.
repeated int32 times = 3;
- Returns
- This builder for chaining.
Definition at line 961 of file ReservoirConstraintProto.java.
◆ clone()
|
inline |
Definition at line 690 of file ReservoirConstraintProto.java.
◆ getActives()
|
inline |
literals.
repeated int32 actives = 5;
- Parameters
-
index The index of the element to return.
- Returns
- The actives at the given index.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 1115 of file ReservoirConstraintProto.java.
◆ getActivesCount()
|
inline |
literals.
repeated int32 actives = 5;
- Returns
- The count of actives.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 1103 of file ReservoirConstraintProto.java.
◆ getActivesList()
|
inline |
literals.
repeated int32 actives = 5;
- Returns
- A list containing the actives.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 1091 of file ReservoirConstraintProto.java.
◆ getDefaultInstanceForType()
|
inline |
Definition at line 651 of file ReservoirConstraintProto.java.
◆ getDemands()
|
inline |
constants, can be negative.
repeated int64 demands = 4;
- Parameters
-
index The index of the element to return.
- Returns
- The demands at the given index.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 1008 of file ReservoirConstraintProto.java.
◆ 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()
|
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()
|
inlinestatic |
Definition at line 601 of file ReservoirConstraintProto.java.
◆ getDescriptorForType()
|
inline |
Definition at line 646 of file ReservoirConstraintProto.java.
◆ getMaxLevel()
|
inline |
int64 max_level = 2;
- Returns
- The maxLevel.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 836 of file ReservoirConstraintProto.java.
◆ getMinLevel()
|
inline |
int64 min_level = 1;
- Returns
- The minLevel.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 805 of file ReservoirConstraintProto.java.
◆ getTimes()
|
inline |
variables.
repeated int32 times = 3;
- Parameters
-
index The index of the element to return.
- Returns
- The times at the given index.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 901 of file ReservoirConstraintProto.java.
◆ getTimesCount()
|
inline |
variables.
repeated int32 times = 3;
- Returns
- The count of times.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 889 of file ReservoirConstraintProto.java.
◆ getTimesList()
|
inline |
variables.
repeated int32 times = 3;
- Returns
- A list containing the times.
Implements ReservoirConstraintProtoOrBuilder.
Definition at line 877 of file ReservoirConstraintProto.java.
◆ internalGetFieldAccessorTable()
|
inlineprotected |
Definition at line 607 of file ReservoirConstraintProto.java.
◆ isInitialized()
|
inline |
Definition at line 775 of file ReservoirConstraintProto.java.
◆ mergeFrom() [1/3]
|
inline |
Definition at line 731 of file ReservoirConstraintProto.java.
◆ mergeFrom() [2/3]
|
inline |
Definition at line 780 of file ReservoirConstraintProto.java.
◆ mergeFrom() [3/3]
|
inline |
Definition at line 722 of file ReservoirConstraintProto.java.
◆ mergeUnknownFields()
|
inline |
Definition at line 1188 of file ReservoirConstraintProto.java.
◆ setActives()
|
inline |
literals.
repeated int32 actives = 5;
- Parameters
-
index The index to set the value at. value The actives to set.
- Returns
- This builder for chaining.
Definition at line 1128 of file ReservoirConstraintProto.java.
◆ setDemands()
|
inline |
constants, can be negative.
repeated int64 demands = 4;
- Parameters
-
index The index to set the value at. value The demands to set.
- Returns
- This builder for chaining.
Definition at line 1021 of file ReservoirConstraintProto.java.
◆ setField()
|
inline |
Definition at line 694 of file ReservoirConstraintProto.java.
◆ setMaxLevel()
|
inline |
int64 max_level = 2;
- Parameters
-
value The maxLevel to set.
- Returns
- This builder for chaining.
Definition at line 844 of file ReservoirConstraintProto.java.
◆ setMinLevel()
|
inline |
int64 min_level = 1;
- Parameters
-
value The minLevel to set.
- Returns
- This builder for chaining.
Definition at line 813 of file ReservoirConstraintProto.java.
◆ setRepeatedField()
|
inline |
Definition at line 710 of file ReservoirConstraintProto.java.
◆ setTimes()
|
inline |
variables.
repeated int32 times = 3;
- Parameters
-
index The index to set the value at. value The times to set.
- Returns
- This builder for chaining.
Definition at line 914 of file ReservoirConstraintProto.java.
◆ setUnknownFields()
|
inline |
Definition at line 1182 of file ReservoirConstraintProto.java.
The documentation for this class was generated from the following file: