Enum OptimalityNorm
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite
,com.google.protobuf.ProtocolMessageEnum
,Serializable
,Comparable<OptimalityNorm>
,java.lang.constant.Constable
@Generated
public enum OptimalityNorm
extends Enum<OptimalityNorm>
implements com.google.protobuf.ProtocolMessageEnum
Protobuf enum
operations_research.pdlp.OptimalityNorm
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe infinity norm.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).The Euclidean norm.OPTIMALITY_NORM_UNSPECIFIED = 0;
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
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 final int
The infinity norm.static final int
The Euclidean norm.static final int
OPTIMALITY_NORM_UNSPECIFIED = 0;
-
Method Summary
Modifier and TypeMethodDescriptionstatic OptimalityNorm
forNumber
(int value) static com.google.protobuf.Descriptors.EnumDescriptor
final com.google.protobuf.Descriptors.EnumDescriptor
final int
final com.google.protobuf.Descriptors.EnumValueDescriptor
static com.google.protobuf.Internal.EnumLiteMap
<OptimalityNorm> static OptimalityNorm
valueOf
(int value) Deprecated.static OptimalityNorm
valueOf
(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.static OptimalityNorm
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.
-
Enum Constant Details
-
OPTIMALITY_NORM_UNSPECIFIED
OPTIMALITY_NORM_UNSPECIFIED = 0;
-
OPTIMALITY_NORM_L_INF
The infinity norm.
OPTIMALITY_NORM_L_INF = 1;
-
OPTIMALITY_NORM_L2
The Euclidean norm.
OPTIMALITY_NORM_L2 = 2;
-
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 Details
-
OPTIMALITY_NORM_UNSPECIFIED_VALUE
public static final int OPTIMALITY_NORM_UNSPECIFIED_VALUEOPTIMALITY_NORM_UNSPECIFIED = 0;
- See Also:
-
OPTIMALITY_NORM_L_INF_VALUE
public static final int OPTIMALITY_NORM_L_INF_VALUEThe infinity norm.
OPTIMALITY_NORM_L_INF = 1;
- See Also:
-
OPTIMALITY_NORM_L2_VALUE
public static final int OPTIMALITY_NORM_L2_VALUEThe Euclidean norm.
OPTIMALITY_NORM_L2 = 2;
- See Also:
-
OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE
public static final int OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUEThe 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:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumber
in interfacecom.google.protobuf.Internal.EnumLite
- Specified by:
getNumber
in interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.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:
value
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
forNumber
- Parameters:
value
- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
-
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptor
in interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
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:
desc
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-