Package operations_research.pdlp
Enum Solvers.OptimalityNorm
- java.lang.Object
-
- java.lang.Enum<Solvers.OptimalityNorm>
-
- operations_research.pdlp.Solvers.OptimalityNorm
-
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,java.io.Serializable,java.lang.Comparable<Solvers.OptimalityNorm>
- Enclosing class:
- Solvers
public static enum Solvers.OptimalityNorm extends java.lang.Enum<Solvers.OptimalityNorm> implements com.google.protobuf.ProtocolMessageEnum
Protobuf enumoperations_research.pdlp.OptimalityNorm
-
-
Enum Constant Summary
Enum Constants Enum Constant Description OPTIMALITY_NORM_L_INFThe infinity norm.OPTIMALITY_NORM_L_INF_COMPONENTWISEThe 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_L2The Euclidean norm.OPTIMALITY_NORM_UNSPECIFIEDOPTIMALITY_NORM_UNSPECIFIED = 0;
-
Field Summary
Fields Modifier and Type Field Description static intOPTIMALITY_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).static intOPTIMALITY_NORM_L_INF_VALUEThe infinity norm.static intOPTIMALITY_NORM_L2_VALUEThe Euclidean norm.static intOPTIMALITY_NORM_UNSPECIFIED_VALUEOPTIMALITY_NORM_UNSPECIFIED = 0;
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Solvers.OptimalityNormforNumber(int value)static com.google.protobuf.Descriptors.EnumDescriptorgetDescriptor()com.google.protobuf.Descriptors.EnumDescriptorgetDescriptorForType()intgetNumber()com.google.protobuf.Descriptors.EnumValueDescriptorgetValueDescriptor()static com.google.protobuf.Internal.EnumLiteMap<Solvers.OptimalityNorm>internalGetValueMap()static Solvers.OptimalityNormvalueOf(int value)Deprecated.static Solvers.OptimalityNormvalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)Returns the enum constant of this type with the specified name.static Solvers.OptimalityNormvalueOf(java.lang.String name)Returns the enum constant of this type with the specified name.static Solvers.OptimalityNorm[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
OPTIMALITY_NORM_UNSPECIFIED
public static final Solvers.OptimalityNorm OPTIMALITY_NORM_UNSPECIFIED
OPTIMALITY_NORM_UNSPECIFIED = 0;
-
OPTIMALITY_NORM_L_INF
public static final Solvers.OptimalityNorm OPTIMALITY_NORM_L_INF
The infinity norm.
OPTIMALITY_NORM_L_INF = 1;
-
OPTIMALITY_NORM_L2
public static final Solvers.OptimalityNorm OPTIMALITY_NORM_L2
The Euclidean norm.
OPTIMALITY_NORM_L2 = 2;
-
OPTIMALITY_NORM_L_INF_COMPONENTWISE
public static final Solvers.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 Solvers.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 (Solvers.OptimalityNorm c : Solvers.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 Solvers.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 namejava.lang.NullPointerException- if the argument is null
-
getNumber
public final int getNumber()
- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
@Deprecated public static Solvers.OptimalityNorm valueOf(int value)
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:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
forNumber
public static Solvers.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<Solvers.OptimalityNorm> internalGetValueMap()
-
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
-
valueOf
public static Solvers.OptimalityNorm valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
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:
java.lang.IllegalArgumentException- if this enum type has no constant with the specified namejava.lang.NullPointerException- if the argument is null
-
-