Sacado::ParameterFamilyBase< EntryBase, EntryType > Class Template Reference

#include <Sacado_ParameterFamilyBase.hpp>

Inheritance diagram for Sacado::ParameterFamilyBase< EntryBase, EntryType >:

[legend]List of all members.

Public Member Functions
	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.
template<typename ValueType>
bool	hasType () const
	Determine if family has an entry for the given type ValueType.
template<typename ValueType>
bool	addEntry (const Teuchos::RCP< EntryType< ValueType > > &entry)
	Add a new parameter using custom entry.
template<typename ValueType>
Teuchos::RCP< EntryType< ValueType > >	getEntry ()
	Gets the entry corresponding to type ValueType.
template<typename ValueType>
Teuchos::RCP< const EntryType< ValueType > >	getEntry () const
	Gets the entry corresponding to type ValueType.
void	printFamily (std::ostream &os) const
	Print the family.
Protected Types
typedef std::map< std::string, Teuchos::RCP< EntryBase > >	ValueMap
	Map of entries for a parameter name.
typedef ValueMap::const_iterator	const_iterator
	Const iterator for ValueMap.
typedef ValueMap::iterator	iterator
	Iterator for ValueMap.
Protected Member Functions
template<class ValueType>
std::string	getTypeName () const
	Returns a string representation of type ValueType.
Protected Attributes
ValueMap	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 EntryBase, template< typename > class EntryType>
class Sacado::ParameterFamilyBase< EntryBase, EntryType >

A class to store multiple template instantiations of a single templated parameter.

---

Member Function Documentation

template<typename EntryBase, template< typename > class EntryType>

template<class ValueType>

bool Sacado::ParameterFamilyBase< EntryBase, EntryType >::addEntry

(

const Teuchos::RCP< EntryType< ValueType > > &

entry

)

Add a new parameter using custom entry.

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

---

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

• Sacado_ParameterFamilyBase.hpp
• Sacado_ParameterFamilyBaseImp.hpp

---