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

#include <Sacado_ScalarParameterLibrary.hpp>

Inheritance diagram for Sacado::ScalarParameterLibrary< EvalTypeTraits >:

Public Types
typedef ParameterLibraryBase < ScalarParameterFamily < EvalTypeTraits > , ScalarParameterEntry< _, EvalTypeTraits > >	BaseT
	Typename synonym of base class. More...

Public Types inherited from Sacado::ParameterLibraryBase< ScalarParameterFamily< EvalTypeTraits >, ScalarParameterEntry< _, EvalTypeTraits > >
typedef FamilyMap::iterator	iterator
	Iterator typename. More...

typedef FamilyMap::const_iterator	const_iterator
	Const iterator typename. More...

Public Member Functions
	ScalarParameterLibrary ()
	Default constructor. More...

virtual	~ScalarParameterLibrary ()
	Destructor. More...

void	setRealValueForAllTypes (const std::string &name, double value)
	Set paramter value using a real number. More...

template<class EvalType >
void	setRealValue (const std::string &name, double value)
	Set real parameter to value value. More...

template<class EvalType >
void	setValue (const std::string &name, const typename EvalTypeTraits::template apply< EvalType >::type &value)
	Set parameter to value value. More...

template<class EvalType >
double	getRealValue (const std::string &name) const
	Get parameter value. More...

template<class EvalType >
const EvalTypeTraits::template apply< EvalType >::type &	getValue (const std::string &name) const
	Get parameter value. More...

template<class EvalType >
void	fillVector (const Teuchos::Array< std::string > &names, ScalarParameterVector< EvalTypeTraits > &pv)
	Fill a vector with the supplied parameter names. More...

Public Member Functions inherited from Sacado::ParameterLibraryBase< ScalarParameterFamily< EvalTypeTraits >, ScalarParameterEntry< _, EvalTypeTraits > >
	ParameterLibraryBase ()
	Default constructor. More...

virtual	~ParameterLibraryBase ()
	Destructor. More...

bool	isParameter (const std::string &name) const
	Determine if parameter of name name is in the library. More...

bool	isParameterForType (const std::string &name) const
	Determine if parameter of name name has type type. More...

bool	addParameterFamily (const std::string &name, bool supports_ad, bool supports_analytic)
	Create a new parameter family. More...

bool	addEntry (const std::string &name, const Teuchos::RCP< typename Sacado::mpl::apply< ScalarParameterEntry< _, EvalTypeTraits >, EvalType >::type > &entry, const bool allow_overwrite=false)
	Add a new parameter using custom entry. More...

Teuchos::RCP< typename Sacado::mpl::apply < ScalarParameterEntry< _, EvalTypeTraits >, EvalType > ::type >	getEntry (const std::string &name)
	Return parameter entry. More...

Teuchos::RCP< const typename Sacado::mpl::apply < ScalarParameterEntry< _, EvalTypeTraits >, EvalType > ::type >	getEntry (const std::string &name) const
	Return parameter entry. More...

unsigned int	size () const
	Return number of parameters in library. More...

iterator	begin ()
	Iterator pointing at beginning of library. More...

const_iterator	begin () const
	Iterator pointing at beginning of library. More...

iterator	end ()
	Iterator pointing at end of library. More...

const_iterator	end () const
	Iterator pointing at end of library. More...

void	fillVector (const Teuchos::Array< std::string > &names, const Teuchos::Array< BaseValueType > &values, ParameterVectorBase< ScalarParameterFamily< EvalTypeTraits >, BaseValueType > &pv)
	Fill a vector with the supplied parameter names and values. More...

void	print (std::ostream &os, bool print_values=false) const
	Print parameter library. More...

void	clear ()
	Clear the library. More...

Static Public Member Functions
static ScalarParameterLibrary &	getInstance ()
	Returns a parameter library (singleton object). More...

Private Member Functions
	ScalarParameterLibrary (const ScalarParameterLibrary &)
	Private to prohibit copying. More...

ScalarParameterLibrary &	operator= (const ScalarParameterLibrary &)
	Private to prohibit copying. More...

Additional Inherited Members
Protected Types inherited from Sacado::ParameterLibraryBase< ScalarParameterFamily< EvalTypeTraits >, ScalarParameterEntry< _, EvalTypeTraits > >
typedef std::map< string, Teuchos::RCP < ScalarParameterFamily < EvalTypeTraits > > >	FamilyMap
	Map of all parameter families. More...

Protected Attributes inherited from Sacado::ParameterLibraryBase< ScalarParameterFamily< EvalTypeTraits >, ScalarParameterEntry< _, EvalTypeTraits > >
FamilyMap	library
	Scalar parameter library. More...

Detailed Description

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

Specialization of Sacado::ParameterLibraryBase for scalar parameters.

Definition at line 26 of file Sacado_ScalarParameterLibrary.hpp.

Member Typedef Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>

typedef ParameterLibraryBase<ScalarParameterFamily<EvalTypeTraits>, ScalarParameterEntry<_,EvalTypeTraits> > Sacado::ScalarParameterLibrary< EvalTypeTraits >::BaseT

Typename synonym of base class.

Definition at line 35 of file Sacado_ScalarParameterLibrary.hpp.

Constructor & Destructor Documentation

template<typename EvalTypeTraits = DefaultEvalTypeTraits>

Sacado::ScalarParameterLibrary< EvalTypeTraits >::ScalarParameterLibrary ( )

inline

Default constructor.

Definition at line 38 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual Sacado::ScalarParameterLibrary< EvalTypeTraits >::~ScalarParameterLibrary ( )

inlinevirtual

Destructor.

Definition at line 41 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>

Sacado::ScalarParameterLibrary< EvalTypeTraits >::ScalarParameterLibrary ( const ScalarParameterLibrary< EvalTypeTraits > & )

private

Private to prohibit copying.

Member Function Documentation

template<typename EvalTypeTraits >

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

Set paramter value using a real number.

Definition at line 99 of file Sacado_ScalarParameterLibrary.hpp.

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 114 of file Sacado_ScalarParameterLibrary.hpp.

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 129 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits >

template<class EvalType >

double Sacado::ScalarParameterLibrary< EvalTypeTraits >::getRealValue ( const std::string & name ) const

Get parameter value.

Definition at line 146 of file Sacado_ScalarParameterLibrary.hpp.

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 161 of file Sacado_ScalarParameterLibrary.hpp.

template<typename EvalTypeTraits = DefaultEvalTypeTraits>

static ScalarParameterLibrary& Sacado::ScalarParameterLibrary< EvalTypeTraits >::getInstance ( )

inlinestatic

Returns a parameter library (singleton object).

Definition at line 68 of file Sacado_ScalarParameterLibrary.hpp.

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 176 of file Sacado_ScalarParameterLibrary.hpp.

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:

Sacado_ScalarParameterLibrary.hpp

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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