OptiPack::LineSearchPointEvaluatorBase< Scalar > Class Template Reference

Base class interface for line search point updates. More...

#include <OptiPack_LineSearchPointEvaluatorBase.hpp>

Inheritance diagram for OptiPack::LineSearchPointEvaluatorBase< Scalar >:

Public Types
typedef ScalarTraits< Scalar > ::magnitudeType	ScalarMag

Public Member Functions
virtual void	computePoint (const ScalarMag &alpha, const Ptr< Thyra::VectorBase< Scalar > > &p) const =0
	Compute the updated point p at alpha for a linear search algorithm. More...
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
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

Additional Inherited Members
Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Detailed Description

template<typename Scalar>
class OptiPack::LineSearchPointEvaluatorBase< Scalar >

Base class interface for line search point updates.

ToDo: Finish Documentation!

Definition at line 61 of file OptiPack_LineSearchPointEvaluatorBase.hpp.

Member Typedef Documentation

template<typename Scalar >

typedef ScalarTraits<Scalar>::magnitudeType OptiPack::LineSearchPointEvaluatorBase< Scalar >::ScalarMag

Definition at line 67 of file OptiPack_LineSearchPointEvaluatorBase.hpp.

Member Function Documentation

template<typename Scalar >

virtual void OptiPack::LineSearchPointEvaluatorBase< Scalar >::computePoint ( const ScalarMag &  alpha, const Ptr< Thyra::VectorBase< Scalar > > &  p  ) const

pure virtual

Compute the updated point p at alpha for a linear search algorithm.

Implemented in OptiPack::DefaultPolyLineSearchPointEvaluator< Scalar >.

---

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

• OptiPack_LineSearchPointEvaluatorBase.hpp