ROL
Enumerations | Functions
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

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 28 of file ROL_TrustRegionUtilities.hpp.

Function Documentation

std::string ROL::TRUtils::ETRFlagToString ( ETRFlag  trf)
inline
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
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 135 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 186 of file ROL_TrustRegionUtilities.hpp.

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