Concreate subclass for unconstrained optimization objective function. More...

#include <OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp>

Inheritance diagram for OptiPack::UnconstrainedOptMeritFunc1D< Scalar >:

Public Types
typedef ScalarTraits< Scalar > ::magnitudeType	ScalarMag

Private Attributes
RCP< const Thyra::ModelEvaluator< Scalar > >	model_

int	paramIndex_

int	responseIndex_

RCP< const LineSearchPointEvaluatorBase < Scalar > >	pointEvaluator_

RCP< Thyra::VectorBase< Scalar > >	p_

RCP< Thyra::VectorBase< Scalar > >	g_vec_

RCP< Thyra::VectorBase< Scalar > >	g_grad_vec_

Related Functions
(Note that these are not member functions.)
template<typename Scalar >
const RCP < UnconstrainedOptMeritFunc1D < Scalar > >	unconstrainedOptMeritFunc1D (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int paramIndex, const int responseIndex)
	Nonmember constructor. More...

Constructor/Initializers/Accessors
	UnconstrainedOptMeritFunc1D ()
	Construct with default parameters. More...

void	setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int paramIndex, const int responseIndex)
	Set the model. More...

void	setEvaluationQuantities (const RCP< const LineSearchPointEvaluatorBase< Scalar > > &pointEvaluator, const RCP< Thyra::VectorBase< Scalar > > &p, const RCP< Thyra::VectorBase< Scalar > > &g_vec, const RCP< Thyra::VectorBase< Scalar > > &g_grad_vec)
	Set the evaluation qualities. More...

Overridden from MeritFunc1DBase.
virtual bool	supportsDerivEvals () const

virtual void	eval (const ScalarMag &alpha, const Ptr< ScalarMag > &phi, const Ptr< ScalarMag > &Dphi) const

Additional Inherited Members
Public Member Functions inherited from GlobiPack::MeritFunc1DBase< ScalarTraits< Scalar >::magnitudeType >
virtual void	eval (const ScalarTraits< Scalar >::magnitudeType &alpha, const Ptr< ScalarTraits< Scalar >::magnitudeType > &phi, const Ptr< ScalarTraits< Scalar >::magnitudeType > &Dphi) const =0

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

PointEval1D< ScalarTraits < Scalar >::magnitudeType >	computePoint (const MeritFunc1DBase< ScalarTraits< Scalar >::magnitudeType > &phi, const ScalarTraits< Scalar >::magnitudeType &alpha, const bool compute_phi=true, const bool compute_Dphi=false)

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

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

Detailed Description

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

Concreate subclass for unconstrained optimization objective function.

This subclass turns a response-only ModelEvaluator for an unconstrained optimization problem g(p) into a 1D merit function.

ToDo: Finish Documentation!

Definition at line 66 of file OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp.

Member Typedef Documentation

template<typename Scalar >

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

Definition at line 72 of file OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp.

Constructor & Destructor Documentation

template<typename Scalar >

OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::UnconstrainedOptMeritFunc1D ( )

Construct with default parameters.

Definition at line 63 of file OptiPack_UnconstrainedOptMeritFunc1D_def.hpp.

Member Function Documentation

template<typename Scalar >

void OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::setModel	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const int	paramIndex,
		const int	responseIndex
	)

Set the model.

Definition at line 70 of file OptiPack_UnconstrainedOptMeritFunc1D_def.hpp.

template<typename Scalar >

void OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::setEvaluationQuantities	(	const RCP< const LineSearchPointEvaluatorBase< Scalar > > &	pointEvaluator,
		const RCP< Thyra::VectorBase< Scalar > > &	p,
		const RCP< Thyra::VectorBase< Scalar > > &	g_vec,
		const RCP< Thyra::VectorBase< Scalar > > &	g_grad_vec
	)

Set the evaluation qualities.

Parameters

pointEvaluator	[persisting non-modified] Evaluates p = p(alpha).
p	[persisting modified] Point that is updated with every call to `eval(...)`.
g_vec	[persisting modified] The 1D vector used to store the objective value computed by `model`.
g_grad_vec	[persisting modified] If `!is_null(g_grad_vec)`, then this will be updated when `eval(...)` is called.
baseDeriv	[in] If `!is_null(baseDeriv)`, then gives the value to be returned in `this->baseDeriv()`.

Postconditions:

[!is_null(g_grad_vec)] this->supportsDerivEvals()==true
[!is_null(baseDeriv)] this->supportsBaseDeriv()==true

Definition at line 88 of file OptiPack_UnconstrainedOptMeritFunc1D_def.hpp.

template<typename Scalar >

bool OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::supportsDerivEvals ( ) const

virtual

Implements GlobiPack::MeritFunc1DBase< ScalarTraits< Scalar >::magnitudeType >.

Definition at line 112 of file OptiPack_UnconstrainedOptMeritFunc1D_def.hpp.

template<typename Scalar >

void OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::eval	(	const ScalarMag &	alpha,
		const Ptr< ScalarMag > &	phi,
		const Ptr< ScalarMag > &	Dphi
	)		const

virtual

Definition at line 119 of file OptiPack_UnconstrainedOptMeritFunc1D_def.hpp.

Friends And Related Function Documentation

template<typename Scalar >

const RCP< UnconstrainedOptMeritFunc1D< Scalar > > unconstrainedOptMeritFunc1D	(	const RCP< const Thyra::ModelEvaluator< Scalar > > &	model,
		const int	paramIndex,
		const int	responseIndex
	)