RTOpPack::MutableSubVectorT< Scalar > Class Template Reference

Class for a mutable sub-vector. More...

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::MutableSubVectorT< Scalar >:

[legend]List of all members.

Public Member Functions
	MutableSubVectorT ()
	MutableSubVectorT (RTOp_index_type globalOffset, RTOp_index_type subDim, Scalar *values, ptrdiff_t stride)
	MutableSubVectorT (const MutableSubVectorT< Scalar > &sv)
void	initialize (RTOp_index_type globalOffset, RTOp_index_type subDim, Scalar *values, ptrdiff_t stride)
void	set_uninitialized ()
Scalar *	values () const
Scalar &	operator[] (RTOp_index_type i) const
	Zero-based indexing (Preconditions: values()!=NULL && (0 <= i <= subDim()-1)).
Scalar &	operator() (RTOp_index_type i) const
	One-based indexing (Preconditions: values()!=NULL && (1 <= i <= subDim())).

---

Detailed Description

template<class Scalar>
class RTOpPack::MutableSubVectorT< Scalar >

Class for a mutable sub-vector.

This class derives from SubVectorT and adds methods to mutate the data. Note, a const MutableSubVectorT object allows clients to change the values in the underlying subvector. The meaning of const in this context is that the view of the data can not change.

Warning! the default copy constructor and assignment operators are allowed which results in only pointer copy, not deep copy! You have been warned!

Definition at line 147 of file RTOpPack_Types.hpp.

---

Constructor & Destructor Documentation

template<class Scalar> RTOpPack::MutableSubVectorT< Scalar >::MutableSubVectorT (   )  [inline]

Definition at line 150 of file RTOpPack_Types.hpp.

template<class Scalar> RTOpPack::MutableSubVectorT< Scalar >::MutableSubVectorT (  RTOp_index_type  globalOffset, RTOp_index_type  subDim, Scalar *  values, ptrdiff_t  stride )  [inline]

Definition at line 152 of file RTOpPack_Types.hpp.

template<class Scalar> RTOpPack::MutableSubVectorT< Scalar >::MutableSubVectorT (  const MutableSubVectorT< Scalar > &  sv  )  [inline]

Definition at line 156 of file RTOpPack_Types.hpp.

---

Member Function Documentation

template<class Scalar> void RTOpPack::MutableSubVectorT< Scalar >::initialize (  RTOp_index_type  globalOffset, RTOp_index_type  subDim, Scalar *  values, ptrdiff_t  stride )  [inline]

Definition at line 160 of file RTOpPack_Types.hpp.

template<class Scalar> void RTOpPack::MutableSubVectorT< Scalar >::set_uninitialized (   )  [inline]

Reimplemented from RTOpPack::SubVectorT< Scalar >. Definition at line 163 of file RTOpPack_Types.hpp.

template<class Scalar> Scalar* RTOpPack::MutableSubVectorT< Scalar >::values (   )  const [inline]

Reimplemented from RTOpPack::SubVectorT< Scalar >. Definition at line 166 of file RTOpPack_Types.hpp.

template<class Scalar> Scalar& RTOpPack::MutableSubVectorT< Scalar >::operator[] (  RTOp_index_type  i  )  const [inline]

Zero-based indexing (Preconditions: values()!=NULL && (0 <= i <= subDim()-1)). Reimplemented from RTOpPack::SubVectorT< Scalar >. Definition at line 168 of file RTOpPack_Types.hpp.

template<class Scalar> Scalar& RTOpPack::MutableSubVectorT< Scalar >::operator() (  RTOp_index_type  i  )  const [inline]

One-based indexing (Preconditions: values()!=NULL && (1 <= i <= subDim())). Reimplemented from RTOpPack::SubVectorT< Scalar >. Definition at line 170 of file RTOpPack_Types.hpp.

---

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

• RTOpPack_Types.hpp

---