ROL
Classes | Enumerations | Functions
ROL::TypeB Namespace Reference

Classes

class  Algorithm
 Provides an interface to run bound constrained optimization algorithms. More...
 
struct  AlgorithmState
 
class  ColemanLiAlgorithm
 Provides an interface to run the affine-scaling trust-region algorithm of Coleman and Li. More...
 
class  GradientAlgorithm
 Provides an interface to run the projected gradient algorithm. More...
 
class  InteriorPointAlgorithm
 Provides an interface to run the Moreau-Yosida algorithm. More...
 
class  KelleySachsAlgorithm
 Provides an interface to run the trust-region algorithm of Kelley and Sachs. More...
 
class  LinMoreAlgorithm
 Provides an interface to run the trust-region algorithm of Lin and More. More...
 
class  LSecantBAlgorithm
 Provides an interface to run the line-search algorithm of Byrd, Lu, Nocedal and Zhu (similar to L-BFGS-B). More...
 
class  MoreauYosidaAlgorithm
 Provides an interface to run the Moreau-Yosida algorithm. More...
 
class  NewtonKrylovAlgorithm
 Provides an interface to run the projected secant algorithm. More...
 
class  PrimalDualActiveSetAlgorithm
 Provides an interface to run the projected secant algorithm. More...
 
class  QuasiNewtonAlgorithm
 Provides an interface to run the projected secant algorithm. More...
 
class  SpectralGradientAlgorithm
 Provides an interface to run the spectral projected gradient algorithm. More...
 
class  TrustRegionSPGAlgorithm
 Provides an interface to run the trust-region algorithm. More...
 

Enumerations

enum  EAlgorithmB {
  ALGORITHM_B_LINESEARCH = 0 , ALGORITHM_B_TRUSTREGION , ALGORITHM_B_MOREAUYOSIDA , ALGORITHM_B_PRIMALDUALACTIVESET ,
  ALGORITHM_B_INTERIORPOINT , ALGORITHM_B_SPECTRALGRADIENT , ALGORITHM_B_LAST
}
 

Functions

std::string EAlgorithmBToString (EAlgorithmB alg)
 
int isValidAlgorithmB (EAlgorithmB alg)
 Verifies validity of a AlgorithmB enum.
 
EAlgorithmBoperator++ (EAlgorithmB &type)
 
EAlgorithmB operator++ (EAlgorithmB &type, int)
 
EAlgorithmBoperator-- (EAlgorithmB &type)
 
EAlgorithmB operator-- (EAlgorithmB &type, int)
 
EAlgorithmB StringToEAlgorithmB (std::string s)
 
template<typename Real >
Ptr< Algorithm< Real > > AlgorithmFactory (ParameterList &parlist)
 

Enumeration Type Documentation

◆ EAlgorithmB

Enumerator
ALGORITHM_B_LINESEARCH 
ALGORITHM_B_TRUSTREGION 
ALGORITHM_B_MOREAUYOSIDA 
ALGORITHM_B_PRIMALDUALACTIVESET 
ALGORITHM_B_INTERIORPOINT 
ALGORITHM_B_SPECTRALGRADIENT 
ALGORITHM_B_LAST 

Definition at line 74 of file ROL_TypeB_AlgorithmFactory.hpp.

Function Documentation

◆ EAlgorithmBToString()

std::string ROL::TypeB::EAlgorithmBToString ( EAlgorithmB alg)
inline

◆ isValidAlgorithmB()

int ROL::TypeB::isValidAlgorithmB ( EAlgorithmB alg)
inline

Verifies validity of a AlgorithmB enum.

Parameters
ls[in] - enum of the AlgorithmB
Returns
1 if the argument is a valid AlgorithmB; 0 otherwise.

Definition at line 104 of file ROL_TypeB_AlgorithmFactory.hpp.

References ALGORITHM_B_INTERIORPOINT, ALGORITHM_B_LAST, ALGORITHM_B_LINESEARCH, ALGORITHM_B_MOREAUYOSIDA, ALGORITHM_B_PRIMALDUALACTIVESET, ALGORITHM_B_SPECTRALGRADIENT, and ALGORITHM_B_TRUSTREGION.

◆ operator++() [1/2]

EAlgorithmB & ROL::TypeB::operator++ ( EAlgorithmB & type)
inline

Definition at line 115 of file ROL_TypeB_AlgorithmFactory.hpp.

◆ operator++() [2/2]

EAlgorithmB ROL::TypeB::operator++ ( EAlgorithmB & type,
int  )
inline

Definition at line 119 of file ROL_TypeB_AlgorithmFactory.hpp.

◆ operator--() [1/2]

EAlgorithmB & ROL::TypeB::operator-- ( EAlgorithmB & type)
inline

Definition at line 125 of file ROL_TypeB_AlgorithmFactory.hpp.

◆ operator--() [2/2]

EAlgorithmB ROL::TypeB::operator-- ( EAlgorithmB & type,
int  )
inline

Definition at line 129 of file ROL_TypeB_AlgorithmFactory.hpp.

◆ StringToEAlgorithmB()

EAlgorithmB ROL::TypeB::StringToEAlgorithmB ( std::string s)
inline

◆ AlgorithmFactory()

template<typename Real >
Ptr< Algorithm< Real > > ROL::TypeB::AlgorithmFactory ( ParameterList & parlist)
inline