ROL::Bisection< Real > Class Template Reference

Implements a bisection line search. More...

#include <ROL_Bisection.hpp>

Inheritance diagram for ROL::Bisection< Real >:

Public Member Functions
virtual	~Bisection ()
	Bisection (Teuchos::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 (Teuchos::ParameterList &parlist)
void	setData (Real &eps, const Vector< Real > &g)
void	setMaxitUpdate (Real &alpha, Real &fnew, const Real &fold)

Private Attributes
Real	tol_
Teuchos::RCP< Vector< Real > >	xnew_
Teuchos::RCP< 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::Bisection< Real >

Implements a bisection line search.

Definition at line 57 of file ROL_Bisection.hpp.

Constructor & Destructor Documentation

~Bisection()

template<class Real >

virtual ROL::Bisection< Real >::~Bisection ( )

inlinevirtual

Definition at line 65 of file ROL_Bisection.hpp.

Bisection()

template<class Real >

ROL::Bisection< Real >::Bisection ( Teuchos::ParameterList &  parlist )

inline

Definition at line 68 of file ROL_Bisection.hpp.

Member Function Documentation

initialize()

template<class Real >

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

inlinevirtual

Reimplemented from ROL::LineSearch< Real >.

Definition at line 74 of file ROL_Bisection.hpp.

References ROL::Vector< Real >::clone(), and ROL::LineSearch< Real >::initialize().

run()

template<class Real >

void ROL::Bisection< 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

Implements ROL::LineSearch< Real >.

Definition at line 81 of file ROL_Bisection.hpp.

References ROL::LineSearch< Real >::getInitialAlpha(), ROL::LINESEARCH_BISECTION, ROL::Objective< Real >::update(), ROL::LineSearch< Real >::updateIterate(), and ROL::Objective< Real >::value().

Member Data Documentation

tol_

template<class Real >

Real ROL::Bisection< Real >::tol_

private

Definition at line 59 of file ROL_Bisection.hpp.

xnew_

template<class Real >

Teuchos::RCP<Vector<Real> > ROL::Bisection< Real >::xnew_

private

Definition at line 60 of file ROL_Bisection.hpp.

btls_

template<class Real >

Teuchos::RCP<LineSearch<Real> > ROL::Bisection< Real >::btls_

private

Definition at line 61 of file ROL_Bisection.hpp.

---

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

• ROL_Bisection.hpp