ROL::TypeU Namespace Reference

Classes
class	Algorithm
	Provides an interface to run unconstrained optimization algorithms. More...
struct	AlgorithmState
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 }

Functions
std::string	EAlgorithmUToString (EAlgorithmU alg)
int	isValidAlgorithmU (EAlgorithmU alg)
	Verifies validity of a AlgorithmU enum.
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

EAlgorithmU

enum ROL::TypeU::EAlgorithmU

Enumerator
ALGORITHM_U_BUNDLE
ALGORITHM_U_LINESEARCH
ALGORITHM_U_TRUSTREGION
ALGORITHM_U_LAST

Definition at line 62 of file ROL_TypeU_AlgorithmFactory.hpp.

Function Documentation

EAlgorithmUToString()

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

inline

Definition at line 69 of file ROL_TypeU_AlgorithmFactory.hpp.

References ALGORITHM_U_BUNDLE, ALGORITHM_U_LAST, ALGORITHM_U_LINESEARCH, ALGORITHM_U_TRUSTREGION, and EAlgorithmUToString().

Referenced by EAlgorithmUToString(), and StringToEAlgorithmU().

isValidAlgorithmU()

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 86 of file ROL_TypeU_AlgorithmFactory.hpp.

References ALGORITHM_U_BUNDLE, ALGORITHM_U_LAST, ALGORITHM_U_LINESEARCH, ALGORITHM_U_TRUSTREGION, and isValidAlgorithmU().

Referenced by isValidAlgorithmU().

operator++() [1/2]

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

inline

Definition at line 94 of file ROL_TypeU_AlgorithmFactory.hpp.

References operator++().

Referenced by operator++(), and operator++().

operator++() [2/2]

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

inline

Definition at line 98 of file ROL_TypeU_AlgorithmFactory.hpp.

References operator++().

operator--() [1/2]

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

inline

Definition at line 104 of file ROL_TypeU_AlgorithmFactory.hpp.

References operator--().

Referenced by operator--(), and operator--().

operator--() [2/2]

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

inline

Definition at line 108 of file ROL_TypeU_AlgorithmFactory.hpp.

References operator--().

StringToEAlgorithmU()

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

inline

Definition at line 114 of file ROL_TypeU_AlgorithmFactory.hpp.

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

Referenced by AlgorithmFactory(), and StringToEAlgorithmU().

AlgorithmFactory()

template<typename Real>

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

inline

Definition at line 125 of file ROL_TypeU_AlgorithmFactory.hpp.

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

Referenced by AlgorithmFactory(), ROL::ROL::TypeE::AugmentedLagrangianAlgorithm< Real >::run(), ROL::TypeB::InteriorPointAlgorithm< Real >::run(), ROL::TypeB::MoreauYosidaAlgorithm< Real >::run(), ROL::TypeE::FletcherAlgorithm< Real >::run(), and ROL::Solver< Real >::Solver().