Sacado::ScalarParameterFamily< EvalTypeTraits > Class Template Reference

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

#include <Sacado_ScalarParameterFamily.hpp>

Inheritance diagram for Sacado::ScalarParameterFamily< EvalTypeTraits >:

Collaboration diagram for Sacado::ScalarParameterFamily< EvalTypeTraits >:

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< _, EvalTypeTraits > >
	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< _, EvalTypeTraits >, EvalType >::type > &entry, const bool allow_overwrite=false)
	Add a new parameter using custom entry. More...
Teuchos::RCP< typename Sacado::mpl::apply < ScalarParameterEntry< _, EvalTypeTraits >, EvalType > ::type >	getEntry ()
	Gets the entry corresponding to type EvalType.
Teuchos::RCP< const typename Sacado::mpl::apply < ScalarParameterEntry< _, EvalTypeTraits >, EvalType > ::type >	getEntry () const
	Gets the entry corresponding to type EvalType.
void	print (std::ostream &os, bool print_values=false) const
	Print the family. More...

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.

Additional Inherited Members
Protected Types inherited from Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, EvalTypeTraits > >
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< _, EvalTypeTraits > >
std::string	getTypeName () const
	Returns a string representation of type EntryType.
Protected Attributes inherited from Sacado::ParameterFamilyBase< AbstractScalarParameterEntry, ScalarParameterEntry< _, EvalTypeTraits > >
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.

---

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

• Sacado_ScalarParameterFamily.hpp