Sacado::ParameterVectorBase< FamilyType, BaseValueType > Class Template Reference

A class to store the active parameters in a code in an ordered fashion, along with their "base" values, i.e., the floating point value upon which the templated values are based. More...

#include <Sacado_ParameterVectorBase.hpp>

Inheritance diagram for Sacado::ParameterVectorBase< FamilyType, BaseValueType >:

Classes
struct	Entry
	Container for parameter entries. More...

Public Types
typedef EntryVector::iterator	iterator
	Iterator typename.
typedef EntryVector::const_iterator	const_iterator
	Const iterator typename.

Public Member Functions
	ParameterVectorBase ()
	Default constructor.
	ParameterVectorBase (const ParameterVectorBase &source)
	Copy constructor.
virtual	~ParameterVectorBase ()
	Destructor.
ParameterVectorBase &	operator= (const ParameterVectorBase &source)
	Assignment.
void	addParam (const Teuchos::RCP< FamilyType > &family, BaseValueType baseValue)
	Add entry.
unsigned int	size () const
	Return number of parameters in vector.
Entry &	operator[] (int i)
	Element access.
const Entry &	operator[] (int i) const
	Element access.
iterator	begin ()
	Iterator pointing at beginning of vector.
const_iterator	begin () const
	Iterator pointing at beginning of vector.
iterator	end ()
	Iterator pointing at end of vector.
const_iterator	end () const
	Iterator pointing at end of vector.
void	filterParameters (ParameterVectorBase &ad, ParameterVectorBase &analytic, ParameterVectorBase &other, std::vector< int > &index_ad, std::vector< int > &index_analytic, std::vector< int > &index_other)
	Filter vector into types.

Protected Types
typedef Teuchos::Array< Entry >	EntryVector
	Vector of all parameter families.

Protected Attributes
EntryVector	params
	Parameter vector.

Detailed Description

template<typename FamilyType, typename BaseValueType>
class Sacado::ParameterVectorBase< FamilyType, BaseValueType >

A class to store the active parameters in a code in an ordered fashion, along with their "base" values, i.e., the floating point value upon which the templated values are based.

Constructor & Destructor Documentation

ParameterVectorBase() [1/2]

template<typename FamilyType, typename BaseValueType>

Sacado::ParameterVectorBase< FamilyType, BaseValueType >::ParameterVectorBase ( )

inline

Default constructor.

Referenced by filterParameters(), operator=(), and ParameterVectorBase().

ParameterVectorBase() [2/2]

template<typename FamilyType, typename BaseValueType>

Sacado::ParameterVectorBase< FamilyType, BaseValueType >::ParameterVectorBase ( const ParameterVectorBase< FamilyType, BaseValueType > & source )

inline

Copy constructor.

References ParameterVectorBase(), and params.

Member Function Documentation

addParam()

template<typename FamilyType, typename BaseValueType>

void Sacado::ParameterVectorBase< FamilyType, BaseValueType >::addParam ( const Teuchos::RCP< FamilyType > & family, BaseValueType baseValue )

inline

Add entry.

References Sacado::ParameterVectorBase< FamilyType, BaseValueType >::Entry::Entry(), and params.

Referenced by Sacado::ParameterLibraryBase< FamilyType, EntryType >::fillVector(), and Sacado::ScalarParameterLibrary< EvalTypeTraits >::fillVector().

begin() [1/2]

template<typename FamilyType, typename BaseValueType>

iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::begin ( )

inline

Iterator pointing at beginning of vector.

References params.

begin() [2/2]

template<typename FamilyType, typename BaseValueType>

const_iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::begin ( ) const

inline

Iterator pointing at beginning of vector.

References params.

end() [1/2]

template<typename FamilyType, typename BaseValueType>

iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::end ( )

inline

Iterator pointing at end of vector.

References params.

end() [2/2]

template<typename FamilyType, typename BaseValueType>

const_iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::end ( ) const

inline

Iterator pointing at end of vector.

References params.

filterParameters()

template<typename FamilyType, typename BaseValueType>

void Sacado::ParameterVectorBase< FamilyType, BaseValueType >::filterParameters ( ParameterVectorBase< FamilyType, BaseValueType > & ad, ParameterVectorBase< FamilyType, BaseValueType > & analytic, ParameterVectorBase< FamilyType, BaseValueType > & other, std::vector< int > & index_ad, std::vector< int > & index_analytic, std::vector< int > & index_other )

inline

Filter vector into types.

References ParameterVectorBase(), and params.

operator=()

template<typename FamilyType, typename BaseValueType>

ParameterVectorBase & Sacado::ParameterVectorBase< FamilyType, BaseValueType >::operator= ( const ParameterVectorBase< FamilyType, BaseValueType > & source )

inline

Assignment.

References ParameterVectorBase(), and params.

operator[]() [1/2]

template<typename FamilyType, typename BaseValueType>

Entry & Sacado::ParameterVectorBase< FamilyType, BaseValueType >::operator[] ( int i )

inline

Element access.

References params.

operator[]() [2/2]

template<typename FamilyType, typename BaseValueType>

const Entry & Sacado::ParameterVectorBase< FamilyType, BaseValueType >::operator[] ( int i ) const

inline

Element access.

References params.

size()

template<typename FamilyType, typename BaseValueType>

unsigned int Sacado::ParameterVectorBase< FamilyType, BaseValueType >::size ( ) const

inline

Return number of parameters in vector.

References params.

Member Data Documentation

params

template<typename FamilyType, typename BaseValueType>

EntryVector Sacado::ParameterVectorBase< FamilyType, BaseValueType >::params

protected

Parameter vector.

Referenced by addParam(), begin(), begin(), end(), end(), filterParameters(), operator=(), operator[](), operator[](), ParameterVectorBase(), and size().

---

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

• Sacado_ParameterVectorBase.hpp