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.MalitskyPockParams Class Referencesealed
Inheritance diagram for Google.OrTools.PDLP.MalitskyPockParams:

Public Member Functions

 MalitskyPockParams ()
 
 MalitskyPockParams (MalitskyPockParams other)
 
MalitskyPockParams Clone ()
 
void ClearStepSizeDownscalingFactor ()
 Clears the value of the "step_size_downscaling_factor" field.
 
void ClearLinesearchContractionFactor ()
 Clears the value of the "linesearch_contraction_factor" field.
 
void ClearStepSizeInterpolation ()
 Clears the value of the "step_size_interpolation" field.
 
override bool Equals (object other)
 
bool Equals (MalitskyPockParams other)
 
override int GetHashCode ()
 
override string ToString ()
 
void WriteTo (pb::CodedOutputStream output)
 
int CalculateSize ()
 
void MergeFrom (MalitskyPockParams other)
 
void MergeFrom (pb::CodedInputStream input)
 

Static Public Attributes

const int StepSizeDownscalingFactorFieldNumber = 1
 Field number for the "step_size_downscaling_factor" field.
 
const int LinesearchContractionFactorFieldNumber = 2
 Field number for the "linesearch_contraction_factor" field.
 
const int StepSizeInterpolationFieldNumber = 3
 Field number for the "step_size_interpolation" field.
 

Properties

static pb::MessageParser< MalitskyPockParams > Parser [get]
 
static pbr::MessageDescriptor Descriptor [get]
 
double StepSizeDownscalingFactor [get, set]
 At every inner iteration the algorithm can decide to accept the step size or to update it to step_size = step_size_downscaling_factor * step_size. This parameter should lie between 0 and 1. The default is the value used in Malitsky and Pock (2016).
 
bool HasStepSizeDownscalingFactor [get]
 Gets whether the "step_size_downscaling_factor" field is set.
 
double LinesearchContractionFactor [get, set]
 Contraction factor used in the linesearch condition of Malitsky and Pock. A step size is accepted if primal_weight * primal_stepsize * norm(constraint_matrix' * (next_dual - current_dual)) is less than linesearch_contraction_factor * norm(next_dual - current_dual). The default is the value used in Malitsky and Pock (2016).
 
bool HasLinesearchContractionFactor [get]
 Gets whether the "linesearch_contraction_factor" field is set.
 
double StepSizeInterpolation [get, set]
 Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M]. This parameter determines where in that interval to pick the step size. In particular, the next stepsize is given by m + step_size_interpolation*(M - m). The default is the value used in Malitsky and Pock (2016).
 
bool HasStepSizeInterpolation [get]
 Gets whether the "step_size_interpolation" field is set.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ MalitskyPockParams() [1/2]

Google.OrTools.PDLP.MalitskyPockParams.MalitskyPockParams ( )
inline

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

◆ MalitskyPockParams() [2/2]

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

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

Member Function Documentation

◆ CalculateSize()

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

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

◆ ClearLinesearchContractionFactor()

void Google.OrTools.PDLP.MalitskyPockParams.ClearLinesearchContractionFactor ( )
inline

Clears the value of the "linesearch_contraction_factor" field.

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

◆ ClearStepSizeDownscalingFactor()

void Google.OrTools.PDLP.MalitskyPockParams.ClearStepSizeDownscalingFactor ( )
inline

Clears the value of the "step_size_downscaling_factor" field.

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

◆ ClearStepSizeInterpolation()

void Google.OrTools.PDLP.MalitskyPockParams.ClearStepSizeInterpolation ( )
inline

Clears the value of the "step_size_interpolation" field.

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

◆ Clone()

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

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

◆ Equals() [1/2]

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

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

◆ Equals() [2/2]

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

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

◆ GetHashCode()

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

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

◆ MergeFrom() [1/2]

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

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

◆ MergeFrom() [2/2]

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

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

◆ ToString()

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

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

◆ WriteTo()

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

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

Member Data Documentation

◆ LinesearchContractionFactorFieldNumber

const int Google.OrTools.PDLP.MalitskyPockParams.LinesearchContractionFactorFieldNumber = 2
static

Field number for the "linesearch_contraction_factor" field.

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

◆ StepSizeDownscalingFactorFieldNumber

const int Google.OrTools.PDLP.MalitskyPockParams.StepSizeDownscalingFactorFieldNumber = 1
static

Field number for the "step_size_downscaling_factor" field.

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

◆ StepSizeInterpolationFieldNumber

const int Google.OrTools.PDLP.MalitskyPockParams.StepSizeInterpolationFieldNumber = 3
static

Field number for the "step_size_interpolation" field.

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

Property Documentation

◆ Descriptor

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

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

◆ HasLinesearchContractionFactor

bool Google.OrTools.PDLP.MalitskyPockParams.HasLinesearchContractionFactor
get

Gets whether the "linesearch_contraction_factor" field is set.

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

◆ HasStepSizeDownscalingFactor

bool Google.OrTools.PDLP.MalitskyPockParams.HasStepSizeDownscalingFactor
get

Gets whether the "step_size_downscaling_factor" field is set.

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

◆ HasStepSizeInterpolation

bool Google.OrTools.PDLP.MalitskyPockParams.HasStepSizeInterpolation
get

Gets whether the "step_size_interpolation" field is set.

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

◆ LinesearchContractionFactor

double Google.OrTools.PDLP.MalitskyPockParams.LinesearchContractionFactor
getset

Contraction factor used in the linesearch condition of Malitsky and Pock. A step size is accepted if primal_weight * primal_stepsize * norm(constraint_matrix' * (next_dual - current_dual)) is less than linesearch_contraction_factor * norm(next_dual - current_dual). The default is the value used in Malitsky and Pock (2016).

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

◆ Parser

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

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

◆ StepSizeDownscalingFactor

double Google.OrTools.PDLP.MalitskyPockParams.StepSizeDownscalingFactor
getset

At every inner iteration the algorithm can decide to accept the step size or to update it to step_size = step_size_downscaling_factor * step_size. This parameter should lie between 0 and 1. The default is the value used in Malitsky and Pock (2016).

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

◆ StepSizeInterpolation

double Google.OrTools.PDLP.MalitskyPockParams.StepSizeInterpolation
getset

Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M]. This parameter determines where in that interval to pick the step size. In particular, the next stepsize is given by m + step_size_interpolation*(M - m). The default is the value used in Malitsky and Pock (2016).

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

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