OptiPack Version of the Day
Public Types | Related Functions
OptiPack::UnconstrainedOptMeritFunc1D< Scalar > Class Template Reference

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

#include <OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp>

Inheritance diagram for OptiPack::UnconstrainedOptMeritFunc1D< Scalar >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef ScalarTraits< Scalar >
::magnitudeType 
ScalarMag
 

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.

Constructor/Initializers/Accessors

 UnconstrainedOptMeritFunc1D ()
 Construct with default parameters.
void setModel (const RCP< const Thyra::ModelEvaluator< Scalar > > &model, const int paramIndex, const int responseIndex)
 Set the model.
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.

Overridden from MeritFunc1DBase.

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

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 53 of file OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp.


Member Typedef Documentation

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

Constructor & Destructor Documentation

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

Construct with default parameters.

Definition at line 50 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 57 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 75 of file OptiPack_UnconstrainedOptMeritFunc1D_def.hpp.

template<typename Scalar >
bool OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::supportsDerivEvals ( ) const [virtual]
template<typename Scalar >
void OptiPack::UnconstrainedOptMeritFunc1D< Scalar >::eval ( const ScalarMag alpha,
const Ptr< ScalarMag > &  phi,
const Ptr< ScalarMag > &  Dphi 
) const [virtual]

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 
) [related]

Nonmember constructor.

Definition at line 143 of file OptiPack_UnconstrainedOptMeritFunc1D_decl.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends