RTOpPack::MutableSubMultiVectorT< Scalar > Class Template Reference

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

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::MutableSubMultiVectorT< Scalar >:

[legend]List of all members.

Public Member Functions
	MutableSubMultiVectorT ()
	MutableSubMultiVectorT (RTOp_index_type globalOffset, RTOp_index_type subDim, RTOp_index_type colOffset, RTOp_index_type numSubCols, const Scalar *values, RTOp_index_type leadingDim)
	MutableSubMultiVectorT (const MutableSubMultiVectorT< Scalar > &smv)
void	initialize (RTOp_index_type globalOffset, RTOp_index_type subDim, RTOp_index_type colOffset, RTOp_index_type numSubCols, const Scalar *values, RTOp_index_type leadingDim)
void	set_uninitialized ()
Scalar *	values () const
Scalar &	operator() (RTOp_index_type i, RTOp_index_type j) const
	One-based indexing (Preconditions: values()!=NULL && (1 <= i <= subDim()) && (1<= j <= numSubCols()).
MutableSubVectorT< Scalar >	col (const RTOp_index_type j) const
	Return a MutableSubVectorT view of the jth sub-column (Preconditions: values()!=NULL && (1<=i<=subDim()) && (1<=j<= numSubCols()).

---

Detailed Description

template<class Scalar>
class RTOpPack::MutableSubMultiVectorT< 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 459 of file RTOpPack_Types.hpp.

---

Constructor & Destructor Documentation

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

Definition at line 462 of file RTOpPack_Types.hpp.

template<class Scalar> RTOpPack::MutableSubMultiVectorT< Scalar >::MutableSubMultiVectorT (  RTOp_index_type  globalOffset, RTOp_index_type  subDim, RTOp_index_type  colOffset, RTOp_index_type  numSubCols, const Scalar *  values, RTOp_index_type  leadingDim )  [inline]

Definition at line 464 of file RTOpPack_Types.hpp.

template<class Scalar> RTOpPack::MutableSubMultiVectorT< Scalar >::MutableSubMultiVectorT (  const MutableSubMultiVectorT< Scalar > &  smv  )  [inline]

Definition at line 472 of file RTOpPack_Types.hpp.

---

Member Function Documentation

template<class Scalar> void RTOpPack::MutableSubMultiVectorT< Scalar >::initialize (  RTOp_index_type  globalOffset, RTOp_index_type  subDim, RTOp_index_type  colOffset, RTOp_index_type  numSubCols, const Scalar *  values, RTOp_index_type  leadingDim )  [inline]

Reimplemented from RTOpPack::SubMultiVectorT< Scalar >. Definition at line 476 of file RTOpPack_Types.hpp.

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

Reimplemented from RTOpPack::SubMultiVectorT< Scalar >. Definition at line 483 of file RTOpPack_Types.hpp.

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

Reimplemented from RTOpPack::SubMultiVectorT< Scalar >. Definition at line 486 of file RTOpPack_Types.hpp.

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

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

template<class Scalar> MutableSubVectorT<Scalar> RTOpPack::MutableSubMultiVectorT< Scalar >::col (  const RTOp_index_type  j  )  const [inline]

Return a MutableSubVectorT view of the jth sub-column (Preconditions: values()!=NULL && (1<=i<=subDim()) && (1<=j<= numSubCols()). Reimplemented from RTOpPack::SubMultiVectorT< Scalar >. Definition at line 491 of file RTOpPack_Types.hpp.

---

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

• RTOpPack_Types.hpp

---