TSFExtended::IndexableVector< Scalar > Class Template Reference

TSFExtended::IndexableVector defines an interface through which elements for a vector can be accessed for both reading and writing through indexing operators. More...

Inheritance diagram for TSFExtended::IndexableVector< Scalar >:

List of all members.

Public Member Functions
virtual	~IndexableVector ()
	virtual dtor
virtual const Scalar &	operator[] (OrdType globalIndex) const =0
	read the element at the given global index
virtual Scalar &	operator[] (OrdType globalIndex)=0
	writable access to the element at the given global index
virtual void	setElement (OrdType globalIndex, const Scalar &value)
	set a single element at the given global index
virtual void	addToElement (OrdType globalIndex, const Scalar &value)
	add to the existing value of a single element at the given global index
virtual const Scalar &	getElement (OrdType globalIndex) const
	get the element at the given global index

---

Detailed Description

template<class Scalar>
class TSFExtended::IndexableVector< Scalar >

TSFExtended::IndexableVector defines an interface through which elements for a vector can be accessed for both reading and writing through indexing operators.

Default implementations of the loadable and accessible interface methods are provided.

Author:

Kevin Long (krlong@sandia.gov)

Definition at line 54 of file TSFIndexableVector.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

virtual TSFExtended::IndexableVector< Scalar >::~IndexableVector

(

)

[inline, virtual]

virtual dtor

Definition at line 59 of file TSFIndexableVector.hpp.

---

Member Function Documentation

template<class Scalar>

virtual void TSFExtended::IndexableVector< Scalar >::addToElement	(	OrdType	globalIndex,
		const Scalar &	value
	)		[inline, virtual]

add to the existing value of a single element at the given global index

Implements TSFExtended::LoadableVector< Scalar >.

Reimplemented in TSFExtended::EpetraMultiVector, TSFExtended::EpetraVector, and TSFExtended::SerialVector.

Definition at line 73 of file TSFIndexableVector.hpp.

template<class Scalar>

virtual const Scalar& TSFExtended::IndexableVector< Scalar >::getElement

(

OrdType

globalIndex

)

const [inline, virtual]

get the element at the given global index

Implements TSFExtended::AccessibleVector< Scalar >.

Reimplemented in TSFExtended::EpetraMultiVector, TSFExtended::EpetraVector, and TSFExtended::SerialVector.

Definition at line 77 of file TSFIndexableVector.hpp.

template<class Scalar>

virtual Scalar& TSFExtended::IndexableVector< Scalar >::operator[]

(

OrdType

globalIndex

)

[pure virtual]

writable access to the element at the given global index

Implemented in TSFExtended::EpetraMultiVector, TSFExtended::EpetraVector, and TSFExtended::SerialVector.

template<class Scalar>

virtual const Scalar& TSFExtended::IndexableVector< Scalar >::operator[]

(

OrdType

globalIndex

)

const [pure virtual]

read the element at the given global index

Implemented in TSFExtended::EpetraMultiVector, TSFExtended::EpetraVector, and TSFExtended::SerialVector.

Referenced by TSFExtended::IndexableVector< double >::addToElement(), TSFExtended::IndexableVector< double >::getElement(), and TSFExtended::IndexableVector< double >::setElement().

template<class Scalar>

virtual void TSFExtended::IndexableVector< Scalar >::setElement	(	OrdType	globalIndex,
		const Scalar &	value
	)		[inline, virtual]

set a single element at the given global index

Implements TSFExtended::LoadableVector< Scalar >.

Reimplemented in TSFExtended::EpetraMultiVector, TSFExtended::EpetraVector, and TSFExtended::SerialVector.

Definition at line 68 of file TSFIndexableVector.hpp.