com.google.ortools.glop

Enum GlopParameters.CostScalingAlgorithm

java.lang.Object

java.lang.Enum<GlopParameters.CostScalingAlgorithm>

com.google.ortools.glop.GlopParameters.CostScalingAlgorithm

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<GlopParameters.CostScalingAlgorithm>

Enclosing class:

GlopParameters

public static enum GlopParameters.CostScalingAlgorithm
extends java.lang.Enum<GlopParameters.CostScalingAlgorithm>
implements com.google.protobuf.ProtocolMessageEnum

 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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAIN_ONE_COST_SCALING This is the most defensive option.
MEAN_COST_SCALING Make the mean of the non-zero costs equals to one.
MEDIAN_COST_SCALING Make the median of the non-zero costs equals to one.
NO_COST_SCALING Leave the cost as is.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTAIN_ONE_COST_SCALING_VALUE This is the most defensive option.
static int	MEAN_COST_SCALING_VALUE Make the mean of the non-zero costs equals to one.
static int	MEDIAN_COST_SCALING_VALUE Make the median of the non-zero costs equals to one.
static int	NO_COST_SCALING_VALUE Leave the cost as is.

Method Summary

Modifier and Type	Method and Description
static GlopParameters.CostScalingAlgorithm	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<GlopParameters.CostScalingAlgorithm>	internalGetValueMap()
static GlopParameters.CostScalingAlgorithm	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static GlopParameters.CostScalingAlgorithm	valueOf(int value) Deprecated. Use forNumber(int) instead.
static GlopParameters.CostScalingAlgorithm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GlopParameters.CostScalingAlgorithm[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_COST_SCALING

public static final GlopParameters.CostScalingAlgorithm NO_COST_SCALING

 Leave the cost as is.
 

NO_COST_SCALING = 0;

CONTAIN_ONE_COST_SCALING

public static final GlopParameters.CostScalingAlgorithm CONTAIN_ONE_COST_SCALING

 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;

MEAN_COST_SCALING

public static final GlopParameters.CostScalingAlgorithm MEAN_COST_SCALING

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

MEAN_COST_SCALING = 2;

MEDIAN_COST_SCALING

public static final GlopParameters.CostScalingAlgorithm MEDIAN_COST_SCALING

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

MEDIAN_COST_SCALING = 3;

Field Detail

NO_COST_SCALING_VALUE

public static final int NO_COST_SCALING_VALUE

 Leave the cost as is.
 

NO_COST_SCALING = 0;

See Also:

Constant Field Values

CONTAIN_ONE_COST_SCALING_VALUE

public static final int CONTAIN_ONE_COST_SCALING_VALUE

 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;

See Also:

Constant Field Values

MEAN_COST_SCALING_VALUE

public static final int MEAN_COST_SCALING_VALUE

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

MEAN_COST_SCALING = 2;

See Also:

Constant Field Values

MEDIAN_COST_SCALING_VALUE

public static final int MEDIAN_COST_SCALING_VALUE

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

MEDIAN_COST_SCALING = 3;

See Also:

Constant Field Values

Method Detail

values

public static GlopParameters.CostScalingAlgorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GlopParameters.CostScalingAlgorithm c : GlopParameters.CostScalingAlgorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GlopParameters.CostScalingAlgorithm valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static GlopParameters.CostScalingAlgorithm valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static GlopParameters.CostScalingAlgorithm forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

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

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

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