GlobiPack Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Private Attributes | Related Functions | List of all members
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]

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. More...
 

Constructor/Initializers/Accessors

 ArmijoPolyInterpLineSearch ()
 Construct with default parameters. More...
 
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. More...
 
virtual bool requiresDerivEvals () const
 Returns false. More...
 
virtual bool doLineSearch (const MeritFunc1DBase< Scalar > &phi, const PointEval1D< Scalar > &point_k, const Ptr< PointEval1D< Scalar > > &point_kp1, const Ptr< int > &numIters) const
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
- Public Member Functions inherited from Teuchos::VerboseObject< LineSearchBase< Scalar > >
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
RCP< const ParameterList
getValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT
void 
readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< LineSearchBase< Scalar > > *verboseObject)
 
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< LineSearchBase< Scalar > >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from Teuchos::VerboseObject< LineSearchBase< Scalar > >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::ParameterListAcceptorDefaultBase
void setMyParamList (const RCP< ParameterList > &paramList)
 
RCP< ParameterListgetMyNonconstParamList ()
 
RCP< const ParameterListgetMyParamList () const
 
RCP< ParameterListgetNonconstParameterList ()
 
RCP< ParameterListunsetParameterList ()
 
RCP< const ParameterListgetParameterList () 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 64 of file GlobiPack_ArmijoPolyInterpLineSearch_decl.hpp.

Constructor & Destructor Documentation

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

Construct with default parameters.

Definition at line 59 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

Member Function Documentation

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

Definition at line 70 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

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

Definition at line 77 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

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

Definition at line 84 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

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

Definition at line 91 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

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

Definition at line 98 of file GlobiPack_ArmijoPolyInterpLineSearch_def.hpp.

template<typename Scalar >
bool GlobiPack::ArmijoPolyInterpLineSearch< Scalar >::doMaxIters ( ) const
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 141 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 164 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 171 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 140 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: