Google OR-Tools v9.11
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Properties | List of all members
Google.OrTools.PDLP.AdaptiveLinesearchParams Class Referencesealed

At the end of each iteration, regardless of whether the step was accepted or not, the adaptive rule updates the step_size as the minimum of two potential step sizes defined by the following two exponents. More...

Inheritance diagram for Google.OrTools.PDLP.AdaptiveLinesearchParams:

Public Member Functions

 AdaptiveLinesearchParams ()
 
 AdaptiveLinesearchParams (AdaptiveLinesearchParams other)
 
AdaptiveLinesearchParams Clone ()
 
void ClearStepSizeReductionExponent ()
 Clears the value of the "step_size_reduction_exponent" field.
 
void ClearStepSizeGrowthExponent ()
 Clears the value of the "step_size_growth_exponent" field.
 
override bool Equals (object other)
 
bool Equals (AdaptiveLinesearchParams other)
 
override int GetHashCode ()
 
override string ToString ()
 
void WriteTo (pb::CodedOutputStream output)
 
int CalculateSize ()
 
void MergeFrom (AdaptiveLinesearchParams other)
 
void MergeFrom (pb::CodedInputStream input)
 

Static Public Attributes

const int StepSizeReductionExponentFieldNumber = 1
 Field number for the "step_size_reduction_exponent" field.
 
const int StepSizeGrowthExponentFieldNumber = 2
 Field number for the "step_size_growth_exponent" field.
 

Properties

static pb::MessageParser< AdaptiveLinesearchParams > Parser [get]
 
static pbr::MessageDescriptor Descriptor [get]
 
double StepSizeReductionExponent [get, set]
 The step size reduction exponent defines a step size given by (1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) * step_size_limit where step_size_limit is the maximum allowed step size at the current iteration. This should be between 0.1 and 1.
 
bool HasStepSizeReductionExponent [get]
 Gets whether the "step_size_reduction_exponent" field is set.
 
double StepSizeGrowthExponent [get, set]
 The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_. This should be between 0.1 and 1.
 
bool HasStepSizeGrowthExponent [get]
 Gets whether the "step_size_growth_exponent" field is set.
 

Detailed Description

At the end of each iteration, regardless of whether the step was accepted or not, the adaptive rule updates the step_size as the minimum of two potential step sizes defined by the following two exponents.

Definition at line 1680 of file Solvers.pb.cs.

Constructor & Destructor Documentation

◆ AdaptiveLinesearchParams() [1/2]

Google.OrTools.PDLP.AdaptiveLinesearchParams.AdaptiveLinesearchParams ( )
inline

Definition at line 1706 of file Solvers.pb.cs.

◆ AdaptiveLinesearchParams() [2/2]

Google.OrTools.PDLP.AdaptiveLinesearchParams.AdaptiveLinesearchParams ( AdaptiveLinesearchParams other)
inline

Definition at line 1714 of file Solvers.pb.cs.

Member Function Documentation

◆ CalculateSize()

int Google.OrTools.PDLP.AdaptiveLinesearchParams.CalculateSize ( )
inline

Definition at line 1870 of file Solvers.pb.cs.

◆ ClearStepSizeGrowthExponent()

void Google.OrTools.PDLP.AdaptiveLinesearchParams.ClearStepSizeGrowthExponent ( )
inline

Clears the value of the "step_size_growth_exponent" field.

Definition at line 1788 of file Solvers.pb.cs.

◆ ClearStepSizeReductionExponent()

void Google.OrTools.PDLP.AdaptiveLinesearchParams.ClearStepSizeReductionExponent ( )
inline

Clears the value of the "step_size_reduction_exponent" field.

Definition at line 1756 of file Solvers.pb.cs.

◆ Clone()

AdaptiveLinesearchParams Google.OrTools.PDLP.AdaptiveLinesearchParams.Clone ( )
inline

Definition at line 1723 of file Solvers.pb.cs.

◆ Equals() [1/2]

bool Google.OrTools.PDLP.AdaptiveLinesearchParams.Equals ( AdaptiveLinesearchParams other)
inline

Definition at line 1800 of file Solvers.pb.cs.

◆ Equals() [2/2]

override bool Google.OrTools.PDLP.AdaptiveLinesearchParams.Equals ( object other)
inline

Definition at line 1794 of file Solvers.pb.cs.

◆ GetHashCode()

override int Google.OrTools.PDLP.AdaptiveLinesearchParams.GetHashCode ( )
inline

Definition at line 1814 of file Solvers.pb.cs.

◆ MergeFrom() [1/2]

void Google.OrTools.PDLP.AdaptiveLinesearchParams.MergeFrom ( AdaptiveLinesearchParams other)
inline

Definition at line 1886 of file Solvers.pb.cs.

◆ MergeFrom() [2/2]

void Google.OrTools.PDLP.AdaptiveLinesearchParams.MergeFrom ( pb.CodedInputStream input)
inline

Definition at line 1901 of file Solvers.pb.cs.

◆ ToString()

override string Google.OrTools.PDLP.AdaptiveLinesearchParams.ToString ( )
inline

Definition at line 1826 of file Solvers.pb.cs.

◆ WriteTo()

void Google.OrTools.PDLP.AdaptiveLinesearchParams.WriteTo ( pb.CodedOutputStream output)
inline

Definition at line 1832 of file Solvers.pb.cs.

Member Data Documentation

◆ StepSizeGrowthExponentFieldNumber

const int Google.OrTools.PDLP.AdaptiveLinesearchParams.StepSizeGrowthExponentFieldNumber = 2
static

Field number for the "step_size_growth_exponent" field.

Definition at line 1761 of file Solvers.pb.cs.

◆ StepSizeReductionExponentFieldNumber

const int Google.OrTools.PDLP.AdaptiveLinesearchParams.StepSizeReductionExponentFieldNumber = 1
static

Field number for the "step_size_reduction_exponent" field.

Definition at line 1728 of file Solvers.pb.cs.

Property Documentation

◆ Descriptor

pbr.MessageDescriptor Google.OrTools.PDLP.AdaptiveLinesearchParams.Descriptor
staticget

Definition at line 1694 of file Solvers.pb.cs.

◆ HasStepSizeGrowthExponent

bool Google.OrTools.PDLP.AdaptiveLinesearchParams.HasStepSizeGrowthExponent
get

Gets whether the "step_size_growth_exponent" field is set.

Definition at line 1782 of file Solvers.pb.cs.

◆ HasStepSizeReductionExponent

bool Google.OrTools.PDLP.AdaptiveLinesearchParams.HasStepSizeReductionExponent
get

Gets whether the "step_size_reduction_exponent" field is set.

Definition at line 1750 of file Solvers.pb.cs.

◆ Parser

pb.MessageParser<AdaptiveLinesearchParams> Google.OrTools.PDLP.AdaptiveLinesearchParams.Parser
staticget

Definition at line 1690 of file Solvers.pb.cs.

◆ StepSizeGrowthExponent

double Google.OrTools.PDLP.AdaptiveLinesearchParams.StepSizeGrowthExponent
getset

The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_. This should be between 0.1 and 1.

Definition at line 1772 of file Solvers.pb.cs.

◆ StepSizeReductionExponent

double Google.OrTools.PDLP.AdaptiveLinesearchParams.StepSizeReductionExponent
getset

The step size reduction exponent defines a step size given by (1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) * step_size_limit where step_size_limit is the maximum allowed step size at the current iteration. This should be between 0.1 and 1.

Definition at line 1740 of file Solvers.pb.cs.

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