Sacado::ParameterLibraryBase< FamilyType, EntryType > Class Template Reference

Class to provide a centralized library for setting/retrieving numerical parameter values. More...

#include <Sacado_ParameterLibraryBase.hpp>

Inheritance diagram for Sacado::ParameterLibraryBase< FamilyType, EntryType >:

[legend]List of all members.

Public Types
typedef FamilyMap::iterator	iterator
	Iterator typename.
typedef FamilyMap::const_iterator	const_iterator
	Const iterator typename.
Public Member Functions
	ParameterLibraryBase ()
	Default constructor.
virtual	~ParameterLibraryBase ()
	Destructor.
bool	isParameter (const std::string &name) const
	Determine if parameter of name name is in the library.
template<typename ValueType>
bool	isParameterForType (const std::string &name) const
	Determine if parameter of name name has type type.
bool	addParameterFamily (const std::string &name, bool supports_ad, bool supports_analytic)
	Create a new scalar parameter family.
template<typename ValueType>
bool	addEntry (const std::string &name, const Teuchos::RCP< EntryType< ValueType > > &entry)
	Add a new scalar parameter using custom entry.
template<typename ValueType>
Teuchos::RCP< EntryType< ValueType > >	getEntry (const std::string &name)
	Return parameter entry.
unsigned int	size () const
	Return number of parameters in library.
iterator	begin ()
	Iterator pointing at beginning of library.
const_iterator	begin () const
	Iterator pointing at beginning of library.
iterator	end ()
	Iterator pointing at end of library.
const_iterator	end () const
	Iterator pointing at end of library.
template<typename BaseValueType>
void	fillVector (const Teuchos::Array< std::string > &names, const Teuchos::Array< BaseValueType > &values, ParameterVectorBase< FamilyType, BaseValueType > &pv)
	Fill a vector with the supplied parameter names and values.
Protected Types
typedef std::map< string, Teuchos::RCP< FamilyType > >	FamilyMap
	Map of all parameter families.
Protected Attributes
FamilyMap	library
	Scalar parameter library.
Private Member Functions
	ParameterLibraryBase (const ParameterLibraryBase &)
	Private to prohibit copying.
ParameterLibraryBase &	operator= (const ParameterLibraryBase &)
	Private to prohibit copying.

---

Detailed Description

template<typename FamilyType, template< typename > class EntryType>
class Sacado::ParameterLibraryBase< FamilyType, EntryType >

Class to provide a centralized library for setting/retrieving numerical parameter values.

Definition at line 49 of file Sacado_ParameterLibraryBase.hpp.

---

Member Typedef Documentation

template<typename FamilyType, template< typename > class EntryType>

typedef std::map<string, Teuchos::RCP<FamilyType> > Sacado::ParameterLibraryBase< FamilyType, EntryType >::FamilyMap [protected]

Map of all parameter families.

Definition at line 54 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

typedef FamilyMap::iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::iterator

Iterator typename.

Definition at line 59 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

typedef FamilyMap::const_iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::const_iterator

Const iterator typename.

Definition at line 62 of file Sacado_ParameterLibraryBase.hpp.

---

Constructor & Destructor Documentation

template<typename FamilyType, template< typename > class EntryType>

Sacado::ParameterLibraryBase< FamilyType, EntryType >::ParameterLibraryBase

(

)

Default constructor.

Definition at line 36 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

Sacado::ParameterLibraryBase< FamilyType, EntryType >::~ParameterLibraryBase

(

)

[virtual]

Destructor.

Definition at line 42 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

Sacado::ParameterLibraryBase< FamilyType, EntryType >::ParameterLibraryBase

(

const ParameterLibraryBase< FamilyType, EntryType > &

)

[private]

Private to prohibit copying.

---

Member Function Documentation

template<typename FamilyType, template< typename > class EntryType>

bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::isParameter

(

const std::string &

name

)

const

Determine if parameter of name name is in the library.

Definition at line 49 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

template<class ValueType>

bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::isParameterForType

(

const std::string &

name

)

const

Determine if parameter of name name has type type.

Definition at line 61 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::addParameterFamily	(	const std::string &	name,
		bool	supports_ad,
		bool	supports_analytic
	)

Create a new scalar parameter family.

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

Definition at line 77 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

template<class ValueType>

bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::addEntry	(	const std::string &	name,
		const Teuchos::RCP< EntryType< ValueType > > &	entry
	)

Add a new scalar parameter using custom entry.

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

Definition at line 97 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

template<class ValueType>

Teuchos::RCP< EntryType< ValueType > > Sacado::ParameterLibraryBase< FamilyType, EntryType >::getEntry

(

const std::string &

name

)

Return parameter entry.

Definition at line 118 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

unsigned int Sacado::ParameterLibraryBase< FamilyType, EntryType >::size

(

)

const [inline]

Return number of parameters in library.

Definition at line 101 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::begin

(

)

[inline]

Iterator pointing at beginning of library.

Definition at line 104 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

const_iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::begin

(

)

const [inline]

Iterator pointing at beginning of library.

Definition at line 107 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::end

(

)

[inline]

Iterator pointing at end of library.

Definition at line 110 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

const_iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::end

(

)

const [inline]

Iterator pointing at end of library.

Definition at line 113 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, template< typename > class EntryType>

template<typename BaseValueType>

void Sacado::ParameterLibraryBase< FamilyType, EntryType >::fillVector	(	const Teuchos::Array< std::string > &	names,
		const Teuchos::Array< BaseValueType > &	values,
		ParameterVectorBase< FamilyType, BaseValueType > &	pv
	)

Fill a vector with the supplied parameter names and values.

Definition at line 138 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, template< typename > class EntryType>

ParameterLibraryBase& Sacado::ParameterLibraryBase< FamilyType, EntryType >::operator=

(

const ParameterLibraryBase< FamilyType, EntryType > &

)

[private]

Private to prohibit copying.

---

Member Data Documentation

template<typename FamilyType, template< typename > class EntryType>

FamilyMap Sacado::ParameterLibraryBase< FamilyType, EntryType >::library [protected]

Scalar parameter library.

Definition at line 133 of file Sacado_ParameterLibraryBase.hpp.

---

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

• Sacado_ParameterLibraryBase.hpp
• Sacado_ParameterLibraryBaseImp.hpp

---