Sacado Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions | Private Types | Private Member Functions | Related Functions
Sacado::ScalarParameterFamily< EvalTypeTraits > Class Template Reference

Specialization of Sacado::ParameterFamilyBase for scalar parameters. More...

#include <Sacado_ScalarParameterFamily.hpp>

Inheritance diagram for Sacado::ScalarParameterFamily< EvalTypeTraits >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ScalarParameterFamily (const std::string &name_, bool supports_ad_, bool supports_analytic_)
 Constructor.
virtual ~ScalarParameterFamily ()
 Destructor.
void setRealValueForAllTypes (double value)
 Set paramter value using a real number.
template<class EvalType >
void setRealValue (double value)
 Set real parameter value.
template<class EvalType >
void setValue (const typename EvalTypeTraits::template apply< EvalType >::type &value)
 Set parameter to value value treating parameter as a constant.
template<class EvalType >
double getRealValue () const
 Get real parameter value.
template<class EvalType >
const EvalTypeTraits::template
apply< EvalType >::type & 
getValue () const
 Get parameter value.

Private Types

typedef
Sacado::ParameterFamilyBase
< AbstractScalarParameterEntry,
ScalarParameterEntry< _,
EvalTypeTraits > > 
BaseT
 Typename synonym of base class.

Private Member Functions

 ScalarParameterFamily (const ScalarParameterFamily &)
 Add a new parameter using custom entry.
ScalarParameterFamilyoperator= (const ScalarParameterFamily &)
 Private to prohibit copying.

Related Functions

(Note that these are not member functions.)

template<typename EvalType , typename EvalTypeTraits >
Sacado::ScalarParameterEntry
< EvalType >::ScalarT 
getValue (const ScalarParameterFamily< EvalTypeTraits > &spf)
 Get the value.

Detailed Description

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
class Sacado::ScalarParameterFamily< EvalTypeTraits >

Specialization of Sacado::ParameterFamilyBase for scalar parameters.

Definition at line 44 of file Sacado_ScalarParameterFamily.hpp.


Member Typedef Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
typedef Sacado::ParameterFamilyBase<AbstractScalarParameterEntry, ScalarParameterEntry<_,EvalTypeTraits> > Sacado::ScalarParameterFamily< EvalTypeTraits >::BaseT [private]

Typename synonym of base class.

Definition at line 51 of file Sacado_ScalarParameterFamily.hpp.


Constructor & Destructor Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ScalarParameterFamily< EvalTypeTraits >::ScalarParameterFamily ( const std::string &  name_,
bool  supports_ad_,
bool  supports_analytic_ 
) [inline]

Constructor.

Definition at line 56 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual Sacado::ScalarParameterFamily< EvalTypeTraits >::~ScalarParameterFamily ( ) [inline, virtual]

Destructor.

Definition at line 63 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ScalarParameterFamily< EvalTypeTraits >::ScalarParameterFamily ( const ScalarParameterFamily< EvalTypeTraits > &  ) [private]

Add a new parameter using custom entry.

Returns true if successful in adding entry to library, false otherwise. Private to prohibit copying


Member Function Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
void Sacado::ScalarParameterFamily< EvalTypeTraits >::setRealValueForAllTypes ( double  value) [inline]

Set paramter value using a real number.

Definition at line 66 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
template<class EvalType >
void Sacado::ScalarParameterFamily< EvalTypeTraits >::setRealValue ( double  value) [inline]

Set real parameter value.

Definition at line 75 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
template<class EvalType >
void Sacado::ScalarParameterFamily< EvalTypeTraits >::setValue ( const typename EvalTypeTraits::template apply< EvalType >::type &  value) [inline]

Set parameter to value value treating parameter as a constant.

Definition at line 83 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
template<class EvalType >
double Sacado::ScalarParameterFamily< EvalTypeTraits >::getRealValue ( ) const [inline]

Get real parameter value.

Definition at line 91 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
template<class EvalType >
const EvalTypeTraits::template apply<EvalType>::type& Sacado::ScalarParameterFamily< EvalTypeTraits >::getValue ( ) const [inline]

Get parameter value.

Definition at line 99 of file Sacado_ScalarParameterFamily.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
ScalarParameterFamily& Sacado::ScalarParameterFamily< EvalTypeTraits >::operator= ( const ScalarParameterFamily< EvalTypeTraits > &  ) [private]

Private to prohibit copying.


Friends And Related Function Documentation

template<typename EvalType , typename EvalTypeTraits >
Sacado::ScalarParameterEntry< EvalType >::ScalarT getValue ( const ScalarParameterFamily< EvalTypeTraits > &  spf) [related]

Get the value.

Definition at line 126 of file Sacado_ScalarParameterFamily.hpp.


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