ROL::TypeU Namespace Reference

Classes
struct	AlgorithmState
class	Algorithm
	Provides an interface to run unconstrained optimization algorithms. More...
class	BundleAlgorithm
	Provides an interface to run trust-bundle methods for unconstrained optimization algorithms. More...
class	LineSearchAlgorithm
	Provides an interface to run unconstrained line search algorithms. More...
class	TrustRegionAlgorithm
	Provides an interface to run trust-region methods for unconstrained optimization algorithms. More...

Enumerations
enum	EAlgorithmU { ALGORITHM_U_BUNDLE = 0, ALGORITHM_U_LINESEARCH, ALGORITHM_U_TRUSTREGION, ALGORITHM_U_LAST }
	Enumeration of unconstrained algorithm types. More...

Functions
std::string	EAlgorithmUToString (EAlgorithmU alg)
int	isValidAlgorithmU (EAlgorithmU alg)
	Verifies validity of a AlgorithmU enum. More...
EAlgorithmU &	operator++ (EAlgorithmU &type)
EAlgorithmU	operator++ (EAlgorithmU &type, int)
EAlgorithmU &	operator-- (EAlgorithmU &type)
EAlgorithmU	operator-- (EAlgorithmU &type, int)
EAlgorithmU	StringToEAlgorithmU (std::string s)
template<typename Real >
Ptr< Algorithm< Real > >	AlgorithmFactory (ParameterList &parlist, const Ptr< Secant< Real >> &secant=nullPtr)

Enumeration Type Documentation

enum ROL::TypeU::EAlgorithmU

Enumeration of unconstrained algorithm types.

• ALGORITHM_U_BUNDLE describe
• ALGORITHM_U_LINESEARCH describe
• ALGORITHM_U_TRUSTREGION describe

Enumerator
ALGORITHM_U_BUNDLE
ALGORITHM_U_LINESEARCH
ALGORITHM_U_TRUSTREGION
ALGORITHM_U_LAST

Definition at line 28 of file ROL_TypeU_AlgorithmFactory.hpp.

Function Documentation

std::string ROL::TypeU::EAlgorithmUToString ( EAlgorithmU  alg )

inline

Definition at line 35 of file ROL_TypeU_AlgorithmFactory.hpp.

References ALGORITHM_U_BUNDLE, ALGORITHM_U_LAST, ALGORITHM_U_LINESEARCH, and ALGORITHM_U_TRUSTREGION.

Referenced by StringToEAlgorithmU().

int ROL::TypeU::isValidAlgorithmU ( EAlgorithmU  alg )

inline

Verifies validity of a AlgorithmU enum.

Parameters

ls	[in] - enum of the AlgorithmU

Returns

1 if the argument is a valid AlgorithmU; 0 otherwise.

Definition at line 52 of file ROL_TypeU_AlgorithmFactory.hpp.

References ALGORITHM_U_BUNDLE, ALGORITHM_U_LAST, ALGORITHM_U_LINESEARCH, and ALGORITHM_U_TRUSTREGION.

EAlgorithmU& ROL::TypeU::operator++ ( EAlgorithmU &  type )

inline

Definition at line 60 of file ROL_TypeU_AlgorithmFactory.hpp.

EAlgorithmU ROL::TypeU::operator++ ( EAlgorithmU &  type, int    )

inline

Definition at line 64 of file ROL_TypeU_AlgorithmFactory.hpp.

EAlgorithmU& ROL::TypeU::operator-- ( EAlgorithmU &  type )

inline

Definition at line 70 of file ROL_TypeU_AlgorithmFactory.hpp.

EAlgorithmU ROL::TypeU::operator-- ( EAlgorithmU &  type, int    )

inline

Definition at line 74 of file ROL_TypeU_AlgorithmFactory.hpp.

EAlgorithmU ROL::TypeU::StringToEAlgorithmU ( std::string  s )

inline

Definition at line 80 of file ROL_TypeU_AlgorithmFactory.hpp.

References ALGORITHM_U_BUNDLE, ALGORITHM_U_LAST, ALGORITHM_U_TRUSTREGION, EAlgorithmUToString(), and ROL::removeStringFormat().

Referenced by AlgorithmFactory().

template<typename Real >

Ptr<Algorithm<Real> > ROL::TypeU::AlgorithmFactory ( ParameterList &  parlist, const Ptr< Secant< Real >> &  secant = nullPtr  )

inline

Definition at line 91 of file ROL_TypeU_AlgorithmFactory.hpp.

References ALGORITHM_U_BUNDLE, ALGORITHM_U_LINESEARCH, ALGORITHM_U_TRUSTREGION, and StringToEAlgorithmU().