RTOpPack::SubMultiVectorView< Scalar > Class Template Reference

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

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::SubMultiVectorView< Scalar >:

[legend]List of all members.

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

---

Detailed Description

template<class Scalar>
class RTOpPack::SubMultiVectorView< Scalar >

Class for a mutable sub-vector.

This class derives from ConstSubVectorView and adds methods to mutate the data. Note, a const SubVectorView 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 487 of file RTOpPack_Types.hpp.

---

Constructor & Destructor Documentation

template<class Scalar>

RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView

(

)

[inline]

Definition at line 490 of file RTOpPack_Types.hpp.

template<class Scalar>

RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView	(	Teuchos_Index	globalOffset,
		Teuchos_Index	subDim,
		Teuchos_Index	colOffset,
		Teuchos_Index	numSubCols,
		const Scalar *	values,
		Teuchos_Index	leadingDim
	)			[inline]

Definition at line 492 of file RTOpPack_Types.hpp.

template<class Scalar>

RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView

(

const SubMultiVectorView< Scalar > &

smv

)

[inline]

Definition at line 500 of file RTOpPack_Types.hpp.

---

Member Function Documentation

template<class Scalar>

void RTOpPack::SubMultiVectorView< Scalar >::initialize	(	Teuchos_Index	globalOffset,
		Teuchos_Index	subDim,
		Teuchos_Index	colOffset,
		Teuchos_Index	numSubCols,
		const Scalar *	values,
		Teuchos_Index	leadingDim
	)			[inline]

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 504 of file RTOpPack_Types.hpp.

template<class Scalar>

void RTOpPack::SubMultiVectorView< Scalar >::set_uninitialized

(

)

[inline]

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 511 of file RTOpPack_Types.hpp.

template<class Scalar>

Scalar* RTOpPack::SubMultiVectorView< Scalar >::values

(

)

const [inline]

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 514 of file RTOpPack_Types.hpp.

template<class Scalar>

Scalar& RTOpPack::SubMultiVectorView< Scalar >::operator()	(	Teuchos_Index	i,
		Teuchos_Index	j
	)			const [inline]

Zero-based indexing (Preconditions: values()!=NULL && (0<=i< subDim()) && (0<=j<numSubCols()).

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 516 of file RTOpPack_Types.hpp.

template<class Scalar>

SubVectorView<Scalar> RTOpPack::SubMultiVectorView< Scalar >::col

(

const Teuchos_Index

j

)

const [inline]

Return a SubVectorView view of the jth sub-column (Preconditions: values()!=NULL && && (0<=j<numSubCols()).

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 519 of file RTOpPack_Types.hpp.

---

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

• RTOpPack_Types.hpp

---