Sacado Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
Sacado::ScalarParameterLibrary< EvalTypeTraits > Class Template Reference

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

#include <Sacado_ScalarParameterLibrary.hpp>

Inheritance diagram for Sacado::ScalarParameterLibrary< EvalTypeTraits >:
Inheritance graph
[legend]

Public Types

typedef ParameterLibraryBase< ScalarParameterFamily< EvalTypeTraits >, ScalarParameterEntry< _, EvalTypeTraits > > BaseT
 Typename synonym of base class.
 
- Public Types inherited from Sacado::ParameterLibraryBase< FamilyType, EntryType >
typedef FamilyMap::iterator iterator
 Iterator typename.
 
typedef FamilyMap::const_iterator const_iterator
 Const iterator typename.
 

Public Member Functions

 ScalarParameterLibrary ()
 Default constructor.
 
virtual ~ScalarParameterLibrary ()
 Destructor.
 
void setRealValueForAllTypes (const std::string &name, double value)
 Set paramter value using a real number.
 
template<class EvalType >
void setRealValue (const std::string &name, double value)
 Set real parameter to value value.
 
template<class EvalType >
void setValue (const std::string &name, const typename EvalTypeTraits::template apply< EvalType >::type &value)
 Set parameter to value value.
 
template<class EvalType >
double getRealValue (const std::string &name) const
 Get parameter value.
 
template<class EvalType >
const EvalTypeTraits::template apply< EvalType >::type & getValue (const std::string &name) const
 Get parameter value.
 
template<class EvalType >
void fillVector (const Teuchos::Array< std::string > &names, ScalarParameterVector< EvalTypeTraits > &pv)
 Fill a vector with the supplied parameter names.
 
- Public Member Functions inherited from Sacado::ParameterLibraryBase< FamilyType, EntryType >
 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, const bool allow_overwrite=false)
 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.
 
void clear ()
 Clear the library.
 

Static Public Member Functions

static ScalarParameterLibrarygetInstance ()
 Returns a parameter library (singleton object).
 

Private Member Functions

 ScalarParameterLibrary (const ScalarParameterLibrary &)
 Private to prohibit copying.
 
ScalarParameterLibraryoperator= (const ScalarParameterLibrary &)
 Private to prohibit copying.
 

Additional Inherited Members

- Protected Types inherited from Sacado::ParameterLibraryBase< FamilyType, EntryType >
typedef std::map< string, Teuchos::RCP< FamilyType > > FamilyMap
 Map of all parameter families.
 
- Protected Attributes inherited from Sacado::ParameterLibraryBase< FamilyType, EntryType >
FamilyMap library
 Scalar parameter library.
 

Detailed Description

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
class Sacado::ScalarParameterLibrary< EvalTypeTraits >

Specialization of Sacado::ParameterLibraryBase for scalar parameters.

Definition at line 46 of file Sacado_ScalarParameterLibrary.hpp.

Member Typedef Documentation

◆ BaseT

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
typedef ParameterLibraryBase<ScalarParameterFamily<EvalTypeTraits>, ScalarParameterEntry<_,EvalTypeTraits> > Sacado::ScalarParameterLibrary< EvalTypeTraits >::BaseT

Typename synonym of base class.

Definition at line 55 of file Sacado_ScalarParameterLibrary.hpp.

Constructor & Destructor Documentation

◆ ScalarParameterLibrary() [1/2]

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ScalarParameterLibrary< EvalTypeTraits >::ScalarParameterLibrary ( )
inline

Default constructor.

Definition at line 58 of file Sacado_ScalarParameterLibrary.hpp.

◆ ~ScalarParameterLibrary()

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
virtual Sacado::ScalarParameterLibrary< EvalTypeTraits >::~ScalarParameterLibrary ( )
inlinevirtual

Destructor.

Definition at line 61 of file Sacado_ScalarParameterLibrary.hpp.

◆ ScalarParameterLibrary() [2/2]

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
Sacado::ScalarParameterLibrary< EvalTypeTraits >::ScalarParameterLibrary ( const ScalarParameterLibrary< EvalTypeTraits > & )
private

Private to prohibit copying.

Member Function Documentation

◆ setRealValueForAllTypes()

template<typename EvalTypeTraits >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::setRealValueForAllTypes ( const std::string & name,
double value )

Set paramter value using a real number.

Definition at line 118 of file Sacado_ScalarParameterLibrary.hpp.

◆ setRealValue()

template<typename EvalTypeTraits >
template<class EvalType >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::setRealValue ( const std::string & name,
double value )

Set real parameter to value value.

Definition at line 133 of file Sacado_ScalarParameterLibrary.hpp.

◆ setValue()

template<typename EvalTypeTraits >
template<class EvalType >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::setValue ( const std::string & name,
const typename EvalTypeTraits::template apply< EvalType >::type & value )

Set parameter to value value.

Definition at line 148 of file Sacado_ScalarParameterLibrary.hpp.

◆ getRealValue()

template<typename EvalTypeTraits >
template<class EvalType >
double Sacado::ScalarParameterLibrary< EvalTypeTraits >::getRealValue ( const std::string & name) const

Get parameter value.

Definition at line 165 of file Sacado_ScalarParameterLibrary.hpp.

◆ getValue()

template<typename EvalTypeTraits >
template<class EvalType >
const EvalTypeTraits::template apply< EvalType >::type & Sacado::ScalarParameterLibrary< EvalTypeTraits >::getValue ( const std::string & name) const

Get parameter value.

Definition at line 180 of file Sacado_ScalarParameterLibrary.hpp.

◆ getInstance()

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
static ScalarParameterLibrary & Sacado::ScalarParameterLibrary< EvalTypeTraits >::getInstance ( )
inlinestatic

Returns a parameter library (singleton object).

Definition at line 88 of file Sacado_ScalarParameterLibrary.hpp.

◆ fillVector()

template<typename EvalTypeTraits >
template<class EvalType >
void Sacado::ScalarParameterLibrary< EvalTypeTraits >::fillVector ( const Teuchos::Array< std::string > & names,
Sacado::ScalarParameterVector< EvalTypeTraits > & pv )

Fill a vector with the supplied parameter names.

baseValue will be computed from each individual parameter using the corresponding evaluation type EvalType

Definition at line 195 of file Sacado_ScalarParameterLibrary.hpp.

◆ operator=()

template<typename EvalTypeTraits = DefaultEvalTypeTraits>
ScalarParameterLibrary & Sacado::ScalarParameterLibrary< EvalTypeTraits >::operator= ( const ScalarParameterLibrary< EvalTypeTraits > & )
private

Private to prohibit copying.


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