Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Member Functions | Related Symbols | List of all members
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]

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.
 
- Public Member Functions inherited from Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, DefaultEvalTypeTraits > >
 ParameterFamilyBase (const std::string &name, bool supports_ad, bool supports_analytic)
 Constructor.
 
virtual ~ParameterFamilyBase ()
 Destructor.
 
std::string getName () const
 Get the name of the family.
 
bool supportsAD () const
 Indicates whether parameter supports AD derivatives.
 
bool supportsAnalytic () const
 Indicates whether parameter supports analytic derivatives.
 
bool hasType () const
 Determine if family has an entry for the given type EvalType.
 
bool addEntry (const Teuchos::RCP< typename Sacado::mpl::apply< ScalarParameterEntry< _, DefaultEvalTypeTraits >, EvalType >::type > &entry, const bool allow_overwrite=false)
 Add a new parameter using custom entry.
 
Teuchos::RCP< typename Sacado::mpl::apply< ScalarParameterEntry< _, DefaultEvalTypeTraits >, EvalType >::type > getEntry ()
 Gets the entry corresponding to type EvalType.
 
Teuchos::RCP< const typename Sacado::mpl::apply< ScalarParameterEntry< _, DefaultEvalTypeTraits >, EvalType >::type > getEntry () const
 Gets the entry corresponding to type EvalType.
 
void print (std::ostream &os, bool print_values=false) const
 Print the family.
 

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.
 
ScalarParameterFamily & operator= (const ScalarParameterFamily &)
 Private to prohibit copying.
 

Related Symbols

(Note that these are not member symbols.)

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

Additional Inherited Members

- Protected Types inherited from Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, DefaultEvalTypeTraits > >
typedef std::map< std::string, Teuchos::RCP< AbstractScalarParameterEntry > > EvalMap
 Map of entries for a parameter name.
 
typedef EvalMap::const_iterator const_iterator
 Const iterator for EvalMap.
 
typedef EvalMap::iterator iterator
 Iterator for EvalMap.
 
- Protected Member Functions inherited from Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, DefaultEvalTypeTraits > >
std::string getTypeName () const
 Returns a string representation of type EntryType.
 
- Protected Attributes inherited from Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, DefaultEvalTypeTraits > >
EvalMap family
 Family of parameter entries.
 
const std::string name
 Family name.
 
bool supports_ad
 Family supports AD.
 
bool supports_analytic
 Family supports analytic derivatives.
 

Detailed Description

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

Specialization of Sacado::ParameterFamilyBase for scalar parameters.

Definition at line 42 of file Sacado_ScalarParameterFamily.hpp.

Member Typedef Documentation

◆ BaseT

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

Typename synonym of base class.

Definition at line 49 of file Sacado_ScalarParameterFamily.hpp.

Constructor & Destructor Documentation

◆ ScalarParameterFamily() [1/2]

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

Constructor.

Definition at line 54 of file Sacado_ScalarParameterFamily.hpp.

◆ ~ScalarParameterFamily()

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual Sacado::ScalarParameterFamily< EvalTypeTraits >::~ScalarParameterFamily ( )
inlinevirtual

Destructor.

Definition at line 61 of file Sacado_ScalarParameterFamily.hpp.

◆ ScalarParameterFamily() [2/2]

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

◆ setRealValueForAllTypes()

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

Set paramter value using a real number.

Definition at line 64 of file Sacado_ScalarParameterFamily.hpp.

◆ setRealValue()

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

Set real parameter value.

Definition at line 73 of file Sacado_ScalarParameterFamily.hpp.

◆ setValue()

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 81 of file Sacado_ScalarParameterFamily.hpp.

◆ getRealValue()

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

Get real parameter value.

Definition at line 89 of file Sacado_ScalarParameterFamily.hpp.

◆ getValue()

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 97 of file Sacado_ScalarParameterFamily.hpp.

◆ operator=()

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

Private to prohibit copying.

Friends And Related Symbol Documentation

◆ getValue()

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

Get the value.

Definition at line 124 of file Sacado_ScalarParameterFamily.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.13.2