com.google.ortools.pdlp

Enum OptimalityNorm

java.lang.Object

java.lang.Enum<OptimalityNorm>

com.google.ortools.pdlp.OptimalityNorm

All Implemented Interfaces:

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

public enum OptimalityNorm
extends java.lang.Enum<OptimalityNorm>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum operations_research.pdlp.OptimalityNorm

Enum Constant Summary

Enum Constants

Enum Constant and Description
OPTIMALITY_NORM_L_INF The infinity norm.
OPTIMALITY_NORM_L_INF_COMPONENTWISE The infinity norm of component-wise relative errors offset by the ratio of the absolute and relative error tolerances, i.e., the l_∞ norm of [residual / (eps_ratio + |bound|)], where eps_ratio = eps_optimal_{X}_residual_absolute / eps_optimal_{X}_residual_relative where {X} is either primal or dual, and bound is the corresponding primal or dual bound (that is, the violated constraint bound for primal residuals, and the objective coefficient for dual residuals).
OPTIMALITY_NORM_L2 The Euclidean norm.
OPTIMALITY_NORM_UNSPECIFIED OPTIMALITY_NORM_UNSPECIFIED = 0;

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE The infinity norm of component-wise relative errors offset by the ratio of the absolute and relative error tolerances, i.e., the l_∞ norm of [residual / (eps_ratio + |bound|)], where eps_ratio = eps_optimal_{X}_residual_absolute / eps_optimal_{X}_residual_relative where {X} is either primal or dual, and bound is the corresponding primal or dual bound (that is, the violated constraint bound for primal residuals, and the objective coefficient for dual residuals).
static int	OPTIMALITY_NORM_L_INF_VALUE The infinity norm.
static int	OPTIMALITY_NORM_L2_VALUE The Euclidean norm.
static int	OPTIMALITY_NORM_UNSPECIFIED_VALUE OPTIMALITY_NORM_UNSPECIFIED = 0;

Method Summary

Modifier and Type	Method and Description
static OptimalityNorm	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<OptimalityNorm>	internalGetValueMap()
static OptimalityNorm	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static OptimalityNorm	valueOf(int value) Deprecated. Use forNumber(int) instead.
static OptimalityNorm	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OptimalityNorm[]	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

OPTIMALITY_NORM_UNSPECIFIED

public static final OptimalityNorm OPTIMALITY_NORM_UNSPECIFIED

OPTIMALITY_NORM_UNSPECIFIED = 0;

OPTIMALITY_NORM_L_INF

public static final OptimalityNorm OPTIMALITY_NORM_L_INF

 The infinity norm.
 

OPTIMALITY_NORM_L_INF = 1;

OPTIMALITY_NORM_L2

public static final OptimalityNorm OPTIMALITY_NORM_L2

 The Euclidean norm.
 

OPTIMALITY_NORM_L2 = 2;

OPTIMALITY_NORM_L_INF_COMPONENTWISE

public static final OptimalityNorm OPTIMALITY_NORM_L_INF_COMPONENTWISE

 The infinity norm of component-wise relative errors offset by the ratio of
 the absolute and relative error tolerances, i.e., the l_∞ norm of
 [residual / (eps_ratio + |bound|)], where eps_ratio =
 eps_optimal_{X}_residual_absolute / eps_optimal_{X}_residual_relative
 where {X} is either primal or dual, and bound is the corresponding primal
 or dual bound (that is, the violated constraint bound for primal residuals,
 and the objective coefficient for dual residuals).
 Using eps_ratio in this norm means that if the norm is <=
 eps_optimal_{X}_residual_relative, then the residuals satisfy
 residual <= eps_optimal_{X}_residual_absolute
 + eps_optimal_{X}_residual_relative * |bound|
 

OPTIMALITY_NORM_L_INF_COMPONENTWISE = 3;

Field Detail

OPTIMALITY_NORM_UNSPECIFIED_VALUE

public static final int OPTIMALITY_NORM_UNSPECIFIED_VALUE

OPTIMALITY_NORM_UNSPECIFIED = 0;

See Also:

Constant Field Values

OPTIMALITY_NORM_L_INF_VALUE

public static final int OPTIMALITY_NORM_L_INF_VALUE

 The infinity norm.
 

OPTIMALITY_NORM_L_INF = 1;

See Also:

Constant Field Values

OPTIMALITY_NORM_L2_VALUE

public static final int OPTIMALITY_NORM_L2_VALUE

 The Euclidean norm.
 

OPTIMALITY_NORM_L2 = 2;

See Also:

Constant Field Values

OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE

public static final int OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE

 The infinity norm of component-wise relative errors offset by the ratio of
 the absolute and relative error tolerances, i.e., the l_∞ norm of
 [residual / (eps_ratio + |bound|)], where eps_ratio =
 eps_optimal_{X}_residual_absolute / eps_optimal_{X}_residual_relative
 where {X} is either primal or dual, and bound is the corresponding primal
 or dual bound (that is, the violated constraint bound for primal residuals,
 and the objective coefficient for dual residuals).
 Using eps_ratio in this norm means that if the norm is <=
 eps_optimal_{X}_residual_relative, then the residuals satisfy
 residual <= eps_optimal_{X}_residual_absolute
 + eps_optimal_{X}_residual_relative * |bound|
 

OPTIMALITY_NORM_L_INF_COMPONENTWISE = 3;

See Also:

Constant Field Values

Method Detail

values

public static OptimalityNorm[] 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 (OptimalityNorm c : OptimalityNorm.values())
    System.out.println(c);

Returns:

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

valueOf

public static OptimalityNorm 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 OptimalityNorm 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 OptimalityNorm 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<OptimalityNorm> 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 OptimalityNorm valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)