GlobiPack::MeritFunc1DBase< Scalar > Class Template Reference

Base class for 1D merit fucntions used in globalization methods. More...

#include <GlobiPack_MeritFunc1DBase.hpp>

Inheritance diagram for GlobiPack::MeritFunc1DBase< Scalar >:

List of all members.

Public Member Functions
virtual bool	supportsDerivEvals () const =0
	Determine if derivative evaluations are supported or not.
virtual void	eval (const Scalar &alpha, const Ptr< Scalar > &phi, const Ptr< Scalar > &Dphi) const =0
	Evaluate the merit function at alpha.
Related Functions
(Note that these are not member functions.)
template<typename Scalar >
ScalarTraits< Scalar > ::magnitudeType	computeValue (const MeritFunc1DBase< Scalar > &phi, const Scalar &alpha)
	Compute the value of the merit function phi(alpha).
template<typename Scalar >
PointEval1D< Scalar >	computePoint (const MeritFunc1DBase< Scalar > &phi, const Scalar &alpha, const bool compute_phi=true, const bool compute_Dphi=false)
	Compute a point as an object.

---

Detailed Description

template<typename Scalar>
class GlobiPack::MeritFunc1DBase< Scalar >

Base class for 1D merit fucntions used in globalization methods.

NOTE: The Scalar type must be a real type since comparions are performed

ToDo: Finish Documentation!

Definition at line 62 of file GlobiPack_MeritFunc1DBase.hpp.

---

Member Function Documentation

template<typename Scalar>

virtual bool GlobiPack::MeritFunc1DBase< Scalar >::supportsDerivEvals

(

)

const [pure virtual]

Determine if derivative evaluations are supported or not.

template<typename Scalar>

virtual void GlobiPack::MeritFunc1DBase< Scalar >::eval	(	const Scalar &	alpha,
		const Ptr< Scalar > &	phi,
		const Ptr< Scalar > &	Dphi
	)		const [pure virtual]

Evaluate the merit function at alpha.

Parameters:

alpha	[in] The value of the independent variable determining the step length. Typically alpha > 0.
phi	[out] The value of the merit function evaluated at alpha.
Dphi	[out] The value of the derivative of the merit function evaluated at alpha.

Preconditions:

• If !is_null(Dphi) then supportsDerivEvals() must be true.

---

Friends And Related Function Documentation

template<typename Scalar >

ScalarTraits< Scalar >::magnitudeType computeValue	(	const MeritFunc1DBase< Scalar > &	phi,
		const Scalar &	alpha
	)		[related]

Compute the value of the merit function phi(alpha).

Definition at line 99 of file GlobiPack_MeritFunc1DBase.hpp.

template<typename Scalar >

PointEval1D< Scalar > computePoint	(	const MeritFunc1DBase< Scalar > &	phi,
		const Scalar &	alpha,
		const bool	compute_phi = true,
		const bool	compute_Dphi = false
	)		[related]

Compute a point as an object.

Definition at line 113 of file GlobiPack_MeritFunc1DBase.hpp.

---

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

• GlobiPack_MeritFunc1DBase.hpp