Google OR-Tools v9.14
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
com.google.ortools.pdlp.OptimalityNorm Enum Reference

Detailed Description

Protobuf enum operations_research.pdlp.OptimalityNorm

Definition at line 12 of file OptimalityNorm.java.

Inheritance diagram for com.google.ortools.pdlp.OptimalityNorm:

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 initializer]
static OptimalityNorm valueOf (int value)
static OptimalityNorm forNumber (int value)
static com.google.protobuf.Internal.EnumLiteMap< OptimalityNorminternalGetValueMap ()
static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor ()
static OptimalityNorm valueOf (com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Public Attributes

 OPTIMALITY_NORM_UNSPECIFIED =(0)
 OPTIMALITY_NORM_L_INF =(1)
 OPTIMALITY_NORM_L2 =(2)
 OPTIMALITY_NORM_L_INF_COMPONENTWISE =(3)

Static Public Attributes

static final int OPTIMALITY_NORM_UNSPECIFIED_VALUE = 0
static final int OPTIMALITY_NORM_L_INF_VALUE = 1
static final int OPTIMALITY_NORM_L2_VALUE = 2
static final int OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE = 3

Member Function Documentation

◆ [static initializer]()

com.google.ortools.pdlp.OptimalityNorm.[static initializer]
static

◆ forNumber()

OptimalityNorm com.google.ortools.pdlp.OptimalityNorm.forNumber ( int value)
static
Parameters
valueThe numeric wire value of the corresponding enum entry.
Returns
The enum associated with the given numeric wire value.

Definition at line 121 of file OptimalityNorm.java.

◆ getDescriptor()

com.google.protobuf.Descriptors.EnumDescriptor com.google.ortools.pdlp.OptimalityNorm.getDescriptor ( )
static

Definition at line 152 of file OptimalityNorm.java.

◆ getDescriptorForType()

final com.google.protobuf.Descriptors.EnumDescriptor com.google.ortools.pdlp.OptimalityNorm.getDescriptorForType ( )

Definition at line 148 of file OptimalityNorm.java.

◆ getNumber()

final int com.google.ortools.pdlp.OptimalityNorm.getNumber ( )

Definition at line 103 of file OptimalityNorm.java.

◆ getValueDescriptor()

final com.google.protobuf.Descriptors.EnumValueDescriptor com.google.ortools.pdlp.OptimalityNorm.getValueDescriptor ( )

Definition at line 144 of file OptimalityNorm.java.

◆ internalGetValueMap()

com.google.protobuf.Internal.EnumLiteMap< OptimalityNorm > com.google.ortools.pdlp.OptimalityNorm.internalGetValueMap ( )
static

Definition at line 132 of file OptimalityNorm.java.

◆ valueOf() [1/2]

OptimalityNorm com.google.ortools.pdlp.OptimalityNorm.valueOf ( com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static

Definition at line 158 of file OptimalityNorm.java.

◆ valueOf() [2/2]

OptimalityNorm com.google.ortools.pdlp.OptimalityNorm.valueOf ( int value)
static
Parameters
valueThe 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 113 of file OptimalityNorm.java.

Member Data Documentation

◆ OPTIMALITY_NORM_L2

com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_L2 =(2)
The Euclidean norm.

OPTIMALITY_NORM_L2 = 2;

Definition at line 33 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_L2_VALUE

final int com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_L2_VALUE = 2
static
The Euclidean norm.

OPTIMALITY_NORM_L2 = 2;

Definition at line 82 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_L_INF

com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_L_INF =(1)
The infinity norm.

OPTIMALITY_NORM_L_INF = 1;

Definition at line 25 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_L_INF_COMPONENTWISE

com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_L_INF_COMPONENTWISE =(3)
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;

Definition at line 51 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE

final int com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_L_INF_COMPONENTWISE_VALUE = 3
static
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;

Definition at line 100 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_L_INF_VALUE

final int com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_L_INF_VALUE = 1
static
The infinity norm.

OPTIMALITY_NORM_L_INF = 1;

Definition at line 74 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_UNSPECIFIED

com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_UNSPECIFIED =(0)

OPTIMALITY_NORM_UNSPECIFIED = 0;

Definition at line 17 of file OptimalityNorm.java.

◆ OPTIMALITY_NORM_UNSPECIFIED_VALUE

final int com.google.ortools.pdlp.OptimalityNorm.OPTIMALITY_NORM_UNSPECIFIED_VALUE = 0
static

OPTIMALITY_NORM_UNSPECIFIED = 0;

Definition at line 66 of file OptimalityNorm.java.


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