com.google.ortools.glop.GlopParameters.CostScalingAlgorithm Enum Reference

Inheritance diagram for com.google.ortools.glop.GlopParameters.CostScalingAlgorithm:

Public Member Functions
final int	getNumber ()
final com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor ()
final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType ()

Static Public Member Functions
static CostScalingAlgorithm	valueOf (int value)
static CostScalingAlgorithm	forNumber (int value)
static com.google.protobuf.Internal.EnumLiteMap< CostScalingAlgorithm >	internalGetValueMap ()
static final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor ()
static CostScalingAlgorithm	valueOf (com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Public Attributes
	NO_COST_SCALING =(0)
	CONTAIN_ONE_COST_SCALING =(1)
	MEAN_COST_SCALING =(2)
	MEDIAN_COST_SCALING =(3)

Static Public Attributes
static final int	NO_COST_SCALING_VALUE = 0
static final int	CONTAIN_ONE_COST_SCALING_VALUE = 1
static final int	MEAN_COST_SCALING_VALUE = 2
static final int	MEDIAN_COST_SCALING_VALUE = 3

Detailed Description

This is only used if use_scaling is true. After the scaling is done, we
also scale the objective by a constant factor. This is important because
scaling the cost has a direct influence on the meaning of the
dual_feasibility_tolerance. Because we usually use a fixed tolerance, the
objective must be well scaled to make sense.

Protobuf enum operations_research.glop.GlopParameters.CostScalingAlgorithm

Definition at line 655 of file GlopParameters.java.

Member Function Documentation

forNumber()

static CostScalingAlgorithm com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.forNumber ( int value )

static

Parameters

value

The numeric wire value of the corresponding enum entry.

Returns

The enum associated with the given numeric wire value.

Definition at line 747 of file GlopParameters.java.

getDescriptor()

static final com.google.protobuf.Descriptors.EnumDescriptor com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.getDescriptor ( )

static

Definition at line 778 of file GlopParameters.java.

getDescriptorForType()

final com.google.protobuf.Descriptors.EnumDescriptor com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.getDescriptorForType

(

)

Definition at line 774 of file GlopParameters.java.

getNumber()

final int com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.getNumber

(

)

Definition at line 729 of file GlopParameters.java.

getValueDescriptor()

final com.google.protobuf.Descriptors.EnumValueDescriptor com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.getValueDescriptor

(

)

Definition at line 770 of file GlopParameters.java.

internalGetValueMap()

static com.google.protobuf.Internal.EnumLiteMap< CostScalingAlgorithm > com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.internalGetValueMap ( )

static

Definition at line 758 of file GlopParameters.java.

valueOf() [1/2]

static CostScalingAlgorithm com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.valueOf ( com.google.protobuf.Descriptors.EnumValueDescriptor desc )

static

Definition at line 784 of file GlopParameters.java.

valueOf() [2/2]

static CostScalingAlgorithm com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.valueOf ( int value )

static

Parameters

value

The numeric wire value of the corresponding enum entry.

Returns

The enum associated with the given numeric wire value.

Deprecated

Use forNumber(int) instead.

Definition at line 739 of file GlopParameters.java.

Member Data Documentation

CONTAIN_ONE_COST_SCALING

com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.CONTAIN_ONE_COST_SCALING =(1)

This is the most defensive option. It makes sure that
[min_cost_magnitude, max_cost_magnitude] contains 1.0, and if not, it
makes the closest magnitude bound equal to one.

CONTAIN_ONE_COST_SCALING = 1;

Definition at line 674 of file GlopParameters.java.

CONTAIN_ONE_COST_SCALING_VALUE

final int com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.CONTAIN_ONE_COST_SCALING_VALUE = 1

static

This is the most defensive option. It makes sure that
[min_cost_magnitude, max_cost_magnitude] contains 1.0, and if not, it
makes the closest magnitude bound equal to one.

CONTAIN_ONE_COST_SCALING = 1;

Definition at line 710 of file GlopParameters.java.

MEAN_COST_SCALING

com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.MEAN_COST_SCALING =(2)

Make the mean of the non-zero costs equals to one.

MEAN_COST_SCALING = 2;

Definition at line 682 of file GlopParameters.java.

MEAN_COST_SCALING_VALUE

final int com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.MEAN_COST_SCALING_VALUE = 2

static

Make the mean of the non-zero costs equals to one.

MEAN_COST_SCALING = 2;

Definition at line 718 of file GlopParameters.java.

MEDIAN_COST_SCALING

com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.MEDIAN_COST_SCALING =(3)

Make the median of the non-zero costs equals to one.

MEDIAN_COST_SCALING = 3;

Definition at line 690 of file GlopParameters.java.

MEDIAN_COST_SCALING_VALUE

final int com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.MEDIAN_COST_SCALING_VALUE = 3

static

Make the median of the non-zero costs equals to one.

MEDIAN_COST_SCALING = 3;

Definition at line 726 of file GlopParameters.java.

NO_COST_SCALING

com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.NO_COST_SCALING =(0)

Leave the cost as is.

NO_COST_SCALING = 0;

Definition at line 664 of file GlopParameters.java.

NO_COST_SCALING_VALUE

final int com.google.ortools.glop.GlopParameters.CostScalingAlgorithm.NO_COST_SCALING_VALUE = 0

static

Leave the cost as is.

NO_COST_SCALING = 0;

Definition at line 700 of file GlopParameters.java.

---

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

• build/java/ortools-java/src/main/java/com/google/ortools/glop/GlopParameters.java