Detailed Description

Maintain a reservoir level within bounds. The water level starts at 0, and at
any time, it must be within [min_level, max_level].

If the variable active_literals[i] is true, and if the expression
time_exprs[i] is assigned a value t, then the current level changes by
level_changes[i] at the time t. Therefore, at any time t:

sum(level_changes[i] * active_literals[i] if time_exprs[i] <= t)
in [min_level, max_level]

Note that min level must be <= 0, and the max level must be >= 0. Please use
fixed level_changes to simulate initial state.

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 31 of file ReservoirConstraintProto.java.

Inheritance diagram for com.google.ortools.sat.ReservoirConstraintProto:

Classes
class	Builder

Public Member Functions
long	getMinLevel ()
long	getMaxLevel ()
java.util.List< com.google.ortools.sat.LinearExpressionProto >	getTimeExprsList ()
java.util.List<? extends com.google.ortools.sat.LinearExpressionProtoOrBuilder >	getTimeExprsOrBuilderList ()
int	getTimeExprsCount ()
com.google.ortools.sat.LinearExpressionProto	getTimeExprs (int index)
com.google.ortools.sat.LinearExpressionProtoOrBuilder	getTimeExprsOrBuilder (int index)
java.util.List< com.google.ortools.sat.LinearExpressionProto >	getLevelChangesList ()
java.util.List<? extends com.google.ortools.sat.LinearExpressionProtoOrBuilder >	getLevelChangesOrBuilderList ()
int	getLevelChangesCount ()
com.google.ortools.sat.LinearExpressionProto	getLevelChanges (int index)
com.google.ortools.sat.LinearExpressionProtoOrBuilder	getLevelChangesOrBuilder (int index)
java.util.List< java.lang.Integer >	getActiveLiteralsList ()
int	getActiveLiteralsCount ()
int	getActiveLiterals (int index)
final boolean	isInitialized ()
void	writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int	getSerializedSize ()
boolean	equals (final java.lang.Object obj)
int	hashCode ()
Builder	newBuilderForType ()
Builder	toBuilder ()
com.google.protobuf.Parser< ReservoirConstraintProto >	getParserForType ()
com.google.ortools.sat.ReservoirConstraintProto	getDefaultInstanceForType ()

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

Static Public Attributes
static final int	MIN_LEVEL_FIELD_NUMBER = 1
static final int	MAX_LEVEL_FIELD_NUMBER = 2
static final int	TIME_EXPRS_FIELD_NUMBER = 3
static final int	LEVEL_CHANGES_FIELD_NUMBER = 6
static final int	ACTIVE_LITERALS_FIELD_NUMBER = 5

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()
Builder	newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Member Function Documentation

◆ equals()

boolean com.google.ortools.sat.ReservoirConstraintProto.equals ( final java.lang.Object obj )

Definition at line 321 of file ReservoirConstraintProto.java.

◆ getActiveLiterals()

int com.google.ortools.sat.ReservoirConstraintProto.getActiveLiterals ( int index )

repeated int32 active_literals = 5;

Parameters

index The index of the element to return.

Returns: The activeLiterals at the given index.

Implements com.google.ortools.sat.ReservoirConstraintProtoOrBuilder.

Definition at line 237 of file ReservoirConstraintProto.java.

◆ getActiveLiteralsCount()

int com.google.ortools.sat.ReservoirConstraintProto.getActiveLiteralsCount ( )

repeated int32 active_literals = 5;

Returns: The count of activeLiterals.

Implements com.google.ortools.sat.ReservoirConstraintProtoOrBuilder.

Definition at line 229 of file ReservoirConstraintProto.java.

◆ getActiveLiteralsList()

java.util.List< java.lang.Integer > com.google.ortools.sat.ReservoirConstraintProto.getActiveLiteralsList ( )

repeated int32 active_literals = 5;

Returns: A list containing the activeLiterals.

Implements com.google.ortools.sat.ReservoirConstraintProtoOrBuilder.

Definition at line 222 of file ReservoirConstraintProto.java.

◆ getDefaultInstance()

com.google.ortools.sat.ReservoirConstraintProto com.google.ortools.sat.ReservoirConstraintProto.getDefaultInstance ( )

static

Definition at line 1560 of file ReservoirConstraintProto.java.

◆ getDefaultInstanceForType()

com.google.ortools.sat.ReservoirConstraintProto com.google.ortools.sat.ReservoirConstraintProto.getDefaultInstanceForType ( )

Definition at line 1596 of file ReservoirConstraintProto.java.

◆ getDescriptor()

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

static

Definition at line 56 of file ReservoirConstraintProto.java.

◆ getLevelChanges()

com.google.ortools.sat.LinearExpressionProto com.google.ortools.sat.ReservoirConstraintProto.getLevelChanges ( int index )

Currently, we only support constant level changes.