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 EvalType >
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 parameter family.
template<typename EvalType >
bool addEntry (const std::string &name, const Teuchos::RCP< typename Sacado::mpl::apply< EntryType, EvalType >::type > &entry)
 Add a new parameter using custom entry.
template<typename EvalType >
Teuchos::RCP< typename
Sacado::mpl::apply< EntryType,
EvalType >::type > 
getEntry (const std::string &name)
 Return parameter entry.
template<typename EvalType >
Teuchos::RCP< const typename
Sacado::mpl::apply< EntryType,
EvalType >::type > 
getEntry (const std::string &name) const
 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.
void print (std::ostream &os, bool print_values=false) const
 Print parameter library.

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

Detailed Description

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

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

Definition at line 50 of file Sacado_ParameterLibraryBase.hpp.


Member Typedef Documentation

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

Map of all parameter families.

Definition at line 55 of file Sacado_ParameterLibraryBase.hpp.

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

Iterator typename.

Definition at line 60 of file Sacado_ParameterLibraryBase.hpp.

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

Const iterator typename.

Definition at line 63 of file Sacado_ParameterLibraryBase.hpp.


Constructor & Destructor Documentation

template<typename FamilyType , typename EntryType >
Sacado::ParameterLibraryBase< FamilyType, EntryType >::ParameterLibraryBase (  )  [inline]

Default constructor.

Definition at line 36 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType , typename EntryType >
Sacado::ParameterLibraryBase< FamilyType, EntryType >::~ParameterLibraryBase (  )  [inline, virtual]

Destructor.

Definition at line 42 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, typename EntryType>
Sacado::ParameterLibraryBase< FamilyType, EntryType >::ParameterLibraryBase ( const ParameterLibraryBase< FamilyType, EntryType > &   )  [private]

Private to prohibit copying.


Member Function Documentation

template<typename FamilyType , typename EntryType >
bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::isParameter ( const std::string &  name  )  const [inline]

Determine if parameter of name name is in the library.

Definition at line 49 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType , typename EntryType >
template<class EvalType >
bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::isParameterForType ( const std::string &  name  )  const [inline]

Determine if parameter of name name has type type.

Definition at line 61 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType , typename EntryType >
bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::addParameterFamily ( const std::string &  name,
bool  supports_ad,
bool  supports_analytic 
) [inline]

Create a new 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 , typename EntryType>
template<class EvalType >
bool Sacado::ParameterLibraryBase< FamilyType, EntryType >::addEntry ( const std::string &  name,
const Teuchos::RCP< typename Sacado::mpl::apply< EntryType, EvalType >::type > &  entry 
) [inline]

Add a new 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 , typename EntryType >
template<class EvalType >
Teuchos::RCP< typename Sacado::mpl::apply< EntryType, EvalType >::type > Sacado::ParameterLibraryBase< FamilyType, EntryType >::getEntry ( const std::string &  name  )  [inline]

Return parameter entry.

Definition at line 118 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType , typename EntryType >
template<class EvalType >
Teuchos::RCP< const typename Sacado::mpl::apply< EntryType, EvalType >::type > Sacado::ParameterLibraryBase< FamilyType, EntryType >::getEntry ( const std::string &  name  )  const [inline]

Return parameter entry.

Definition at line 138 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, typename EntryType>
unsigned int Sacado::ParameterLibraryBase< FamilyType, EntryType >::size (  )  const [inline]

Return number of parameters in library.

Definition at line 107 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, typename EntryType>
iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::begin (  )  [inline]

Iterator pointing at beginning of library.

Definition at line 110 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, typename EntryType>
const_iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::begin (  )  const [inline]

Iterator pointing at beginning of library.

Definition at line 113 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, typename EntryType>
iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::end (  )  [inline]

Iterator pointing at end of library.

Definition at line 116 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, typename EntryType>
const_iterator Sacado::ParameterLibraryBase< FamilyType, EntryType >::end (  )  const [inline]

Iterator pointing at end of library.

Definition at line 119 of file Sacado_ParameterLibraryBase.hpp.

template<typename FamilyType, typename 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 
) [inline]

Fill a vector with the supplied parameter names and values.

Definition at line 158 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType , typename EntryType >
void Sacado::ParameterLibraryBase< FamilyType, EntryType >::print ( std::ostream &  os,
bool  print_values = false 
) const [inline]

Print parameter library.

Set print_values = true to print each parameter value for each evaluation type.

Definition at line 179 of file Sacado_ParameterLibraryBaseImp.hpp.

template<typename FamilyType, typename EntryType>
ParameterLibraryBase& Sacado::ParameterLibraryBase< FamilyType, EntryType >::operator= ( const ParameterLibraryBase< FamilyType, EntryType > &   )  [private]

Private to prohibit copying.


Member Data Documentation

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

Scalar parameter library.

Definition at line 146 of file Sacado_ParameterLibraryBase.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:19:43 2011 for Sacado Package Browser (Single Doxygen Collection) by  doxygen 1.6.3