Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
MathOpt::FRPRConfig Struct Reference

Configuration for FRPR conjugate gradient method. More...

#include <MathOpt_FRPR.hxx>

Inheritance diagram for MathOpt::FRPRConfig:
Inheritance graph
[legend]

Public Member Functions

 FRPRConfig ()=default
 Default constructor.
 
 FRPRConfig (double theTolerance, int theMaxIter=100)
 Constructor with tolerance.
 
- Public Member Functions inherited from MathUtils::Config
 Config ()=default
 Default constructor with standard tolerances.
 
 Config (double theTolerance, int theMaxIter=100)
 Constructor with custom tolerance (sets all tolerances to same value).
 

Data Fields

ConjugateGradientFormula Formula = ConjugateGradientFormula::PolakRibiere
 Beta formula.
 
int RestartInterval = 0
 Restart every N iterations (0 = n, where n is dimension)
 
- Data Fields inherited from MathUtils::Config
int MaxIterations = 100
 Maximum number of iterations allowed.
 
double Tolerance = 1.0e-10
 General convergence tolerance.
 
double XTolerance = 1.0e-10
 Tolerance for solution change |x_{n+1} - x_n|.
 
double FTolerance = 1.0e-10
 Tolerance for function value |f(x)|.
 
double StepMin = std::numeric_limits<double>::epsilon()
 Minimum step size before declaring convergence or failure.
 

Detailed Description

Configuration for FRPR conjugate gradient method.

Constructor & Destructor Documentation

◆ FRPRConfig() [1/2]

MathOpt::FRPRConfig::FRPRConfig ( )
default

Default constructor.

◆ FRPRConfig() [2/2]

MathOpt::FRPRConfig::FRPRConfig ( double theTolerance,
int theMaxIter = 100 )
inlineexplicit

Constructor with tolerance.

Field Documentation

◆ Formula

Beta formula.

◆ RestartInterval

int MathOpt::FRPRConfig::RestartInterval = 0

Restart every N iterations (0 = n, where n is dimension)


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