GlobiPack Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
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>

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. More...
 
Scalar phi
 The value of the merit function phi(alpha). More...
 
Scalar Dphi
 The value of the derivative of the merit function Dphi(alpha). More...
 

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 87 of file GlobiPack_Types.hpp.

Constructor & Destructor Documentation

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

Definition at line 91 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 95 of file GlobiPack_Types.hpp.

Member Function Documentation

template<class Scalar>
static Scalar GlobiPack::PointEval1D< Scalar >::valNotGiven ( )
inlinestatic

Definition at line 89 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 100 of file GlobiPack_Types.hpp.

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

The value of the merit function phi(alpha).

Definition at line 102 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 105 of file GlobiPack_Types.hpp.


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