Java Reference

Java Reference

MPSosConstraintOrBuilder

Detailed Description

Definition at line 6 of file MPSosConstraintOrBuilder.java.

Public Member Functions

boolean hasType ()
 optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT]; More...
 
com.google.ortools.linearsolver.MPSosConstraint.Type getType ()
 optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT]; More...
 
java.util.List< java.lang.Integer > getVarIndexList ()
 
int getVarIndexCount ()
 
int getVarIndex (int index)
 
java.util.List< java.lang.Double > getWeightList ()
 
int getWeightCount ()
 
double getWeight (int index)
 

Member Function Documentation

◆ getType()

optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT];

Returns
The type.

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ getVarIndex()

int getVarIndex ( int  index)
Variable index (w.r.t. the "variable" field of MPModelProto) of the
variables in the SOS.

repeated int32 var_index = 2;

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

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ getVarIndexCount()

int getVarIndexCount ( )
Variable index (w.r.t. the "variable" field of MPModelProto) of the
variables in the SOS.

repeated int32 var_index = 2;

Returns
The count of varIndex.

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ getVarIndexList()

java.util.List<java.lang.Integer> getVarIndexList ( )
Variable index (w.r.t. the "variable" field of MPModelProto) of the
variables in the SOS.

repeated int32 var_index = 2;

Returns
A list containing the varIndex.

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ getWeight()

double getWeight ( int  index)
Optional: SOS weights. If non-empty, must be of the same size as
"var_index", and strictly increasing. If empty and required by the
underlying solver, the 1..n sequence will be given as weights.
SUBTLE: The weights can help the solver make branch-and-bound decisions
that fit the underlying optimization model: after each LP relaxation, it
will compute the "average weight" of the SOS variables, weighted by value
(this is confusing: here we're using the values as weights), and the binary
branch decision will be: is the non-zero variable above or below that?
(weights are strictly monotonous, so the "cutoff" average weight
corresponds to a "cutoff" index in the var_index sequence).

repeated double weight = 3;

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

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ getWeightCount()

int getWeightCount ( )
Optional: SOS weights. If non-empty, must be of the same size as
"var_index", and strictly increasing. If empty and required by the
underlying solver, the 1..n sequence will be given as weights.
SUBTLE: The weights can help the solver make branch-and-bound decisions
that fit the underlying optimization model: after each LP relaxation, it
will compute the "average weight" of the SOS variables, weighted by value
(this is confusing: here we're using the values as weights), and the binary
branch decision will be: is the non-zero variable above or below that?
(weights are strictly monotonous, so the "cutoff" average weight
corresponds to a "cutoff" index in the var_index sequence).

repeated double weight = 3;

Returns
The count of weight.

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ getWeightList()

java.util.List<java.lang.Double> getWeightList ( )
Optional: SOS weights. If non-empty, must be of the same size as
"var_index", and strictly increasing. If empty and required by the
underlying solver, the 1..n sequence will be given as weights.
SUBTLE: The weights can help the solver make branch-and-bound decisions
that fit the underlying optimization model: after each LP relaxation, it
will compute the "average weight" of the SOS variables, weighted by value
(this is confusing: here we're using the values as weights), and the binary
branch decision will be: is the non-zero variable above or below that?
(weights are strictly monotonous, so the "cutoff" average weight
corresponds to a "cutoff" index in the var_index sequence).

repeated double weight = 3;

Returns
A list containing the weight.

Implemented in MPSosConstraint.Builder, and MPSosConstraint.

◆ hasType()

boolean hasType ( )

optional .operations_research.MPSosConstraint.Type type = 1 [default = SOS1_DEFAULT];

Returns
Whether the type field is set.

Implemented in MPSosConstraint.Builder, and MPSosConstraint.


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