com.google.ortools.linearsolver.MPIndicatorConstraint Class Reference

Inheritance diagram for com.google.ortools.linearsolver.MPIndicatorConstraint:

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
static final com.google.protobuf.Parser< MPIndicatorConstraint >	PARSER

Protected Member Functions
java.lang.Object	newInstance (UnusedPrivateParameter unused)
com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable ()
Builder	newBuilderForType (com.google.protobuf.GeneratedMessageV3.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 20 of file MPIndicatorConstraint.java.

Member Function Documentation

equals()

boolean com.google.ortools.linearsolver.MPIndicatorConstraint.equals

(

final java.lang.Object

obj

)

Definition at line 197 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 132 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 143 of file MPIndicatorConstraint.java.

getDefaultInstance()

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

static

Definition at line 856 of file MPIndicatorConstraint.java.

getDefaultInstanceForType()

com.google.ortools.linearsolver.MPIndicatorConstraint com.google.ortools.linearsolver.MPIndicatorConstraint.getDefaultInstanceForType

(

)

Definition at line 892 of file MPIndicatorConstraint.java.

getDescriptor()

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

static

Definition at line 40 of file MPIndicatorConstraint.java.

getParserForType()

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

(

)

Definition at line 887 of file MPIndicatorConstraint.java.

getSerializedSize()

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

(

)

Definition at line 174 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 78 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 105 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 120 of file MPIndicatorConstraint.java.

hashCode()

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

(

)

Definition at line 226 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 65 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 93 of file MPIndicatorConstraint.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessageV3.FieldAccessorTable com.google.ortools.linearsolver.MPIndicatorConstraint.internalGetFieldAccessorTable ( )

protected

Definition at line 46 of file MPIndicatorConstraint.java.

isInitialized()

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

(

)

Definition at line 149 of file MPIndicatorConstraint.java.

newBuilder() [1/2]

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

static

Definition at line 323 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 326 of file MPIndicatorConstraint.java.

newBuilderForType() [1/2]

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

(

)

Definition at line 322 of file MPIndicatorConstraint.java.

newBuilderForType() [2/2]

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

protected

Definition at line 336 of file MPIndicatorConstraint.java.

newInstance()

java.lang.Object com.google.ortools.linearsolver.MPIndicatorConstraint.newInstance ( UnusedPrivateParameter unused )

protected

Definition at line 34 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 294 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 300 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 271 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 275 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 260 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 265 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 307 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 313 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 281 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 286 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 249 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 254 of file MPIndicatorConstraint.java.

parser()

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

static

Definition at line 882 of file MPIndicatorConstraint.java.

toBuilder()

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

(

)

Definition at line 330 of file MPIndicatorConstraint.java.

writeTo()

void com.google.ortools.linearsolver.MPIndicatorConstraint.writeTo

(

com.google.protobuf.CodedOutputStream

output

)

throws java.io.IOException

Definition at line 159 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 109 of file MPIndicatorConstraint.java.

PARSER

final com.google.protobuf.Parser<MPIndicatorConstraint> com.google.ortools.linearsolver.MPIndicatorConstraint.PARSER

static

Initial value:

= new com.google.protobuf.AbstractParser<MPIndicatorConstraint>() {
    @java.lang.Override
    public MPIndicatorConstraint parsePartialFrom(
        com.google.protobuf.CodedInputStream input,
        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
        throws com.google.protobuf.InvalidProtocolBufferException {
      Builder builder = newBuilder();
      try {
        builder.mergeFrom(input, extensionRegistry);
      } catch (com.google.protobuf.InvalidProtocolBufferException e) {
        throw e.setUnfinishedMessage(builder.buildPartial());
      } catch (com.google.protobuf.UninitializedMessageException e) {
        throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
      } catch (java.io.IOException e) {
        throw new com.google.protobuf.InvalidProtocolBufferException(e)
            .setUnfinishedMessage(builder.buildPartial());
      }
      return builder.buildPartial();
    }
  }

Definition at line 861 of file MPIndicatorConstraint.java.

VAR_INDEX_FIELD_NUMBER

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

static

Definition at line 53 of file MPIndicatorConstraint.java.

VAR_VALUE_FIELD_NUMBER

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

static

Definition at line 82 of file MPIndicatorConstraint.java.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/linearsolver/MPIndicatorConstraint.java