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

Classes

class  Algorithm
 
struct  AlgorithmState
 
class  AugmentedLagrangianAlgorithm
 Provides an interface to run equality constrained optimization algorithms using Augmented Lagrangians. More...
 
class  CompositeStepAlgorithm
 Provides an interface to run equality constrained optimization algorithms using the Composite-Step Trust-Region Sequential Quadratic Programming (SQP) method. More...
 
class  FletcherAlgorithm
 Provides an interface to run equality constrained optimization algorithms using Fletcher's exact penalty. More...
 
class  StabilizedLCLAlgorithm
 Provides an interface to run equality constrained optimization algorithms using Stabilized LCL. More...
 

Enumerations

enum  EAlgorithmE {
  ALGORITHM_E_AUGMENTEDLAGRANGIAN = 0, ALGORITHM_E_FLETCHER, ALGORITHM_E_COMPOSITESTEP, ALGORITHM_E_STABILIZEDLCL,
  ALGORITHM_E_LAST
}
 

Functions

std::string EAlgorithmEToString (EAlgorithmE alg)
 
int isValidAlgorithmE (EAlgorithmE alg)
 Verifies validity of a AlgorithmE enum. More...
 
EAlgorithmEoperator++ (EAlgorithmE &type)
 
EAlgorithmE operator++ (EAlgorithmE &type, int)
 
EAlgorithmEoperator-- (EAlgorithmE &type)
 
EAlgorithmE operator-- (EAlgorithmE &type, int)
 
EAlgorithmE StringToEAlgorithmE (std::string s)
 
template<typename Real >
Ptr< TypeE::Algorithm< Real > > AlgorithmFactory (ParameterList &parlist)
 

Enumeration Type Documentation

◆ EAlgorithmE

Enumerator
ALGORITHM_E_AUGMENTEDLAGRANGIAN 
ALGORITHM_E_FLETCHER 
ALGORITHM_E_COMPOSITESTEP 
ALGORITHM_E_STABILIZEDLCL 
ALGORITHM_E_LAST 

Definition at line 59 of file ROL_TypeE_AlgorithmFactory.hpp.

Function Documentation

◆ EAlgorithmEToString()

std::string ROL::TypeE::EAlgorithmEToString ( EAlgorithmE  alg)
inline

◆ isValidAlgorithmE()

int ROL::TypeE::isValidAlgorithmE ( EAlgorithmE  alg)
inline

Verifies validity of a AlgorithmE enum.

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

Definition at line 85 of file ROL_TypeE_AlgorithmFactory.hpp.

References ALGORITHM_E_AUGMENTEDLAGRANGIAN, ALGORITHM_E_COMPOSITESTEP, ALGORITHM_E_FLETCHER, ALGORITHM_E_LAST, and ALGORITHM_E_STABILIZEDLCL.

◆ operator++() [1/2]

EAlgorithmE& ROL::TypeE::operator++ ( EAlgorithmE type)
inline

Definition at line 94 of file ROL_TypeE_AlgorithmFactory.hpp.

◆ operator++() [2/2]

EAlgorithmE ROL::TypeE::operator++ ( EAlgorithmE type,
int   
)
inline

Definition at line 98 of file ROL_TypeE_AlgorithmFactory.hpp.

◆ operator--() [1/2]

EAlgorithmE& ROL::TypeE::operator-- ( EAlgorithmE type)
inline

Definition at line 104 of file ROL_TypeE_AlgorithmFactory.hpp.

◆ operator--() [2/2]

EAlgorithmE ROL::TypeE::operator-- ( EAlgorithmE type,
int   
)
inline

Definition at line 108 of file ROL_TypeE_AlgorithmFactory.hpp.

◆ StringToEAlgorithmE()

EAlgorithmE ROL::TypeE::StringToEAlgorithmE ( std::string  s)
inline

◆ AlgorithmFactory()

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