ROL::ROL Namespace Reference

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

Classes
class	Vector
struct	ScalarTraits_Magnitude
struct	ScalarTraits_Magnitude< std::complex< Real > >
struct	ScalarTraits
struct	AlgorithmState
	State for algorithm class. Will be used for restarts. More...
struct	StepState
	State for step class. Will be used for restarts. More...
struct	removeSpecialCharacters
struct	TypeCaster
struct	TypeCaster< Real, std::complex< Real > >
struct	TypeCaster< double, float >
class	Constraint
class	Vector_SimOpt
class	Constraint_SimOpt
class	Objective
class	NonlinearLeastSquaresObjective
class	SimConstraint
class	Objective_FSsolver
class	StatusTest
class	CombinedStatusTest
class	LinearOperator
class	LinearConstraint
class	VectorController
class	AffineTransformObjective
class	AffineTransformConstraint
class	NullSpaceOperator
class	RangeSpaceOperator
class	ReduceLinearConstraint
struct	SecantState
class	Secant
class	lBFGS
class	lDFP
class	lSR1
class	BarzilaiBorwein
class	TrustRegionModel_U
class	TrustRegion_U
class	CauchyPoint_U
class	DogLeg_U
class	DoubleDogLeg_U
class	TruncatedCG_U
class	SPGTrustRegion_U
class	ConstraintStatusTest
class	Constraint_TimeSimOpt
class	PartitionedVector
class	VectorWorkspace

Typedefs
using	nullstream

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_P , 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 }

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)
template<typename Real>
PartitionedVector< Real > &	partition (Vector< Real > &x)
template<typename Real>
const PartitionedVector< Real > &	partition (const Vector< Real > &x)
template<typename Real>
Ptr< PartitionedVector< Real > >	partition (const Ptr< Vector< Real > > &x)
template<typename Real>
Ptr< const PartitionedVector< Real > >	partition (const Ptr< const Vector< Real > > &x)
template<class Real>
ROL::Ptr< Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< Vector< Real > > &a)
template<class Real>
ROL::Ptr< const Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< const Vector< Real > > &a)
template<class Real>
ROL::Ptr< Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< Vector< Real > > &a, const ROL::Ptr< Vector< Real > > &b)
template<class Real>
ROL::Ptr< const Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< const Vector< Real > > &a, const ROL::Ptr< const Vector< Real > > &b)
template<class Real>
ROL::Ptr< Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< Vector< Real > > &a, const ROL::Ptr< Vector< Real > > &b, const ROL::Ptr< Vector< Real > > &c)
template<class Real>
ROL::Ptr< const Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< const Vector< Real > > &a, const ROL::Ptr< const Vector< Real > > &b, const ROL::Ptr< const Vector< Real > > &c)
template<class Real>
ROL::Ptr< Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< Vector< Real > > &a, const ROL::Ptr< Vector< Real > > &b, const ROL::Ptr< Vector< Real > > &c, const ROL::Ptr< Vector< Real > > &d)
template<class Real>
ROL::Ptr< const Vector< Real > >	CreatePartitionedVector (const ROL::Ptr< const Vector< Real > > &a, const ROL::Ptr< const Vector< Real > > &b, const ROL::Ptr< const Vector< Real > > &c, const ROL::Ptr< const Vector< Real > > &d)
Ptr< std::ostream >	makeStreamPtr (std::ostream &os, bool noSuppressOutput=true)

Typedef Documentation

nullstream

using ROL::ROL::details::nullstream

Definition at line 37 of file ROL_Constraint_SerialSimOpt.hpp.

Enumeration Type Documentation

UpdateType

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

strong

Enumerator
Initial
Accept
Revert
Trial
Temp

Definition at line 19 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 83 of file ROL_Constraint_SerialSimOpt.hpp.

EProblem

enum ROL::ROL::EProblem

Enumerator
TYPE_U
TYPE_P
TYPE_B
TYPE_E
TYPE_EB
TYPE_LAST

Definition at line 223 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 243 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 381 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 456 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 536 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 628 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 711 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 791 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 30 of file ROL_Constraint_SerialSimOpt.hpp.

ESecantMode

enum ROL::ROL::ESecantMode

Enumerator
SECANTMODE_FORWARD
SECANTMODE_INVERSE
SECANTMODE_BOTH

Definition at line 23 of file ROL_Constraint_SerialSimOpt.hpp.

Function Documentation

UpdateTypeToString()

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

inline

Definition at line 28 of file ROL_Constraint_SerialSimOpt.hpp.

NumberToString()

template<class T>

std::string ROL::ROL::NumberToString

(

T

Number

)

Definition at line 47 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 57 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::ROL::Constraint< Real >::applyAdjointJacobian(), ROL::ROL::Constraint< Real >::applyJacobian(), ROL::ROL::Constraint< Real >::checkApplyAdjointHessian(), ROL::ROL::Constraint< Real >::checkApplyAdjointJacobian(), ROL::ROL::Constraint< Real >::checkApplyJacobian(), ROL::ROL::Objective< Real >::checkGradient(), ROL::ROL::Objective< Real >::checkHessSym(), ROL::ROL::Objective< Real >::checkHessVec(), ROL::ROL::Objective< Real >::checkProxJacVec(), ROL::ROL::ReduceLinearConstraint< Real >::feasible(), ROL::ROL::Objective< Real >::gradient(), ROL::StdObjective< Real >::gradient(), ROL::ROL::ReduceLinearConstraint< Real >::project(), ROL::ROL::AffineTransformConstraint< Real >::transform(), ROL::ROL::AffineTransformObjective< Real >::transform(), ROL::ROL::NonlinearLeastSquaresObjective< Real >::update(), and ROL::ROL::NonlinearLeastSquaresObjective< Real >::update().

ROL_THRESHOLD()

template<class Real>

Real ROL::ROL::ROL_THRESHOLD ( void )

inline

Tolerance for various equality tests.

Definition at line 63 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 68 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_INF()

template<class Real>

Real ROL::ROL::ROL_INF ( void )

inline

Definition at line 71 of file ROL_Constraint_SerialSimOpt.hpp.

ROL_NINF()

template<class Real>

Real ROL::ROL::ROL_NINF ( void )

inline

Definition at line 74 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 79 of file ROL_Constraint_SerialSimOpt.hpp.

EExitStatusToString()

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

inline

Definition at line 92 of file ROL_Constraint_SerialSimOpt.hpp.

removeStringFormat()

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

inline

Definition at line 215 of file ROL_Constraint_SerialSimOpt.hpp.

EStepToString()

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

inline

Definition at line 256 of file ROL_Constraint_SerialSimOpt.hpp.

isCompatibleStep()

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

inline

Definition at line 274 of file ROL_Constraint_SerialSimOpt.hpp.

EProblemToString()

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

inline

Definition at line 309 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 329 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [1/14]

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

inline

Definition at line 341 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [2/14]

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

inline

Definition at line 345 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [1/14]

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

inline

Definition at line 351 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [2/14]

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

inline

Definition at line 355 of file ROL_Constraint_SerialSimOpt.hpp.

StringToEStep()

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

inline

Definition at line 361 of file ROL_Constraint_SerialSimOpt.hpp.

EDescentToString()

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

inline

Definition at line 390 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 409 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [3/14]

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

inline

Definition at line 418 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [4/14]

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

inline

Definition at line 422 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [3/14]

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

inline

Definition at line 428 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [4/14]

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

inline

Definition at line 432 of file ROL_Constraint_SerialSimOpt.hpp.

StringToEDescent()

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

inline

Definition at line 438 of file ROL_Constraint_SerialSimOpt.hpp.

ESecantToString()

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

inline

Definition at line 465 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 484 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [5/14]

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

inline

Definition at line 493 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [6/14]

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

inline

Definition at line 497 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [5/14]

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

inline

Definition at line 503 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [6/14]

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

inline

Definition at line 507 of file ROL_Constraint_SerialSimOpt.hpp.

StringToESecant()

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

inline

Definition at line 513 of file ROL_Constraint_SerialSimOpt.hpp.

ENonlinearCGToString()

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

inline

Definition at line 550 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 574 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [7/14]

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

inline

Definition at line 588 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [8/14]

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

inline

Definition at line 592 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [7/14]

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

inline

Definition at line 598 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [8/14]

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

inline

Definition at line 602 of file ROL_Constraint_SerialSimOpt.hpp.

StringToENonlinearCG()

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

inline

Definition at line 608 of file ROL_Constraint_SerialSimOpt.hpp.

ELineSearchToString()

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

inline

Definition at line 640 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 662 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [9/14]

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

inline

Definition at line 674 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [10/14]

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

inline

Definition at line 678 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [9/14]

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

inline

Definition at line 684 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [10/14]

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

inline

Definition at line 688 of file ROL_Constraint_SerialSimOpt.hpp.

StringToELineSearch()

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

inline

Definition at line 694 of file ROL_Constraint_SerialSimOpt.hpp.

ECurvatureConditionToString()

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

inline

Definition at line 721 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 741 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [11/14]

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

inline

Definition at line 751 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [12/14]

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

inline

Definition at line 755 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [11/14]

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

inline

Definition at line 761 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [12/14]

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

inline

Definition at line 765 of file ROL_Constraint_SerialSimOpt.hpp.

StringToECurvatureCondition()

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

inline

Definition at line 771 of file ROL_Constraint_SerialSimOpt.hpp.

ECGFlagToString()

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

inline

Definition at line 801 of file ROL_Constraint_SerialSimOpt.hpp.

rol_cast()

template<class Element, class Real>

Real ROL::ROL::rol_cast

(

const Element &

val

)

Definition at line 873 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 174 of file ROL_Constraint_SerialSimOpt.hpp.

getValidROLParameters()

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

inline

Definition at line 20 of file ROL_Constraint_SerialSimOpt.hpp.

getValidSOLParameters()

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

inline

Definition at line 255 of file ROL_Constraint_SerialSimOpt.hpp.

ETrustRegionUToString()

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

inline

Definition at line 39 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 58 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [13/14]

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

inline

Definition at line 67 of file ROL_Constraint_SerialSimOpt.hpp.

operator++() [14/14]

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

inline

Definition at line 71 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [13/14]

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

inline

Definition at line 77 of file ROL_Constraint_SerialSimOpt.hpp.

operator--() [14/14]

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

inline

Definition at line 81 of file ROL_Constraint_SerialSimOpt.hpp.

StringToETrustRegionU()

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

inline

Definition at line 87 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 26 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 37 of file ROL_Constraint_SerialSimOpt.hpp.

TrustRegionUFactory()

template<typename Real>

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

inline

Definition at line 27 of file ROL_Constraint_SerialSimOpt.hpp.

partition() [1/4]

template<typename Real>

PartitionedVector< Real > & ROL::ROL::partition ( Vector< Real > & x )

inline

Definition at line 261 of file ROL_Constraint_SerialSimOpt.hpp.

partition() [2/4]

template<typename Real>

const PartitionedVector< Real > & ROL::ROL::partition ( const Vector< Real > & x )

inline

Definition at line 266 of file ROL_Constraint_SerialSimOpt.hpp.

partition() [3/4]

template<typename Real>

Ptr< PartitionedVector< Real > > ROL::ROL::partition ( const Ptr< Vector< Real > > & x )

inline

Definition at line 271 of file ROL_Constraint_SerialSimOpt.hpp.

partition() [4/4]

template<typename Real>

Ptr< const PartitionedVector< Real > > ROL::ROL::partition ( const Ptr< const Vector< Real > > & x )

inline

Definition at line 276 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [1/8]

template<class Real>

ROL::Ptr< Vector< Real > > ROL::ROL::CreatePartitionedVector

(

const ROL::Ptr< Vector< Real > > &

a

)

Definition at line 284 of file ROL_Constraint_SerialSimOpt.hpp.

References ROL::Vector< Real >::zero().

CreatePartitionedVector() [2/8]

template<class Real>

ROL::Ptr< const Vector< Real > > ROL::ROL::CreatePartitionedVector

(

const ROL::Ptr< const Vector< Real > > &

a

)

Definition at line 295 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [3/8]

template<class Real>

ROL::Ptr< Vector< Real > > ROL::ROL::CreatePartitionedVector	(	const ROL::Ptr< Vector< Real > > &	a,
		const ROL::Ptr< Vector< Real > > &	b )

Definition at line 306 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [4/8]

template<class Real>

ROL::Ptr< const Vector< Real > > ROL::ROL::CreatePartitionedVector	(	const ROL::Ptr< const Vector< Real > > &	a,
		const ROL::Ptr< const Vector< Real > > &	b )

Definition at line 317 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [5/8]

template<class Real>

ROL::Ptr< Vector< Real > > ROL::ROL::CreatePartitionedVector	(	const ROL::Ptr< Vector< Real > > &	a,
		const ROL::Ptr< Vector< Real > > &	b,
		const ROL::Ptr< Vector< Real > > &	c )

Definition at line 329 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [6/8]

template<class Real>

ROL::Ptr< const Vector< Real > > ROL::ROL::CreatePartitionedVector	(	const ROL::Ptr< const Vector< Real > > &	a,
		const ROL::Ptr< const Vector< Real > > &	b,
		const ROL::Ptr< const Vector< Real > > &	c )

Definition at line 342 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [7/8]

template<class Real>

ROL::Ptr< Vector< Real > > ROL::ROL::CreatePartitionedVector	(	const ROL::Ptr< Vector< Real > > &	a,
		const ROL::Ptr< Vector< Real > > &	b,
		const ROL::Ptr< Vector< Real > > &	c,
		const ROL::Ptr< Vector< Real > > &	d )

Definition at line 355 of file ROL_Constraint_SerialSimOpt.hpp.

CreatePartitionedVector() [8/8]

template<class Real>

ROL::Ptr< const Vector< Real > > ROL::ROL::CreatePartitionedVector	(	const ROL::Ptr< const Vector< Real > > &	a,
		const ROL::Ptr< const Vector< Real > > &	b,
		const ROL::Ptr< const Vector< Real > > &	c,
		const ROL::Ptr< const Vector< Real > > &	d )

Definition at line 370 of file ROL_Constraint_SerialSimOpt.hpp.

makeStreamPtr()

Ptr< std::ostream > ROL::ROL::details::makeStreamPtr ( std::ostream & os, bool noSuppressOutput = true )

inline

Definition at line 40 of file ROL_Constraint_SerialSimOpt.hpp.