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

List of all members.

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.

Definition at line 49 of file Sacado_ParameterVectorBase.hpp.

---

Member Typedef Documentation

template<typename FamilyType, typename BaseValueType>

typedef Teuchos::Array<Entry> Sacado::ParameterVectorBase< FamilyType, BaseValueType >::EntryVector [protected]

Vector of all parameter families.

Definition at line 71 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

typedef EntryVector::iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::iterator

Iterator typename.

Definition at line 76 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

typedef EntryVector::const_iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::const_iterator

Const iterator typename.

Definition at line 79 of file Sacado_ParameterVectorBase.hpp.

---

Constructor & Destructor Documentation

template<typename FamilyType, typename BaseValueType>

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

(

)

[inline]

Default constructor.

Definition at line 82 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

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

(

const ParameterVectorBase< FamilyType, BaseValueType > &

source

)

[inline]

Copy constructor.

Definition at line 85 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

virtual Sacado::ParameterVectorBase< FamilyType, BaseValueType >::~ParameterVectorBase

(

)

[inline, virtual]

Destructor.

Definition at line 89 of file Sacado_ParameterVectorBase.hpp.

---

Member Function Documentation

template<typename FamilyType, typename BaseValueType>

ParameterVectorBase& Sacado::ParameterVectorBase< FamilyType, BaseValueType >::operator=

(

const ParameterVectorBase< FamilyType, BaseValueType > &

source

)

[inline]

Assignment.

Definition at line 92 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

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

Add entry.

Definition at line 96 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

unsigned int Sacado::ParameterVectorBase< FamilyType, BaseValueType >::size

(

)

const [inline]

Return number of parameters in vector.

Definition at line 102 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

Entry& Sacado::ParameterVectorBase< FamilyType, BaseValueType >::operator[]

(

int

i

)

[inline]

Element access.

Definition at line 105 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

const Entry& Sacado::ParameterVectorBase< FamilyType, BaseValueType >::operator[]

(

int

i

)

const [inline]

Element access.

Definition at line 108 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

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

(

)

[inline]

Iterator pointing at beginning of vector.

Definition at line 111 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

const_iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::begin

(

)

const [inline]

Iterator pointing at beginning of vector.

Definition at line 114 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

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

(

)

[inline]

Iterator pointing at end of vector.

Definition at line 117 of file Sacado_ParameterVectorBase.hpp.

template<typename FamilyType, typename BaseValueType>

const_iterator Sacado::ParameterVectorBase< FamilyType, BaseValueType >::end

(

)

const [inline]

Iterator pointing at end of vector.

Definition at line 120 of file Sacado_ParameterVectorBase.hpp.

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.

Definition at line 124 of file Sacado_ParameterVectorBase.hpp.

---

Member Data Documentation

template<typename FamilyType, typename BaseValueType>

EntryVector Sacado::ParameterVectorBase< FamilyType, BaseValueType >::params [protected]

Parameter vector.

Definition at line 155 of file Sacado_ParameterVectorBase.hpp.

---

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

• Sacado_ParameterVectorBase.hpp