GlobiPack::PointEval1D< Scalar > Struct Template Reference

Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha). More...

#include <GlobiPack_Types.hpp>

List of all members.

Public Member Functions

 PointEval1D ()
 
 PointEval1D (const Scalar &alpha_in, const Scalar &phi_in, const Scalar &Dphi_in=valNotGiven())
 

Static Public Member Functions

static Scalar valNotGiven ()
 

Public Attributes

Scalar alpha
 The value of the unknown alpha.
Scalar phi
 The value of the merit function phi(alpha).
Scalar Dphi
 The value of the derivative of the merit function Dphi(alpha).

Detailed Description

template<class Scalar>
struct GlobiPack::PointEval1D< Scalar >

Represents the evaluation point of the merit function phi(alpha) and/or is derivative Dphi(alpha).

If a value has not been set it will be equal to valNotGiven().

Definition at line 74 of file GlobiPack_Types.hpp.


Constructor & Destructor Documentation

template<class Scalar>
GlobiPack::PointEval1D< Scalar >::PointEval1D (  )  [inline]

Definition at line 78 of file GlobiPack_Types.hpp.

template<class Scalar>
GlobiPack::PointEval1D< Scalar >::PointEval1D ( const Scalar &  alpha_in,
const Scalar &  phi_in,
const Scalar &  Dphi_in = valNotGiven() 
) [inline]

Definition at line 82 of file GlobiPack_Types.hpp.


Member Function Documentation

template<class Scalar>
static Scalar GlobiPack::PointEval1D< Scalar >::valNotGiven (  )  [inline, static]

Definition at line 76 of file GlobiPack_Types.hpp.


Member Data Documentation

template<class Scalar>
Scalar GlobiPack::PointEval1D< Scalar >::alpha

The value of the unknown alpha.

Definition at line 87 of file GlobiPack_Types.hpp.

template<class Scalar>
Scalar GlobiPack::PointEval1D< Scalar >::phi

The value of the merit function phi(alpha).

Definition at line 89 of file GlobiPack_Types.hpp.

template<class Scalar>
Scalar GlobiPack::PointEval1D< Scalar >::Dphi

The value of the derivative of the merit function Dphi(alpha).

Definition at line 92 of file GlobiPack_Types.hpp.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends
Generated on Wed Apr 13 09:57:19 2011 for GlobiPack by  doxygen 1.6.3