ROL::ROL Namespace Reference

Namespaces
namespace	details
namespace	Exception
namespace	Finite_Difference_Arrays
namespace	TRUtils
namespace	TypeE
namespace	TypeU

Classes
class	AffineTransformConstraint
	Compose a constraint operator with an affine transformation, i.e.,. More...
class	AffineTransformObjective
	Compose an objective function with an affine transformation, i.e.,. More...
class	Algorithm
	Provides an interface to run unconstrained optimization algorithms. More...
struct	AlgorithmState
	State for algorithm class. Will be used for restarts. More...
class	AugmentedLagrangianObjective
	Provides the interface to evaluate the augmented Lagrangian. More...
class	BackTracking_U
	Implements a simple back tracking line search. More...
class	BarzilaiBorwein
	Provides definitions for Barzilai-Borwein operators. More...
class	BoundConstraint
	Provides the interface to apply upper and lower bound constraints. More...
class	Bundle_U
	Provides the interface for and implements a bundle. More...
class	Bundle_U_AS
	Provides the interface for and implements an active set bundle. More...
class	Bundle_U_TT
	Provides the interface for and implements a bundle. The semidefinite quadratic subproblem is solved using TT algorithm by Antonio Frangioni (1996). More...
class	BundleStatusTest
class	CauchyPoint_U
	Provides interface for the Cauchy point trust-region subproblem solver. More...
class	CombinedStatusTest
	Provides an interface to check two status tests of optimization algorithms. More...
class	Constraint
	Defines the general constraint operator interface. More...
class	Constraint_SimOpt
class	ConstraintStatusTest
	Provides an interface to check status of optimization algorithms for problems with equality constraints. More...
class	CubicInterp_U
	Implements cubic interpolation back tracking line search. More...
class	DescentDirection_U
	Provides the interface to compute unconstrained optimization steps for line search. More...
class	DogLeg_U
	Provides interface for dog leg trust-region subproblem solver. More...
class	DoubleDogLeg_U
	Provides interface for the double dog leg trust-region subproblem solver. More...
class	Gradient_U
	Provides the interface to compute optimization steps with the gradient descent method globalized using line search. More...
class	IterationScaling_U
	Provides an implementation of iteration scaled line search. More...
class	lBFGS
	Provides definitions for limited-memory BFGS operators. More...
class	lDFP
	Provides definitions for limited-memory DFP operators. More...
class	LinearConstraint
	Defines the general affine constraint with the form \(c(x)=Ax+b\). More...
class	LinearOperator
	Provides the interface to apply a linear operator. More...
class	LineSearch_U
	Provides interface for and implements line searches. More...
class	lSR1
	Provides definitions for limited-memory SR1 operators. More...
class	NonlinearLeastSquaresObjective
	Provides the interface to evaluate nonlinear least squares objective functions. More...
class	NullSpaceOperator
	Projects on to the null space of a linear constraint. More...
class	Objective
	Provides the interface to evaluate objective functions. More...
class	Objective_FSsolver
class	PathBasedTargetLevel_U
	Provides an implementation of path-based target leve line search. More...
class	QuadraticPenalty
	Provides the interface to evaluate the quadratic constraint penalty. More...
class	QuasiNewton_U
	Provides the interface to compute optimization steps with a secant method. More...
class	RangeSpaceOperator
	Projects on to the null space of a linear constraint. More...
class	ReduceLinearConstraint
	Performs null-space transformation for reducible linear equality constraints. More...
struct	removeSpecialCharacters
class	ScalarController
class	ScalarMinimizationLineSearch_U
	Implements line search methods that attempt to minimize the scalar function \(\phi(t) := f(x+ts)\). More...
struct	ScalarTraits
struct	ScalarTraits_Magnitude
struct	ScalarTraits_Magnitude< std::complex< Real > >
class	Secant
	Provides interface for and implements limited-memory secant operators. More...
struct	SecantState
class	SimConstraint
class	SingletonVector
class	SPGTrustRegion_U
	Provides interface for truncated CG trust-region subproblem solver. More...
class	StatusTest
	Provides an interface to check status of optimization algorithms. More...
class	Step
	Provides the interface to compute optimization steps. More...
struct	StepState
	State for step class. Will be used for restarts. More...
class	TruncatedCG_U
	Provides interface for truncated CG trust-region subproblem solver. More...
class	TrustRegion_U
	Provides interface for and implements trust-region subproblem solvers. More...
class	TrustRegionModel_U
	Provides the interface to evaluate trust-region model functions. More...
struct	TypeCaster
struct	TypeCaster< double, float >
struct	TypeCaster< Real, std::complex< Real > >
class	Vector
	Defines the linear algebra or vector space interface. More...
class	Vector_SimOpt
	Defines the linear algebra or vector space interface for simulation-based optimization. More...
class	VectorController

Enumerations
enum class	UpdateType : std::uint8_t {   Initial = 0 , Accept , Revert , Trial ,   Temp }
enum	EExitStatus {   EXITSTATUS_CONVERGED = 0 , EXITSTATUS_MAXITER , EXITSTATUS_STEPTOL , EXITSTATUS_NAN ,   EXITSTATUS_USERDEFINED , EXITSTATUS_LAST }
	Enum for algorithm termination. More...
enum	EProblem {   TYPE_U = 0 , TYPE_B , TYPE_E , TYPE_EB ,   TYPE_LAST }
enum	EStep {   STEP_AUGMENTEDLAGRANGIAN = 0 , STEP_BUNDLE , STEP_COMPOSITESTEP , STEP_LINESEARCH ,   STEP_MOREAUYOSIDAPENALTY , STEP_PRIMALDUALACTIVESET , STEP_TRUSTREGION , STEP_INTERIORPOINT ,   STEP_FLETCHER , STEP_LAST }
	Enumeration of step types. More...
enum	EDescent {   DESCENT_STEEPEST = 0 , DESCENT_NONLINEARCG , DESCENT_SECANT , DESCENT_NEWTON ,   DESCENT_NEWTONKRYLOV , DESCENT_LAST }
	Enumeration of descent direction types. More...
enum	ESecant {   SECANT_LBFGS = 0 , SECANT_LDFP , SECANT_LSR1 , SECANT_BARZILAIBORWEIN ,   SECANT_USERDEFINED , SECANT_LAST }
	Enumeration of secant update algorithms. More...
enum	ENonlinearCG {   NONLINEARCG_HESTENES_STIEFEL = 0 , NONLINEARCG_FLETCHER_REEVES , NONLINEARCG_DANIEL , NONLINEARCG_POLAK_RIBIERE ,   NONLINEARCG_FLETCHER_CONJDESC , NONLINEARCG_LIU_STOREY , NONLINEARCG_DAI_YUAN , NONLINEARCG_HAGER_ZHANG ,   NONLINEARCG_OREN_LUENBERGER , NONLINEARCG_USERDEFINED , NONLINEARCG_LAST }
	Enumeration of nonlinear CG algorithms. More...
enum	ELineSearch {   LINESEARCH_ITERATIONSCALING = 0 , LINESEARCH_PATHBASEDTARGETLEVEL , LINESEARCH_BACKTRACKING , LINESEARCH_BISECTION ,   LINESEARCH_GOLDENSECTION , LINESEARCH_CUBICINTERP , LINESEARCH_BRENTS , LINESEARCH_USERDEFINED ,   LINESEARCH_LAST }
	Enumeration of line-search types. More...
enum	ECurvatureCondition {   CURVATURECONDITION_WOLFE = 0 , CURVATURECONDITION_STRONGWOLFE , CURVATURECONDITION_GENERALIZEDWOLFE , CURVATURECONDITION_APPROXIMATEWOLFE ,   CURVATURECONDITION_GOLDSTEIN , CURVATURECONDITION_NULL , CURVATURECONDITION_LAST }
	Enumeration of line-search curvature conditions. More...
enum	ECGFlag {   CG_FLAG_SUCCESS = 0 , CG_FLAG_ITEREXCEED , CG_FLAG_NEGCURVE , CG_FLAG_TRRADEX ,   CG_FLAG_ZERORHS , CG_FLAG_UNDEFINED }
	Enumation of flags used by conjugate gradient methods. More...
enum	ETrustRegionU {   TRUSTREGION_U_CAUCHYPOINT = 0 , TRUSTREGION_U_TRUNCATEDCG , TRUSTREGION_U_SPG , TRUSTREGION_U_DOGLEG ,   TRUSTREGION_U_DOUBLEDOGLEG , TRUSTREGION_U_LAST }
	Enumeration of trust-region solver types. More...
enum	ESecantMode { SECANTMODE_FORWARD = 0 , SECANTMODE_INVERSE , SECANTMODE_BOTH }
enum	EDescentU {   DESCENT_U_STEEPEST = 0 , DESCENT_U_NONLINEARCG , DESCENT_U_SECANT , DESCENT_U_NEWTON ,   DESCENT_U_NEWTONKRYLOV , DESCENT_U_USERDEFINED , DESCENT_U_LAST }
	Enumeration of descent direction types. More...
enum	ELineSearchU {   LINESEARCH_U_ITERATIONSCALING = 0 , LINESEARCH_U_PATHBASEDTARGETLEVEL , LINESEARCH_U_BACKTRACKING , LINESEARCH_U_BISECTION ,   LINESEARCH_U_GOLDENSECTION , LINESEARCH_U_CUBICINTERP , LINESEARCH_U_BRENTS , LINESEARCH_U_USERDEFINED ,   LINESEARCH_U_LAST }
	Enumeration of line-search types. More...
enum	ECurvatureConditionU {   CURVATURECONDITION_U_WOLFE = 0 , CURVATURECONDITION_U_STRONGWOLFE , CURVATURECONDITION_U_GENERALIZEDWOLFE , CURVATURECONDITION_U_APPROXIMATEWOLFE ,   CURVATURECONDITION_U_GOLDSTEIN , CURVATURECONDITION_U_NULL , CURVATURECONDITION_U_LAST }
	Enumeration of line-search curvature conditions. More...

Functions
std::string	UpdateTypeToString (const UpdateType &type)
template<class T >
std::string	NumberToString (T Number)
template<class Real >
Real	ROL_EPSILON (void)
	Platform-dependent machine epsilon.
template<class Real >
Real	ROL_THRESHOLD (void)
	Tolerance for various equality tests.
template<class Real >
Real	ROL_OVERFLOW (void)
	Platform-dependent maximum double.
template<class Real >
Real	ROL_INF (void)
template<class Real >
Real	ROL_NINF (void)
template<class Real >
Real	ROL_UNDERFLOW (void)
	Platform-dependent minimum double.
std::string	EExitStatusToString (EExitStatus tr)
std::string	removeStringFormat (std::string s)
std::string	EStepToString (EStep tr)
bool	isCompatibleStep (EProblem p, EStep s)
std::string	EProblemToString (EProblem p)
int	isValidStep (EStep ls)
	Verifies validity of a TrustRegion enum.
EStep &	operator++ (EStep &type)
EStep	operator++ (EStep &type, int)
EStep &	operator-- (EStep &type)
EStep	operator-- (EStep &type, int)
EStep	StringToEStep (std::string s)
std::string	EDescentToString (EDescent tr)
int	isValidDescent (EDescent d)
	Verifies validity of a Secant enum.
EDescent &	operator++ (EDescent &type)
EDescent	operator++ (EDescent &type, int)
EDescent &	operator-- (EDescent &type)
EDescent	operator-- (EDescent &type, int)
EDescent	StringToEDescent (std::string s)
std::string	ESecantToString (ESecant tr)
int	isValidSecant (ESecant s)
	Verifies validity of a Secant enum.
ESecant &	operator++ (ESecant &type)
ESecant	operator++ (ESecant &type, int)
ESecant &	operator-- (ESecant &type)
ESecant	operator-- (ESecant &type, int)
ESecant	StringToESecant (std::string s)
std::string	ENonlinearCGToString (ENonlinearCG tr)
int	isValidNonlinearCG (ENonlinearCG s)
	Verifies validity of a NonlinearCG enum.
ENonlinearCG &	operator++ (ENonlinearCG &type)
ENonlinearCG	operator++ (ENonlinearCG &type, int)
ENonlinearCG &	operator-- (ENonlinearCG &type)
ENonlinearCG	operator-- (ENonlinearCG &type, int)
ENonlinearCG	StringToENonlinearCG (std::string s)
std::string	ELineSearchToString (ELineSearch ls)
int	isValidLineSearch (ELineSearch ls)
	Verifies validity of a LineSearch enum.
ELineSearch &	operator++ (ELineSearch &type)
ELineSearch	operator++ (ELineSearch &type, int)
ELineSearch &	operator-- (ELineSearch &type)
ELineSearch	operator-- (ELineSearch &type, int)
ELineSearch	StringToELineSearch (std::string s)
std::string	ECurvatureConditionToString (ECurvatureCondition ls)
int	isValidCurvatureCondition (ECurvatureCondition ls)
	Verifies validity of a CurvatureCondition enum.
ECurvatureCondition &	operator++ (ECurvatureCondition &type)
ECurvatureCondition	operator++ (ECurvatureCondition &type, int)
ECurvatureCondition &	operator-- (ECurvatureCondition &type)
ECurvatureCondition	operator-- (ECurvatureCondition &type, int)
ECurvatureCondition	StringToECurvatureCondition (std::string s)
std::string	ECGFlagToString (ECGFlag cgf)
template<class Element , class Real >
Real	rol_cast (const Element &val)
template<template< typename > class V, typename Real , typename P = Ptr<Vector<Real>>>
std::enable_if< std::is_base_of< Vector< Real >, V< Real > >::value, P >::type	make_Vector_SimOpt (const Ptr< V< Real > > &vsim, const Ptr< V< Real > > &vopt)
ROL::Ptr< const ROL::ParameterList >	getValidROLParameters ()
ROL::Ptr< const ROL::ParameterList >	getValidSOLParameters ()
std::string	ETrustRegionUToString (ETrustRegionU tr)
int	isValidTrustRegionU (ETrustRegionU ls)
	Verifies validity of a TrustRegionU enum.
ETrustRegionU &	operator++ (ETrustRegionU &type)
ETrustRegionU	operator++ (ETrustRegionU &type, int)
ETrustRegionU &	operator-- (ETrustRegionU &type)
ETrustRegionU	operator-- (ETrustRegionU &type, int)
ETrustRegionU	StringToETrustRegionU (std::string s)
template<class Real >
ROL::Ptr< Secant< Real > >	getSecant (ESecant esec=SECANT_LBFGS, int L=10, int BBtype=1)
template<class Real >
ROL::Ptr< Secant< Real > >	SecantFactory (ROL::ParameterList &parlist, ESecantMode mode=SECANTMODE_BOTH)
template<typename Real >
Ptr< TrustRegion_U< Real > >	TrustRegionUFactory (ParameterList &list)
std::string	EDescentUToString (EDescentU tr)
int	isValidDescentU (EDescentU d)
	Verifies validity of a DescentU enum.
EDescentU &	operator++ (EDescentU &type)
EDescentU	operator++ (EDescentU &type, int)
EDescentU &	operator-- (EDescentU &type)
EDescentU	operator-- (EDescentU &type, int)
EDescentU	StringToEDescentU (std::string s)
std::string	ELineSearchUToString (ELineSearchU ls)
int	isValidLineSearchU (ELineSearchU ls)
	Verifies validity of a LineSearchU enum.
ELineSearchU &	operator++ (ELineSearchU &type)
ELineSearchU	operator++ (ELineSearchU &type, int)
ELineSearchU &	operator-- (ELineSearchU &type)
ELineSearchU	operator-- (ELineSearchU &type, int)
ELineSearchU	StringToELineSearchU (std::string s)
std::string	ECurvatureConditionUToString (ECurvatureConditionU ls)
int	isValidCurvatureConditionU (ECurvatureConditionU ls)
	Verifies validity of a CurvatureConditionU enum.
ECurvatureConditionU &	operator++ (ECurvatureConditionU &type)
ECurvatureConditionU	operator++ (ECurvatureConditionU &type, int)
ECurvatureConditionU &	operator-- (ECurvatureConditionU &type)
ECurvatureConditionU	operator-- (ECurvatureConditionU &type, int)
ECurvatureConditionU	StringToECurvatureConditionU (std::string s)
template<typename Real >
Ptr< LineSearch_U< Real > >	LineSearchUFactory (ParameterList &parlist)

Enumeration Type Documentation

UpdateType

enum class ROL::ROL::UpdateType : std::uint8_t

strong

Enumerator
Initial
Accept
Revert
Trial
Temp

Definition at line 52 of file ROL_Constraint_SerialSimOpt.hpp.

EExitStatus

enum ROL::ROL::EExitStatus

Enum for algorithm termination.

Enumerator
EXITSTATUS_CONVERGED
EXITSTATUS_MAXITER
EXITSTATUS_STEPTOL
EXITSTATUS_NAN
EXITSTATUS_USERDEFINED
EXITSTATUS_LAST

Definition at line 117 of file ROL_Constraint_SerialSimOpt.hpp.

EProblem

enum ROL::ROL::EProblem

Enumerator
TYPE_U
TYPE_B
TYPE_E
TYPE_EB
TYPE_LAST

Definition at line 257 of file ROL_Constraint_SerialSimOpt.hpp.

EStep

enum ROL::ROL::EStep

Enumeration of step types.

• AUGMENTEDLAGRANGIAN describe
• BUNDLE describe
• COMPOSITESTEP describe
• LINESEARCH describe
• MOREAUYOSIDAPENALTY describe
• PRIMALDUALACTIVESET describe
• TRUSTREGION describe

Enumerator
STEP_AUGMENTEDLAGRANGIAN
STEP_BUNDLE
STEP_COMPOSITESTEP
STEP_LINESEARCH
STEP_MOREAUYOSIDAPENALTY
STEP_PRIMALDUALACTIVESET
STEP_TRUSTREGION
STEP_INTERIORPOINT
STEP_FLETCHER
STEP_LAST

Definition at line 276 of file ROL_Constraint_SerialSimOpt.hpp.

EDescent

enum ROL::ROL::EDescent

Enumeration of descent direction types.

• STEEPEST describe
• NONLINEARCG describe
• SECANT describe
• NEWTON describe
• NEWTONKRYLOV describe
• SECANTPRECOND describe

Enumerator
DESCENT_STEEPEST
DESCENT_NONLINEARCG
DESCENT_SECANT
DESCENT_NEWTON
DESCENT_NEWTONKRYLOV
DESCENT_LAST

Definition at line 411 of file ROL_Constraint_SerialSimOpt.hpp.

ESecant

enum ROL::ROL::ESecant

Enumeration of secant update algorithms.

• LBFGS describe
• LDFP describe
• LSR1 describe
• BARZILAIBORWEIN describe

Enumerator
SECANT_LBFGS
SECANT_LDFP
SECANT_LSR1
SECANT_BARZILAIBORWEIN
SECANT_USERDEFINED
SECANT_LAST

Definition at line 486 of file ROL_Constraint_SerialSimOpt.hpp.

ENonlinearCG

enum ROL::ROL::ENonlinearCG

Enumeration of nonlinear CG algorithms.

• HESTENES_STIEFEL \( \frac{g_{k+1}^\top y_k}{d_k^\top y_k } \)
• FLETCHER_REEVES \( \frac{\|g_{k+1}\|^2}{\|g_k\|^2} \)
• DANIEL \( \frac{g_{k+1}^\top \nabla^2 f(x_k) d_k}{d_k^\top \nabla^2 f(x_k) d_k} \)
• POLAK_RIBIERE \( \frac{g_{k+1}^\top y_k}{\|g_k\|^2} \)
• FLETCHER_CONJDESC \( -\frac{\|g_{k+1}\|^2}{d_k^\top g_k} \)
• LIU_STOREY \( -\frac{g_k^\top y_{k-1} }{d_{k-1}^\top g_{k-1} \)
• DAI_YUAN \( \frac{\|g_{k+1}\|^2}{d_k^\top y_k} \)
• HAGER_ZHANG \( \frac{g_{k+1}^\top y_k}{d_k^\top y_k} - 2 \frac{\|y_k\|^2}{d_k^\top y_k} \frac{g_{k+1}^\top d_k}{d_k^\top y_k} \)
• OREN_LUENBERGER \( \frac{g_{k+1}^\top y_k}{d_k^\top y_k} - \frac{\|y_k\|^2}{d_k^\top y_k} \frac{g_{k+1}^\top d_k}{d_k^\top y_k} \)

Enumerator
NONLINEARCG_HESTENES_STIEFEL
NONLINEARCG_FLETCHER_REEVES
NONLINEARCG_DANIEL
NONLINEARCG_POLAK_RIBIERE
NONLINEARCG_FLETCHER_CONJDESC
NONLINEARCG_LIU_STOREY
NONLINEARCG_DAI_YUAN
NONLINEARCG_HAGER_ZHANG
NONLINEARCG_OREN_LUENBERGER
NONLINEARCG_USERDEFINED
NONLINEARCG_LAST

Definition at line 566 of file ROL_Constraint_SerialSimOpt.hpp.

ELineSearch

enum ROL::ROL::ELineSearch

Enumeration of line-search types.

• BACKTRACKING describe
• BISECTION describe
• GOLDENSECTION describe
• CUBICINTERP describe
• BRENTS describe
• USERDEFINED describe

Enumerator
LINESEARCH_ITERATIONSCALING
LINESEARCH_PATHBASEDTARGETLEVEL
LINESEARCH_BACKTRACKING
LINESEARCH_BISECTION
LINESEARCH_GOLDENSECTION
LINESEARCH_CUBICINTERP
LINESEARCH_BRENTS
LINESEARCH_USERDEFINED
LINESEARCH_LAST

Definition at line 658 of file ROL_Constraint_SerialSimOpt.hpp.

ECurvatureCondition

enum ROL::ROL::ECurvatureCondition

Enumeration of line-search curvature conditions.

• WOLFE describe
• STRONGWOLFE describe
• GOLDSTEIN describe

Enumerator
CURVATURECONDITION_WOLFE
CURVATURECONDITION_STRONGWOLFE
CURVATURECONDITION_GENERALIZEDWOLFE
CURVATURECONDITION_APPROXIMATEWOLFE
CURVATURECONDITION_GOLDSTEIN
CURVATURECONDITION_NULL
CURVATURECONDITION_LAST

Definition at line 741 of file ROL_Constraint_SerialSimOpt.hpp.

ECGFlag

enum ROL::ROL::ECGFlag

Enumation of flags used by conjugate gradient methods.

• CG_FLAG_SUCCESS Residual Tolerance Met
• CG_FLAG_ITEREXCEED Iteration Limit Exceeded
• CG_FLAG_NEGCURVE Negative Curvature Detected \arh CG_FLAG_TRRADEX Trust-Region Radius Exceeded \arh CG_FLAG_ZERORHS Initiali Right Hand Side is Zero

Enumerator
CG_FLAG_SUCCESS
CG_FLAG_ITEREXCEED
CG_FLAG_NEGCURVE
CG_FLAG_TRRADEX
CG_FLAG_ZERORHS
CG_FLAG_UNDEFINED

Definition at line 821 of file ROL_Constraint_SerialSimOpt.hpp.

ETrustRegionU

enum ROL::ROL::ETrustRegionU

Enumeration of trust-region solver types.

• TRUSTREGION_U_CAUCHYPOINT describe
• TRUSTREGION_U_TRUNCATEDCG describe
• TRUSTREGION_U_SPG describe
• TRUSTREGION_U_DOGLEG describe
• TRUSTREGION_U_DOUBLEDOGLEG describe

Enumerator
TRUSTREGION_U_CAUCHYPOINT
TRUSTREGION_U_TRUNCATEDCG
TRUSTREGION_U_SPG
TRUSTREGION_U_DOGLEG
TRUSTREGION_U_DOUBLEDOGLEG
TRUSTREGION_U_LAST

Definition at line 64 of file ROL_Constraint_SerialSimOpt.hpp.

ESecantMode

enum ROL::ROL::ESecantMode

Enumerator
SECANTMODE_FORWARD
SECANTMODE_INVERSE
SECANTMODE_BOTH

Definition at line 57 of file ROL_Constraint_SerialSimOpt.hpp.

EDescentU

enum ROL::ROL::EDescentU

Enumeration of descent direction types.

• DESCENT_U_STEEPEST describe
• DESCENT_U_NONLINEARCG describe
• DESCENT_U_SECANT describe
• DESCENT_U_NEWTON describe
• DESCENT_U_NEWTONKRYLOV describe
• DESCENT_U_SECANTPRECOND describe

Enumerator
DESCENT_U_STEEPEST
DESCENT_U_NONLINEARCG
DESCENT_U_SECANT
DESCENT_U_NEWTON
DESCENT_U_NEWTONKRYLOV
DESCENT_U_USERDEFINED
DESCENT_U_LAST

Definition at line 64 of file ROL_Constraint_SerialSimOpt.hpp.

ELineSearchU

enum ROL::ROL::ELineSearchU

Enumeration of line-search types.

• LINESEARCH_U_BACKTRACKING describe
• LINESEARCH_U_BISECTION describe
• LINESEARCH_U_GOLDENSECTION describe
• LINESEARCH_U_CUBICINTERP describe
• LINESEARCH_U_BRENTS describe
• LINESEARCH_U_USERDEFINED describe

Enumerator
LINESEARCH_U_ITERATIONSCALING
LINESEARCH_U_PATHBASEDTARGETLEVEL
LINESEARCH_U_BACKTRACKING
LINESEARCH_U_BISECTION
LINESEARCH_U_GOLDENSECTION
LINESEARCH_U_CUBICINTERP
LINESEARCH_U_BRENTS
LINESEARCH_U_USERDEFINED
LINESEARCH_U_LAST

Definition at line 144 of file ROL_Constraint_SerialSimOpt.hpp.

ECurvatureConditionU

enum ROL::ROL::ECurvatureConditionU

Enumeration of line-search curvature conditions.

• CURVATURECONDITION_U_WOLFE describe
• CURVATURECONDITION_U_STRONGWOLFE describe
• CURVATURECONDITION_U_GOLDSTEIN describe

Enumerator
CURVATURECONDITION_U_WOLFE
CURVATURECONDITION_U_STRONGWOLFE
CURVATURECONDITION_U_GENERALIZEDWOLFE
CURVATURECONDITION_U_APPROXIMATEWOLFE
CURVATURECONDITION_U_GOLDSTEIN
CURVATURECONDITION_U_NULL
CURVATURECONDITION_U_LAST

Definition at line 227 of file ROL_Constraint_SerialSimOpt.hpp.

Function Documentation

UpdateTypeToString()

std::string ROL::ROL::UpdateTypeToString ( const UpdateType & type )

inline

Definition at line 61 of file ROL_Constraint_SerialSimOpt.hpp.

NumberToString()

template<class T >

std::string ROL::ROL::NumberToString

(

T

Number

)

Definition at line 81 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_EPSILON()

template<class Real >

Real ROL::ROL::ROL_EPSILON ( void )

inline

Platform-dependent machine epsilon.

Definition at line 91 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::StdObjective< Real >::gradient().

ROL_THRESHOLD()

template<class Real >

Real ROL::ROL::ROL_THRESHOLD ( void )

inline

Tolerance for various equality tests.

Definition at line 97 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_OVERFLOW()

template<class Real >

Real ROL::ROL::ROL_OVERFLOW ( void )

inline

Platform-dependent maximum double.

Definition at line 102 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_INF()

template<class Real >

Real ROL::ROL::ROL_INF ( void )

inline

Definition at line 105 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_NINF()

template<class Real >

Real ROL::ROL::ROL_NINF ( void )

inline

Definition at line 108 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_UNDERFLOW()

template<class Real >

Real ROL::ROL::ROL_UNDERFLOW ( void )

inline

Platform-dependent minimum double.

Definition at line 113 of file ROL_Constraint_SerialSimOpt.hpp.

EExitStatusToString()

std::string ROL::ROL::EExitStatusToString ( EExitStatus tr )

inline

Definition at line 126 of file ROL_Constraint_SerialSimOpt.hpp.

removeStringFormat()

std::string ROL::ROL::removeStringFormat ( std::string s )

inline

Definition at line 249 of file ROL_Constraint_SerialSimOpt.hpp.

EStepToString()

std::string ROL::ROL::EStepToString ( EStep tr )

inline

Definition at line 289 of file ROL_Constraint_SerialSimOpt.hpp.

isCompatibleStep()

bool ROL::ROL::isCompatibleStep ( EProblem p, EStep s )

inline

Definition at line 307 of file ROL_Constraint_SerialSimOpt.hpp.

EProblemToString()

std::string ROL::ROL::EProblemToString ( EProblem p )

inline

Definition at line 340 of file ROL_Constraint_SerialSimOpt.hpp.

isValidStep()

int ROL::ROL::isValidStep ( EStep ls )

inline

Verifies validity of a TrustRegion enum.

Parameters

tr	[in] - enum of the TrustRegion

Returns

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

Definition at line 359 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [1/20]

EStep & ROL::ROL::operator++ ( EStep & type )

inline

Definition at line 371 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [2/20]

EStep ROL::ROL::operator++ ( EStep & type, int  )

inline

Definition at line 375 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [1/20]

EStep & ROL::ROL::operator-- ( EStep & type )

inline

Definition at line 381 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [2/20]

EStep ROL::ROL::operator-- ( EStep & type, int  )

inline

Definition at line 385 of file ROL_Constraint_SerialSimOpt.hpp.

StringToEStep()

EStep ROL::ROL::StringToEStep ( std::string s )

inline

Definition at line 391 of file ROL_Constraint_SerialSimOpt.hpp.

EDescentToString()

std::string ROL::ROL::EDescentToString ( EDescent tr )

inline

Definition at line 420 of file ROL_Constraint_SerialSimOpt.hpp.

isValidDescent()

int ROL::ROL::isValidDescent ( EDescent d )

inline

Verifies validity of a Secant enum.

Parameters

tr	[in] - enum of the Secant

Returns

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

Definition at line 439 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [3/20]

EDescent & ROL::ROL::operator++ ( EDescent & type )

inline

Definition at line 448 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [4/20]

EDescent ROL::ROL::operator++ ( EDescent & type, int  )

inline

Definition at line 452 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [3/20]

EDescent & ROL::ROL::operator-- ( EDescent & type )

inline

Definition at line 458 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [4/20]

EDescent ROL::ROL::operator-- ( EDescent & type, int  )

inline

Definition at line 462 of file ROL_Constraint_SerialSimOpt.hpp.

StringToEDescent()

EDescent ROL::ROL::StringToEDescent ( std::string s )

inline

Definition at line 468 of file ROL_Constraint_SerialSimOpt.hpp.

ESecantToString()

std::string ROL::ROL::ESecantToString ( ESecant tr )

inline

Definition at line 495 of file ROL_Constraint_SerialSimOpt.hpp.

isValidSecant()

int ROL::ROL::isValidSecant ( ESecant s )

inline

Verifies validity of a Secant enum.

Parameters

tr	[in] - enum of the Secant

Returns

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

Definition at line 514 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [5/20]

ESecant & ROL::ROL::operator++ ( ESecant & type )

inline

Definition at line 523 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [6/20]

ESecant ROL::ROL::operator++ ( ESecant & type, int  )

inline

Definition at line 527 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [5/20]

ESecant & ROL::ROL::operator-- ( ESecant & type )

inline

Definition at line 533 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [6/20]

ESecant ROL::ROL::operator-- ( ESecant & type, int  )

inline

Definition at line 537 of file ROL_Constraint_SerialSimOpt.hpp.

StringToESecant()

ESecant ROL::ROL::StringToESecant ( std::string s )

inline

Definition at line 543 of file ROL_Constraint_SerialSimOpt.hpp.

ENonlinearCGToString()

std::string ROL::ROL::ENonlinearCGToString ( ENonlinearCG tr )

inline

Definition at line 580 of file ROL_Constraint_SerialSimOpt.hpp.

isValidNonlinearCG()

int ROL::ROL::isValidNonlinearCG ( ENonlinearCG s )

inline

Verifies validity of a NonlinearCG enum.

Parameters

tr	[in] - enum of the NonlinearCG

Returns

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

Definition at line 604 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [7/20]

ENonlinearCG & ROL::ROL::operator++ ( ENonlinearCG & type )

inline

Definition at line 618 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [8/20]

ENonlinearCG ROL::ROL::operator++ ( ENonlinearCG & type, int  )

inline

Definition at line 622 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [7/20]

ENonlinearCG & ROL::ROL::operator-- ( ENonlinearCG & type )

inline

Definition at line 628 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [8/20]

ENonlinearCG ROL::ROL::operator-- ( ENonlinearCG & type, int  )

inline

Definition at line 632 of file ROL_Constraint_SerialSimOpt.hpp.

StringToENonlinearCG()

ENonlinearCG ROL::ROL::StringToENonlinearCG ( std::string s )

inline

Definition at line 638 of file ROL_Constraint_SerialSimOpt.hpp.

ELineSearchToString()

std::string ROL::ROL::ELineSearchToString ( ELineSearch ls )

inline

Definition at line 670 of file ROL_Constraint_SerialSimOpt.hpp.

isValidLineSearch()

int ROL::ROL::isValidLineSearch ( ELineSearch ls )

inline

Verifies validity of a LineSearch enum.

Parameters

ls	[in] - enum of the linesearch

Returns

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

Definition at line 692 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [9/20]

ELineSearch & ROL::ROL::operator++ ( ELineSearch & type )

inline

Definition at line 704 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [10/20]

ELineSearch ROL::ROL::operator++ ( ELineSearch & type, int  )

inline

Definition at line 708 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [9/20]

ELineSearch & ROL::ROL::operator-- ( ELineSearch & type )

inline

Definition at line 714 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [10/20]

ELineSearch ROL::ROL::operator-- ( ELineSearch & type, int  )

inline

Definition at line 718 of file ROL_Constraint_SerialSimOpt.hpp.

StringToELineSearch()

ELineSearch ROL::ROL::StringToELineSearch ( std::string s )

inline

Definition at line 724 of file ROL_Constraint_SerialSimOpt.hpp.

ECurvatureConditionToString()

std::string ROL::ROL::ECurvatureConditionToString ( ECurvatureCondition ls )

inline

Definition at line 751 of file ROL_Constraint_SerialSimOpt.hpp.

isValidCurvatureCondition()

int ROL::ROL::isValidCurvatureCondition ( ECurvatureCondition ls )

inline

Verifies validity of a CurvatureCondition enum.

Parameters

ls	[in] - enum of the Curvature Conditions

Returns

1 if the argument is a valid curvature condition; 0 otherwise.

Definition at line 771 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [11/20]

ECurvatureCondition & ROL::ROL::operator++ ( ECurvatureCondition & type )

inline

Definition at line 781 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [12/20]

ECurvatureCondition ROL::ROL::operator++ ( ECurvatureCondition & type, int  )

inline

Definition at line 785 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [11/20]

ECurvatureCondition & ROL::ROL::operator-- ( ECurvatureCondition & type )

inline

Definition at line 791 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [12/20]

ECurvatureCondition ROL::ROL::operator-- ( ECurvatureCondition & type, int  )

inline

Definition at line 795 of file ROL_Constraint_SerialSimOpt.hpp.

StringToECurvatureCondition()

ECurvatureCondition ROL::ROL::StringToECurvatureCondition ( std::string s )

inline

Definition at line 801 of file ROL_Constraint_SerialSimOpt.hpp.

ECGFlagToString()

std::string ROL::ROL::ECGFlagToString ( ECGFlag cgf )

inline

Definition at line 831 of file ROL_Constraint_SerialSimOpt.hpp.

rol_cast()

template<class Element , class Real >

Real ROL::ROL::rol_cast

(

const Element &

val

)

Definition at line 903 of file ROL_Constraint_SerialSimOpt.hpp.

make_Vector_SimOpt()

template<template< typename > class V, typename Real , typename P = Ptr<Vector<Real>>>

std::enable_if< std::is_base_of< Vector< Real >, V< Real > >::value, P >::type ROL::ROL::make_Vector_SimOpt ( const Ptr< V< Real > > & vsim, const Ptr< V< Real > > & vopt )

inline

Definition at line 208 of file ROL_Constraint_SerialSimOpt.hpp.

getValidROLParameters()

ROL::Ptr< const ROL::ParameterList > ROL::ROL::getValidROLParameters ( )

inline

Definition at line 55 of file ROL_Constraint_SerialSimOpt.hpp.

getValidSOLParameters()

ROL::Ptr< const ROL::ParameterList > ROL::ROL::getValidSOLParameters ( )

inline

Definition at line 290 of file ROL_Constraint_SerialSimOpt.hpp.

ETrustRegionUToString()

std::string ROL::ROL::ETrustRegionUToString ( ETrustRegionU tr )

inline

Definition at line 73 of file ROL_Constraint_SerialSimOpt.hpp.

isValidTrustRegionU()

int ROL::ROL::isValidTrustRegionU ( ETrustRegionU ls )

inline

Verifies validity of a TrustRegionU enum.

Parameters

tr	[in] - enum of the TrustRegionU

Returns

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

Definition at line 92 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [13/20]

ETrustRegionU & ROL::ROL::operator++ ( ETrustRegionU & type )

inline

Definition at line 101 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [14/20]

ETrustRegionU ROL::ROL::operator++ ( ETrustRegionU & type, int  )

inline

Definition at line 105 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [13/20]

ETrustRegionU & ROL::ROL::operator-- ( ETrustRegionU & type )

inline

Definition at line 111 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [14/20]

ETrustRegionU ROL::ROL::operator-- ( ETrustRegionU & type, int  )

inline

Definition at line 115 of file ROL_Constraint_SerialSimOpt.hpp.

StringToETrustRegionU()

ETrustRegionU ROL::ROL::StringToETrustRegionU ( std::string s )

inline

Definition at line 121 of file ROL_Constraint_SerialSimOpt.hpp.

getSecant()

template<class Real >

ROL::Ptr< Secant< Real > > ROL::ROL::getSecant ( ESecant esec = SECANT_LBFGS, int L = 10, int BBtype = 1 )

inline

Definition at line 60 of file ROL_Constraint_SerialSimOpt.hpp.

SecantFactory()

template<class Real >

ROL::Ptr< Secant< Real > > ROL::ROL::SecantFactory ( ROL::ParameterList & parlist, ESecantMode mode = SECANTMODE_BOTH )

inline

Definition at line 71 of file ROL_Constraint_SerialSimOpt.hpp.

TrustRegionUFactory()

template<typename Real >

Ptr< TrustRegion_U< Real > > ROL::ROL::TrustRegionUFactory ( ParameterList & list )

inline

Definition at line 61 of file ROL_Constraint_SerialSimOpt.hpp.

EDescentUToString()

std::string ROL::ROL::EDescentUToString ( EDescentU tr )

inline

Definition at line 74 of file ROL_Constraint_SerialSimOpt.hpp.

isValidDescentU()

int ROL::ROL::isValidDescentU ( EDescentU d )

inline

Verifies validity of a DescentU enum.

Parameters

tr	[in] - enum of the DescentU

Returns

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

Definition at line 94 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [15/20]

EDescentU & ROL::ROL::operator++ ( EDescentU & type )

inline

Definition at line 104 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [16/20]

EDescentU ROL::ROL::operator++ ( EDescentU & type, int  )

inline

Definition at line 108 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [15/20]

EDescentU & ROL::ROL::operator-- ( EDescentU & type )

inline

Definition at line 114 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [16/20]

EDescentU ROL::ROL::operator-- ( EDescentU & type, int  )

inline

Definition at line 118 of file ROL_Constraint_SerialSimOpt.hpp.

StringToEDescentU()

EDescentU ROL::ROL::StringToEDescentU ( std::string s )

inline

Definition at line 124 of file ROL_Constraint_SerialSimOpt.hpp.

ELineSearchUToString()

std::string ROL::ROL::ELineSearchUToString ( ELineSearchU ls )

inline

Definition at line 156 of file ROL_Constraint_SerialSimOpt.hpp.

isValidLineSearchU()

int ROL::ROL::isValidLineSearchU ( ELineSearchU ls )

inline

Verifies validity of a LineSearchU enum.

Parameters

ls	[in] - enum of the linesearch

Returns

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

Definition at line 178 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [17/20]

ELineSearchU & ROL::ROL::operator++ ( ELineSearchU & type )

inline

Definition at line 190 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [18/20]

ELineSearchU ROL::ROL::operator++ ( ELineSearchU & type, int  )

inline

Definition at line 194 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [17/20]

ELineSearchU & ROL::ROL::operator-- ( ELineSearchU & type )

inline

Definition at line 200 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [18/20]

ELineSearchU ROL::ROL::operator-- ( ELineSearchU & type, int  )

inline

Definition at line 204 of file ROL_Constraint_SerialSimOpt.hpp.

StringToELineSearchU()

ELineSearchU ROL::ROL::StringToELineSearchU ( std::string s )

inline

Definition at line 210 of file ROL_Constraint_SerialSimOpt.hpp.

ECurvatureConditionUToString()

std::string ROL::ROL::ECurvatureConditionUToString ( ECurvatureConditionU ls )

inline

Definition at line 237 of file ROL_Constraint_SerialSimOpt.hpp.

isValidCurvatureConditionU()

int ROL::ROL::isValidCurvatureConditionU ( ECurvatureConditionU ls )

inline

Verifies validity of a CurvatureConditionU enum.

Parameters

ls	[in] - enum of the Curvature Conditions

Returns

1 if the argument is a valid curvature condition; 0 otherwise.

Definition at line 257 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [19/20]

ECurvatureConditionU & ROL::ROL::operator++ ( ECurvatureConditionU & type )

inline

Definition at line 267 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [20/20]

ECurvatureConditionU ROL::ROL::operator++ ( ECurvatureConditionU & type, int  )

inline

Definition at line 271 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [19/20]

ECurvatureConditionU & ROL::ROL::operator-- ( ECurvatureConditionU & type )

inline

Definition at line 277 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [20/20]

ECurvatureConditionU ROL::ROL::operator-- ( ECurvatureConditionU & type, int  )

inline

Definition at line 281 of file ROL_Constraint_SerialSimOpt.hpp.

StringToECurvatureConditionU()

ECurvatureConditionU ROL::ROL::StringToECurvatureConditionU ( std::string s )

inline

Definition at line 287 of file ROL_Constraint_SerialSimOpt.hpp.

LineSearchUFactory()

template<typename Real >

Ptr< LineSearch_U< Real > > ROL::ROL::LineSearchUFactory ( ParameterList & parlist )

inline

Definition at line 55 of file ROL_Constraint_SerialSimOpt.hpp.