Playa::LineSearchBasedOptBase Class Reference

Inheritance diagram for Playa::LineSearchBasedOptBase:

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
Private Attributes
RCP< LineSearchBase >	lineSearch_
RCP< OptConvergenceTestBase >	convTest_

---

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.

References convTest_, Playa::OptConvergenceTestBuilder::createConvTest(), Playa::LineSearchBuilder::createLineSearch(), and lineSearch_.

virtual Playa::LineSearchBasedOptBase::~LineSearchBasedOptBase

(

)

[inline, virtual]

Definition at line 44 of file PlayaLineSearchBasedOptBase.hpp.

---

Member Function Documentation

const RCP<OptConvergenceTestBase>& Playa::LineSearchBasedOptBase::convTest

(

)

const [inline, protected]

Definition at line 63 of file PlayaLineSearchBasedOptBase.hpp.

References convTest_.

const RCP<LineSearchBase>& Playa::LineSearchBasedOptBase::lineSearch

(

)

const [inline, protected]

Definition at line 60 of file PlayaLineSearchBasedOptBase.hpp.

References lineSearch_.

virtual RCP<DirectionGeneratorBase> Playa::LineSearchBasedOptBase::makeDirectionGenerator

(

)

const [pure virtual]

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

Referenced by run().

void Playa::LineSearchBasedOptBase::print

(

std::ostream &

os

)

const [virtual]

Implements Playa::Printable.

Definition at line 116 of file PlayaLineSearchBasedOptBase.cpp.

References convTest_, and lineSearch_.

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.

References convTest_, Playa::Vector< Scalar >::copy(), Playa::VectorSpace< Scalar >::createMember(), Playa::OptState::fCur(), Playa::OptState::gradCur(), Playa::OptState::iter(), lineSearch_, Playa::LS_Success, makeDirectionGenerator(), Playa::Vector< Scalar >::norm2(), Playa::Opt_Continue, Playa::Opt_DirectionFailure, Playa::Opt_LineSearchFailed, PLAYA_MSG1, PLAYA_MSG2, PLAYA_MSG4, Playa::OptState::setStatus(), Playa::Vector< Scalar >::space(), Playa::OptState::status(), Playa::OptState::update(), Playa::ObjectWithVerbosity::verb(), and Playa::OptState::xCur().

---

Member Data Documentation

RCP<OptConvergenceTestBase> Playa::LineSearchBasedOptBase::convTest_ [private]

Definition at line 67 of file PlayaLineSearchBasedOptBase.hpp.

Referenced by convTest(), LineSearchBasedOptBase(), print(), and run().

RCP<LineSearchBase> Playa::LineSearchBasedOptBase::lineSearch_ [private]

Definition at line 66 of file PlayaLineSearchBasedOptBase.hpp.

Referenced by lineSearch(), LineSearchBasedOptBase(), print(), and run().