ROL::TRUtils Namespace Reference

Enumerations
enum	ETRFlag {   SUCCESS = 0, POSPREDNEG, NPOSPREDPOS, NPOSPREDNEG,   TRNAN, QMINSUFDEC, UNDEFINED }
	Enumation of flags used by trust-region solvers. More...

Functions
std::string	ETRFlagToString (ETRFlag trf)
template<typename Real >
Real	initialRadius (int &nfval, const Vector< Real > &x, const Vector< Real > &g, Vector< Real > &Bg, const Real fx, const Real gnorm, const Real gtol, Objective< Real > &obj, TrustRegionModel_U< Real > &model, const Real delMax, std::ostream &outStream, const bool print=false)
template<typename Real >
void	analyzeRatio (Real &rho, ETRFlag &flag, const Real fold, const Real ftrial, const Real pRed, const Real epsi, std::ostream &outStream=std::cout, const bool print=false)
template<typename Real >
Real	interpolateRadius (const Vector< Real > &g, const Vector< Real > &s, const Real snorm, const Real pRed, const Real fold, const Real ftrial, const Real del, const Real gamma0, const Real gamma1, const Real eta2, std::ostream &outStream=std::cout, const bool print=false)

Enumeration Type Documentation

enum ROL::TRUtils::ETRFlag

Enumation of flags used by trust-region solvers.

• SUCCESS Actual and predicted reductions are positive
• POSPREDNEG Reduction is positive, predicted negative (impossible)
• NPOSPREDPOS Reduction is nonpositive, predicted positive
• NPOSPREDNEG Reduction is nonpositive, predicted negative (impossible)
• TRNAN Actual and/or predicted reduction is NaN

Enumerator
SUCCESS
POSPREDNEG
NPOSPREDPOS
NPOSPREDNEG
TRNAN
QMINSUFDEC
UNDEFINED

Definition at line 62 of file ROL_TrustRegionUtilities.hpp.

Function Documentation

std::string ROL::TRUtils::ETRFlagToString ( ETRFlag  trf )

inline

Definition at line 72 of file ROL_TrustRegionUtilities.hpp.

References NPOSPREDNEG, NPOSPREDPOS, POSPREDNEG, QMINSUFDEC, SUCCESS, and TRNAN.

Referenced by ROL::TypeU::TrustRegionAlgorithm< Real >::writeHeader(), ROL::TypeB::ColemanLiAlgorithm< Real >::writeHeader(), ROL::TypeB::KelleySachsAlgorithm< Real >::writeHeader(), ROL::TypeB::TrustRegionSPGAlgorithm< Real >::writeHeader(), ROL::TypeB::LinMoreAlgorithm< Real >::writeHeader(), and ROL::TypeP::TrustRegionAlgorithm< Real >::writeHeader().

template<typename Real >

Real ROL::TRUtils::initialRadius ( int &  nfval, const Vector< Real > &  x, const Vector< Real > &  g, Vector< Real > &  Bg, const Real  fx, const Real  gnorm, const Real  gtol, Objective< Real > &  obj, TrustRegionModel_U< Real > &  model, const Real  delMax, std::ostream &  outStream, const bool  print = false  )

inline

Definition at line 100 of file ROL_TrustRegionUtilities.hpp.

References ROL::Vector< Real >::clone(), ROL::Vector< Real >::dot(), ROL::Vector< Real >::dual(), ROL::TrustRegionModel_U< Real >::hessVec(), ROL::Revert, ROL::TrustRegionModel_U< Real >::setData(), ROL::Temp, ROL::Objective< Real >::update(), ROL::Objective< Real >::value(), and zero.

template<typename Real >

void ROL::TRUtils::analyzeRatio ( Real &  rho, ETRFlag &  flag, const Real  fold, const Real  ftrial, const Real  pRed, const Real  epsi, std::ostream &  outStream = std::cout, const bool  print = false  )

inline

Definition at line 169 of file ROL_TrustRegionUtilities.hpp.

References NPOSPREDNEG, NPOSPREDPOS, POSPREDNEG, SUCCESS, TRNAN, and zero.

template<typename Real >

Real ROL::TRUtils::interpolateRadius ( const Vector< Real > &  g, const Vector< Real > &  s, const Real  snorm, const Real  pRed, const Real  fold, const Real  ftrial, const Real  del, const Real  gamma0, const Real  gamma1, const Real  eta2, std::ostream &  outStream = std::cout, const bool  print = false  )

inline

Definition at line 220 of file ROL_TrustRegionUtilities.hpp.

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