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 >:

Inheritance graph
[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.

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.


Member Function Documentation

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.

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.


The documentation for this class was generated from the following files:
Generated on Tue Oct 20 12:54:54 2009 for Sacado by doxygen 1.4.7