Sacado::ScalarParameterLibrary< EvalTypeTraits > Class Template Reference

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

#include <Sacado_ScalarParameterLibrary.hpp>

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

List of all members.

Public Types

typedef ParameterLibraryBase
< ScalarParameterFamily
< EvalTypeTraits >
, ScalarParameterEntry< _,
EvalTypeTraits > > 
BaseT
 Typename synonym of base class.

Public Member Functions

 ScalarParameterLibrary ()
 Default constructor.
virtual ~ScalarParameterLibrary ()
 Destructor.
void setRealValueForAllTypes (const std::string &name, double value)
 Set paramter value using a real number.
template<class EvalType >
void setRealValue (const std::string &name, double value)
 Set real parameter to value value.
template<class EvalType >
void setValue (const std::string &name, const typename EvalTypeTraits::template apply< EvalType >::type &value)
 Set parameter to value value.
template<class EvalType >
double getRealValue (const std::string &name) const
 Get parameter value.
template<class EvalType >
const EvalTypeTraits::template
apply< EvalType >::type & 
getValue (const std::string &name) const
 Get parameter value.
template<class EvalType >
void fillVector (const Teuchos::Array< std::string > &names, ScalarParameterVector< EvalTypeTraits > &pv)
 Fill a vector with the supplied parameter names.

Static Public Member Functions

static ScalarParameterLibrarygetInstance ()
 Returns a parameter library (singleton object).

Private Member Functions

 ScalarParameterLibrary (const ScalarParameterLibrary &)
 Private to prohibit copying.
ScalarParameterLibraryoperator= (const ScalarParameterLibrary &)
 Private to prohibit copying.

Detailed Description

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

Specialization of Sacado::ParameterLibraryBase for scalar parameters.

Definition at line 45 of file Sacado_ScalarParameterLibrary.hpp.


Member Typedef Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
typedef ParameterLibraryBase<ScalarParameterFamily<EvalTypeTraits>, ScalarParameterEntry<_,EvalTypeTraits> > Sacado::ScalarParameterLibrary< EvalTypeTraits >::BaseT

Typename synonym of base class.

Definition at line 45 of file Sacado_ScalarParameterLibrary.hpp.


Constructor & Destructor Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ScalarParameterLibrary< EvalTypeTraits >::ScalarParameterLibrary (  )  [inline]

Default constructor.

Definition at line 48 of file Sacado_ScalarParameterLibrary.hpp.

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

Destructor.

Definition at line 51 of file Sacado_ScalarParameterLibrary.hpp.

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

Private to prohibit copying.


Member Function Documentation

template<typename EvalTypeTraits >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::setRealValueForAllTypes ( const std::string &  name,
double  value 
) [inline]

Set paramter value using a real number.

Definition at line 121 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits >
template<class EvalType >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::setRealValue ( const std::string &  name,
double  value 
) [inline]

Set real parameter to value value.

Definition at line 136 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits >
template<class EvalType >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::setValue ( const std::string &  name,
const typename EvalTypeTraits::template apply< EvalType >::type &  value 
) [inline]

Set parameter to value value.

Definition at line 151 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits >
template<class EvalType >
double Sacado::ScalarParameterLibrary< EvalTypeTraits >::getRealValue ( const std::string &  name  )  const [inline]

Get parameter value.

Definition at line 168 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits >
template<class EvalType >
const EvalTypeTraits::template apply< EvalType >::type & Sacado::ScalarParameterLibrary< EvalTypeTraits >::getValue ( const std::string &  name  )  const [inline]

Get parameter value.

Definition at line 183 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
static ScalarParameterLibrary& Sacado::ScalarParameterLibrary< EvalTypeTraits >::getInstance (  )  [inline, static]

Returns a parameter library (singleton object).

Definition at line 78 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits >
template<class EvalType >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::fillVector ( const Teuchos::Array< std::string > &  names,
Sacado::ScalarParameterVector< EvalTypeTraits > &  pv 
) [inline]

Fill a vector with the supplied parameter names.

baseValue will be computed from each individual parameter using the corresponding evaluation type EvalType

Definition at line 198 of file Sacado_ScalarParameterLibrary.hpp.

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

Private to prohibit copying.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:19:43 2011 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.6.3