Playa::LineSearchBase Class Reference

#include <PlayaLineSearchBase.hpp>

Inheritance diagram for Playa::LineSearchBase:

Playa::ObjectWithVerbosity Playa::Printable Playa::SimpleBacktracking

List of all members.

Public Member Functions

 LineSearchBase (const ParameterList &params)
virtual LineSearchStatus search (const RCP< ObjectiveBase > &obj, const Vector< double > &x0, const double &f0, const Vector< double > &direction, const double &alphaMax, Vector< double > &xn, Vector< double > &gradF, double &fVal) const =0
virtual double minStepSize () const
virtual int maxSteps () const
const ParameterList & params () const

Detailed Description

Base class for line search methods.
Paul Boggs and Kevin Long

Definition at line 23 of file PlayaLineSearchBase.hpp.

Constructor & Destructor Documentation

Playa::LineSearchBase::LineSearchBase ( const ParameterList &  params  ) 

Definition at line 8 of file PlayaLineSearchBase.cpp.

Member Function Documentation

virtual LineSearchStatus Playa::LineSearchBase::search ( const RCP< ObjectiveBase > &  obj,
const Vector< double > &  x0,
const double &  f0,
const Vector< double > &  direction,
const double &  alphaMax,
Vector< double > &  xn,
Vector< double > &  gradF,
double &  fVal 
) const [pure virtual]

Implemented in Playa::SimpleBacktracking.

virtual double Playa::LineSearchBase::minStepSize (  )  const [inline, virtual]

Definition at line 44 of file PlayaLineSearchBase.hpp.

virtual int Playa::LineSearchBase::maxSteps (  )  const [inline, virtual]

Definition at line 47 of file PlayaLineSearchBase.hpp.

const ParameterList& Playa::LineSearchBase::params (  )  const [inline]

Definition at line 50 of file PlayaLineSearchBase.hpp.

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