Google OR-Tools v9.12
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
com.google.ortools.linearsolver.MPIndicatorConstraint Class Reference
Inheritance diagram for com.google.ortools.linearsolver.MPIndicatorConstraint:
com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder

Classes

class  Builder
 

Public Member Functions

boolean hasVarIndex ()
 
int getVarIndex ()
 
boolean hasVarValue ()
 
int getVarValue ()
 
boolean hasConstraint ()
 
com.google.ortools.linearsolver.MPConstraintProto getConstraint ()
 
com.google.ortools.linearsolver.MPConstraintProtoOrBuilder getConstraintOrBuilder ()
 
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< MPIndicatorConstraint > getParserForType ()
 
com.google.ortools.linearsolver.MPIndicatorConstraint getDefaultInstanceForType ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
 
static com.google.ortools.linearsolver.MPIndicatorConstraint parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static Builder newBuilder ()
 
static Builder newBuilder (com.google.ortools.linearsolver.MPIndicatorConstraint prototype)
 
static com.google.ortools.linearsolver.MPIndicatorConstraint getDefaultInstance ()
 
static com.google.protobuf.Parser< MPIndicatorConstraint > parser ()
 

Static Public Attributes

static final int VAR_INDEX_FIELD_NUMBER = 1
 
static final int VAR_VALUE_FIELD_NUMBER = 2
 
static final int CONSTRAINT_FIELD_NUMBER = 3
 

Protected Member Functions

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

Detailed Description

Indicator constraints encode the activation or deactivation of linear
constraints given the value of one Boolean variable in the model. For
example:
y = 0 => 2 * x1 + 3 * x2 >= 42
The 2 * x1 + 3 * x2 >= 42 constraint is only active if the variable y is
equal to 0.
As of 2019/04, only SCIP, CP-SAT and Gurobi support this constraint type.

Protobuf type operations_research.MPIndicatorConstraint

Definition at line 21 of file MPIndicatorConstraint.java.

Member Function Documentation

◆ equals()

boolean com.google.ortools.linearsolver.MPIndicatorConstraint.equals ( final java.lang.Object obj)

Definition at line 200 of file MPIndicatorConstraint.java.

◆ getConstraint()

com.google.ortools.linearsolver.MPConstraintProto com.google.ortools.linearsolver.MPIndicatorConstraint.getConstraint ( ) 
The constraint activated by the indicator variable.

optional .operations_research.MPConstraintProto constraint = 3;

Returns
The constraint.

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 135 of file MPIndicatorConstraint.java.

◆ getConstraintOrBuilder()

com.google.ortools.linearsolver.MPConstraintProtoOrBuilder com.google.ortools.linearsolver.MPIndicatorConstraint.getConstraintOrBuilder ( ) 
The constraint activated by the indicator variable.

optional .operations_research.MPConstraintProto constraint = 3;

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 146 of file MPIndicatorConstraint.java.

◆ getDefaultInstance()

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.getDefaultInstance ( )
static

Definition at line 815 of file MPIndicatorConstraint.java.

◆ getDefaultInstanceForType()

com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.getDefaultInstanceForType ( )

Definition at line 851 of file MPIndicatorConstraint.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.linearsolver.MPIndicatorConstraint.getDescriptor ( )
static

Definition at line 43 of file MPIndicatorConstraint.java.

◆ getParserForType()

com.google.protobuf.Parser< MPIndicatorConstraint > com.google.ortools.linearsolver.MPIndicatorConstraint.getParserForType ( )

Definition at line 846 of file MPIndicatorConstraint.java.

◆ getSerializedSize()

int com.google.ortools.linearsolver.MPIndicatorConstraint.getSerializedSize ( )

Definition at line 177 of file MPIndicatorConstraint.java.

◆ getVarIndex()

int com.google.ortools.linearsolver.MPIndicatorConstraint.getVarIndex ( ) 
Variable index (w.r.t. the "variable" field of MPModelProto) of the Boolean
variable used as indicator.

optional int32 var_index = 1;

Returns
The varIndex.

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 81 of file MPIndicatorConstraint.java.

◆ getVarValue()

int com.google.ortools.linearsolver.MPIndicatorConstraint.getVarValue ( ) 
Value the above variable should take. Must be 0 or 1.

optional int32 var_value = 2;

Returns
The varValue.

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 108 of file MPIndicatorConstraint.java.

◆ hasConstraint()

boolean com.google.ortools.linearsolver.MPIndicatorConstraint.hasConstraint ( ) 
The constraint activated by the indicator variable.

optional .operations_research.MPConstraintProto constraint = 3;

Returns
Whether the constraint field is set.

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 123 of file MPIndicatorConstraint.java.

◆ hashCode()

int com.google.ortools.linearsolver.MPIndicatorConstraint.hashCode ( )

Definition at line 229 of file MPIndicatorConstraint.java.

◆ hasVarIndex()

boolean com.google.ortools.linearsolver.MPIndicatorConstraint.hasVarIndex ( ) 
Variable index (w.r.t. the "variable" field of MPModelProto) of the Boolean
variable used as indicator.

optional int32 var_index = 1;

Returns
Whether the varIndex field is set.

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 68 of file MPIndicatorConstraint.java.

◆ hasVarValue()

boolean com.google.ortools.linearsolver.MPIndicatorConstraint.hasVarValue ( ) 
Value the above variable should take. Must be 0 or 1.

optional int32 var_value = 2;

Returns
Whether the varValue field is set.

Implements com.google.ortools.linearsolver.MPIndicatorConstraintOrBuilder.

Definition at line 96 of file MPIndicatorConstraint.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.linearsolver.MPIndicatorConstraint.internalGetFieldAccessorTable ( )
protected

Definition at line 49 of file MPIndicatorConstraint.java.

◆ isInitialized()

final boolean com.google.ortools.linearsolver.MPIndicatorConstraint.isInitialized ( )

Definition at line 152 of file MPIndicatorConstraint.java.

◆ newBuilder() [1/2]

static Builder com.google.ortools.linearsolver.MPIndicatorConstraint.newBuilder ( )
static

Definition at line 326 of file MPIndicatorConstraint.java.

◆ newBuilder() [2/2]

static Builder com.google.ortools.linearsolver.MPIndicatorConstraint.newBuilder ( com.google.ortools.linearsolver.MPIndicatorConstraint prototype)
static

Definition at line 329 of file MPIndicatorConstraint.java.

◆ newBuilderForType() [1/2]

Builder com.google.ortools.linearsolver.MPIndicatorConstraint.newBuilderForType ( )

Definition at line 325 of file MPIndicatorConstraint.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.linearsolver.MPIndicatorConstraint.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 339 of file MPIndicatorConstraint.java.

◆ parseDelimitedFrom() [1/2]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseDelimitedFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 297 of file MPIndicatorConstraint.java.

◆ parseDelimitedFrom() [2/2]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseDelimitedFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 303 of file MPIndicatorConstraint.java.

◆ parseFrom() [1/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 274 of file MPIndicatorConstraint.java.

◆ parseFrom() [2/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 278 of file MPIndicatorConstraint.java.

◆ parseFrom() [3/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 263 of file MPIndicatorConstraint.java.

◆ parseFrom() [4/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 268 of file MPIndicatorConstraint.java.

◆ parseFrom() [5/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( com.google.protobuf.CodedInputStream input) throws java.io.IOException
static

Definition at line 310 of file MPIndicatorConstraint.java.

◆ parseFrom() [6/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 316 of file MPIndicatorConstraint.java.

◆ parseFrom() [7/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( java.io.InputStream input) throws java.io.IOException
static

Definition at line 284 of file MPIndicatorConstraint.java.

◆ parseFrom() [8/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws java.io.IOException
static

Definition at line 289 of file MPIndicatorConstraint.java.

◆ parseFrom() [9/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 252 of file MPIndicatorConstraint.java.

◆ parseFrom() [10/10]

static com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.parseFrom ( java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry ) throws com.google.protobuf.InvalidProtocolBufferException
static

Definition at line 257 of file MPIndicatorConstraint.java.

◆ parser()

static com.google.protobuf.Parser< MPIndicatorConstraint > com.google.ortools.linearsolver.MPIndicatorConstraint.parser ( )
static

Definition at line 841 of file MPIndicatorConstraint.java.

◆ toBuilder()

Builder com.google.ortools.linearsolver.MPIndicatorConstraint.toBuilder ( )

Definition at line 333 of file MPIndicatorConstraint.java.

◆ writeTo()

void com.google.ortools.linearsolver.MPIndicatorConstraint.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 162 of file MPIndicatorConstraint.java.

Member Data Documentation

◆ CONSTRAINT_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPIndicatorConstraint.CONSTRAINT_FIELD_NUMBER = 3
static

Definition at line 112 of file MPIndicatorConstraint.java.

◆ VAR_INDEX_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPIndicatorConstraint.VAR_INDEX_FIELD_NUMBER = 1
static

Definition at line 56 of file MPIndicatorConstraint.java.

◆ VAR_VALUE_FIELD_NUMBER

final int com.google.ortools.linearsolver.MPIndicatorConstraint.VAR_VALUE_FIELD_NUMBER = 2
static

Definition at line 85 of file MPIndicatorConstraint.java.

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