ROL
Public Member Functions | Private Attributes | List of all members
ROL::GoldenSection< Real > Class Template Reference

Implements a golden section line search. More...

#include <ROL_GoldenSection.hpp>

+ Inheritance diagram for ROL::GoldenSection< Real >:

Public Member Functions

virtual ~GoldenSection ()
 
 GoldenSection (ROL::ParameterList &parlist)
 
void initialize (const Vector< Real > &x, const Vector< Real > &s, const Vector< Real > &g, Objective< Real > &obj, BoundConstraint< Real > &con)
 
void run (Real &alpha, Real &fval, int &ls_neval, int &ls_ngrad, const Real &gs, const Vector< Real > &s, const Vector< Real > &x, Objective< Real > &obj, BoundConstraint< Real > &con)
 
- Public Member Functions inherited from ROL::LineSearch< Real >
virtual ~LineSearch ()
 
 LineSearch (ROL::ParameterList &parlist)
 
void setData (Real &eps, const Vector< Real > &g)
 
void setMaxitUpdate (Real &alpha, Real &fnew, const Real &fold)
 

Private Attributes

Real tol_
 
ROL::Ptr< Vector< Real > > xnew_
 
ROL::Ptr< LineSearch< Real > > btls_
 

Additional Inherited Members

- Protected Member Functions inherited from ROL::LineSearch< Real >
virtual bool status (const ELineSearch type, int &ls_neval, int &ls_ngrad, const Real alpha, const Real fold, const Real sgold, const Real fnew, const Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con)
 
virtual Real getInitialAlpha (int &ls_neval, int &ls_ngrad, const Real fval, const Real gs, const Vector< Real > &x, const Vector< Real > &s, Objective< Real > &obj, BoundConstraint< Real > &con)
 
void setNextInitialAlpha (Real alpha)
 
void updateIterate (Vector< Real > &xnew, const Vector< Real > &x, const Vector< Real > &s, Real alpha, BoundConstraint< Real > &con)
 
bool useLocalMinimizer ()
 
bool takeNoStep ()
 

Detailed Description

template<class Real>
class ROL::GoldenSection< Real >

Implements a golden section line search.

Definition at line 57 of file ROL_GoldenSection.hpp.

Constructor & Destructor Documentation

◆ ~GoldenSection()

template<class Real >
virtual ROL::GoldenSection< Real >::~GoldenSection ( )
inlinevirtual

Definition at line 65 of file ROL_GoldenSection.hpp.

◆ GoldenSection()

template<class Real >
ROL::GoldenSection< Real >::GoldenSection ( ROL::ParameterList & parlist)
inline

Member Function Documentation

◆ initialize()

template<class Real >
void ROL::GoldenSection< Real >::initialize ( const Vector< Real > & x,
const Vector< Real > & s,
const Vector< Real > & g,
Objective< Real > & obj,
BoundConstraint< Real > & con )
inlinevirtual

◆ run()

template<class Real >
void ROL::GoldenSection< Real >::run ( Real & alpha,
Real & fval,
int & ls_neval,
int & ls_ngrad,
const Real & gs,
const Vector< Real > & s,
const Vector< Real > & x,
Objective< Real > & obj,
BoundConstraint< Real > & con )
inlinevirtual

Member Data Documentation

◆ tol_

template<class Real >
Real ROL::GoldenSection< Real >::tol_
private

◆ xnew_

template<class Real >
ROL::Ptr<Vector<Real> > ROL::GoldenSection< Real >::xnew_
private

◆ btls_

template<class Real >
ROL::Ptr<LineSearch<Real> > ROL::GoldenSection< Real >::btls_
private

The documentation for this class was generated from the following file: