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

Detailed Description

Protobuf enum operations_research.pdlp.PrimalDualHybridGradientParams.LinesearchRule

Definition at line 264 of file PrimalDualHybridGradientParams.java.

Inheritance diagram for com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule:

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

Public Attributes

 LINESEARCH_RULE_UNSPECIFIED =(0)
 ADAPTIVE_LINESEARCH_RULE =(1)
 MALITSKY_POCK_LINESEARCH_RULE =(2)
 CONSTANT_STEP_SIZE_RULE =(3)

Static Public Attributes

static final int LINESEARCH_RULE_UNSPECIFIED_VALUE = 0
static final int ADAPTIVE_LINESEARCH_RULE_VALUE = 1
static final int MALITSKY_POCK_LINESEARCH_RULE_VALUE = 2
static final int CONSTANT_STEP_SIZE_RULE_VALUE = 3

Member Function Documentation

◆ [static initializer]()

com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.[static initializer]
static

◆ forNumber()

LinesearchRule com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.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 367 of file PrimalDualHybridGradientParams.java.

◆ getDescriptor()

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

Definition at line 398 of file PrimalDualHybridGradientParams.java.

◆ getDescriptorForType()

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

Definition at line 394 of file PrimalDualHybridGradientParams.java.

◆ getNumber()

final int com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.getNumber ( )

Definition at line 349 of file PrimalDualHybridGradientParams.java.

◆ getValueDescriptor()

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

Definition at line 390 of file PrimalDualHybridGradientParams.java.

◆ internalGetValueMap()

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

Definition at line 378 of file PrimalDualHybridGradientParams.java.

◆ valueOf() [1/2]

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

Definition at line 404 of file PrimalDualHybridGradientParams.java.

◆ valueOf() [2/2]

LinesearchRule com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.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 359 of file PrimalDualHybridGradientParams.java.

Member Data Documentation

◆ ADAPTIVE_LINESEARCH_RULE

com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.ADAPTIVE_LINESEARCH_RULE =(1) 
Applies the heuristic rule presented in Section 3.1 of
https://arxiv.org/pdf/2106.04756.pdf (further generalized to QP). There
is not a proof of convergence for it. It is usually the fastest in
practice but sometimes behaves poorly.

ADAPTIVE_LINESEARCH_RULE = 1;

Definition at line 280 of file PrimalDualHybridGradientParams.java.

◆ ADAPTIVE_LINESEARCH_RULE_VALUE

final int com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.ADAPTIVE_LINESEARCH_RULE_VALUE = 1
static 
Applies the heuristic rule presented in Section 3.1 of
https://arxiv.org/pdf/2106.04756.pdf (further generalized to QP). There
is not a proof of convergence for it. It is usually the fastest in
practice but sometimes behaves poorly.

ADAPTIVE_LINESEARCH_RULE = 1;

Definition at line 326 of file PrimalDualHybridGradientParams.java.

◆ CONSTANT_STEP_SIZE_RULE

com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.CONSTANT_STEP_SIZE_RULE =(3) 
Uses a constant step size corresponding to an estimate of the maximum
singular value of the constraint matrix.

CONSTANT_STEP_SIZE_RULE = 3;

Definition at line 300 of file PrimalDualHybridGradientParams.java.

◆ CONSTANT_STEP_SIZE_RULE_VALUE

final int com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.CONSTANT_STEP_SIZE_RULE_VALUE = 3
static 
Uses a constant step size corresponding to an estimate of the maximum
singular value of the constraint matrix.

CONSTANT_STEP_SIZE_RULE = 3;

Definition at line 346 of file PrimalDualHybridGradientParams.java.

◆ LINESEARCH_RULE_UNSPECIFIED

com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.LINESEARCH_RULE_UNSPECIFIED =(0)

LINESEARCH_RULE_UNSPECIFIED = 0;

Definition at line 269 of file PrimalDualHybridGradientParams.java.

◆ LINESEARCH_RULE_UNSPECIFIED_VALUE

final int com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.LINESEARCH_RULE_UNSPECIFIED_VALUE = 0
static

LINESEARCH_RULE_UNSPECIFIED = 0;

Definition at line 315 of file PrimalDualHybridGradientParams.java.

◆ MALITSKY_POCK_LINESEARCH_RULE

com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.MALITSKY_POCK_LINESEARCH_RULE =(2) 
Applies Malitsky & Pock linesearch rule. This guarantees an
ergodic O(1/N) convergence rate https://arxiv.org/pdf/1608.08883.pdf.
This is provably convergent but doesn't usually work as well in practice
as ADAPTIVE_LINESEARCH_RULE.

MALITSKY_POCK_LINESEARCH_RULE = 2;

Definition at line 291 of file PrimalDualHybridGradientParams.java.

◆ MALITSKY_POCK_LINESEARCH_RULE_VALUE

final int com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule.MALITSKY_POCK_LINESEARCH_RULE_VALUE = 2
static 
Applies Malitsky & Pock linesearch rule. This guarantees an
ergodic O(1/N) convergence rate https://arxiv.org/pdf/1608.08883.pdf.
This is provably convergent but doesn't usually work as well in practice
as ADAPTIVE_LINESEARCH_RULE.

MALITSKY_POCK_LINESEARCH_RULE = 2;

Definition at line 337 of file PrimalDualHybridGradientParams.java.

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