GlobiPack Package Browser (Single Doxygen Collection) Version of the Day
Private Attributes | Related Functions
GlobiPack::ArmijoPolyInterpLineSearch< Scalar > Class Template Reference

Linesearch subclass implementing a backtracking-only line search using an Armijo cord test condition and a quadratic interploation. More...

#include <GlobiPack_ArmijoPolyInterpLineSearch_decl.hpp>

Inheritance diagram for GlobiPack::ArmijoPolyInterpLineSearch< Scalar >:
Inheritance graph
[legend]

List of all members.

Private Attributes

Scalar eta_
Scalar minFrac_
Scalar maxFrac_
int minIters_
int maxIters_
bool doMaxIters_

Related Functions

(Note that these are not member functions.)

template<typename Scalar >
const RCP
< ArmijoPolyInterpLineSearch
< Scalar > > 
armijoQuadraticLineSearch ()
 Nonmember constructor.

Constructor/Initializers/Accessors

 ArmijoPolyInterpLineSearch ()
 Construct with default parameters.
Scalar eta () const
 
Scalar minFrac () const
 
Scalar maxFrac () const
 
int minIters () const
 
int maxIters () const
 
bool doMaxIters () const
 

Overridden from ParameterListAcceptor (simple forwarding functions)

void setParameterList (RCP< ParameterList > const &paramList)
 
RCP< const ParameterListgetValidParameters () const
 

Overrridden from LineSearchBase.

virtual bool requiresBaseDeriv () const
 Returns true.
virtual bool requiresDerivEvals () const
 Returns false.
virtual bool doLineSearch (const MeritFunc1DBase< Scalar > &phi, const PointEval1D< Scalar > &point_k, const Ptr< PointEval1D< Scalar > > &point_kp1, const Ptr< int > &numIters) const
 

Detailed Description

template<typename Scalar>
class GlobiPack::ArmijoPolyInterpLineSearch< Scalar >

Linesearch subclass implementing a backtracking-only line search using an Armijo cord test condition and a quadratic interploation.

This linesearch class is really designed for (quasi) Newton methods where a backtracking only linesearch is the only thing the makes sense.

ToDo: Finish Documentation!

Definition at line 51 of file GlobiPack_ArmijoPolyInterpLineSearch_decl.hpp.


Constructor & Destructor Documentation

template<typename Scalar >
GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::ArmijoPolyInterpLineSearch ( )

Construct with default parameters.

Definition at line 46 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.


Member Function Documentation

template<typename Scalar >
Scalar GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::eta ( ) const

Definition at line 57 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
Scalar GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::minFrac ( ) const

Definition at line 64 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
Scalar GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::maxFrac ( ) const

Definition at line 71 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
int GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::minIters ( ) const

Definition at line 78 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
int GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::maxIters ( ) const

Definition at line 85 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
bool GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::doMaxIters ( ) const

Definition at line 92 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<class Scalar >
void GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList) [virtual]
template<class Scalar >
RCP< const ParameterList > GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::getValidParameters ( ) const [virtual]

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 128 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
bool GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::requiresBaseDeriv ( ) const [virtual]

Returns true.

Implements GlobiPack::LineSearchBase< Scalar >.

Definition at line 151 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
bool GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::requiresDerivEvals ( ) const [virtual]

Returns false.

Implements GlobiPack::LineSearchBase< Scalar >.

Definition at line 158 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
bool GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::doLineSearch ( const MeritFunc1DBase< Scalar > &  phi,
const PointEval1D< Scalar > &  point_k,
const Ptr< PointEval1D< Scalar > > &  point_kp1,
const Ptr< int > &  numIters 
) const [virtual]

Friends And Related Function Documentation

template<typename Scalar >
const RCP< ArmijoPolyInterpLineSearch< Scalar > > armijoQuadraticLineSearch ( ) [related]

Nonmember constructor.

Definition at line 127 of file GlobiPack_ArmijoPolyInterpLineSearch_decl.hpp.


Member Data Documentation

template<typename Scalar >
Scalar GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::eta_ [private]
template<typename Scalar >
Scalar GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::minFrac_ [private]
template<typename Scalar >
Scalar GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::maxFrac_ [private]
template<typename Scalar >
int GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::minIters_ [private]
template<typename Scalar >
int GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::maxIters_ [private]
template<typename Scalar >
bool GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::doMaxIters_ [private]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends