Playa::LineSearchBasedOptBase Class Reference

#include <PlayaLineSearchBasedOptBase.hpp>

Inheritance diagram for Playa::LineSearchBasedOptBase:

Playa::UnconstrainedOptimizerBase Playa::ObjectWithVerbosity Playa::Printable Playa::BasicLMBFGS Playa::SteepestDescent

List of all members.

Public Member Functions

 LineSearchBasedOptBase (const ParameterList &params)
virtual ~LineSearchBasedOptBase ()
OptState run (const RCP< ObjectiveBase > &obj, const Vector< double > &xInit, const RCP< ConvergenceMonitor > &convMonitor=null) const
virtual RCP
< DirectionGeneratorBase > 		makeDirectionGenerator () const =0
virtual void print (std::ostream &os) const

Protected Member Functions

const RCP< LineSearchBase > & lineSearch () const
const RCP
< OptConvergenceTestBase > & 		convTest () const

Detailed Description

Base class for optimizers based on line search methods.

Author:
Kevin Long

Definition at line 38 of file PlayaLineSearchBasedOptBase.hpp.

Constructor & Destructor Documentation

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

Definition at line 14 of file PlayaLineSearchBasedOptBase.cpp.

virtual Playa::LineSearchBasedOptBase::~LineSearchBasedOptBase (  )  [inline, virtual]

Definition at line 44 of file PlayaLineSearchBasedOptBase.hpp.

Member Function Documentation

OptState Playa::LineSearchBasedOptBase::run ( const RCP< ObjectiveBase > &  obj,
const Vector< double > &  xInit,
const RCP< ConvergenceMonitor > &  convMonitor = null 
) const [virtual]

Main method to apply the algorithm starting with x and returning the result in x

Implements Playa::UnconstrainedOptimizerBase.

Definition at line 28 of file PlayaLineSearchBasedOptBase.cpp.

virtual RCP<DirectionGeneratorBase> Playa::LineSearchBasedOptBase::makeDirectionGenerator (  )  const [pure virtual]

Implemented in Playa::BasicLMBFGS, and Playa::SteepestDescent.

void Playa::LineSearchBasedOptBase::print ( std::ostream &  os  )  const [virtual]

Implements Playa::Printable.

Definition at line 116 of file PlayaLineSearchBasedOptBase.cpp.

const RCP<LineSearchBase>& Playa::LineSearchBasedOptBase::lineSearch (  )  const [inline, protected]

Definition at line 60 of file PlayaLineSearchBasedOptBase.hpp.

const RCP<OptConvergenceTestBase>& Playa::LineSearchBasedOptBase::convTest (  )  const [inline, protected]

Definition at line 63 of file PlayaLineSearchBasedOptBase.hpp.

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