RTOpPack::SubMultiVectorView< Scalar > Class Template Reference

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

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::SubMultiVectorView< Scalar >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 SubMultiVectorView ()
 
 SubMultiVectorView (Teuchos_Index numRows_in, Teuchos_Index numCols_in)
 
 SubMultiVectorView (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, Teuchos_Index colOffset_in, Teuchos_Index numSubCols_in, const ArrayRCP< Scalar > &values_in, Teuchos_Index leadingDim_in)
 
 SubMultiVectorView (const SubMultiVectorView< Scalar > &smv)
 
void initialize (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, Teuchos_Index colOffset_in, Teuchos_Index numSubCols_in, const ArrayRCP< Scalar > &values_in, Teuchos_Index leadingDim_in)
 
const ArrayRCP< 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()).
 SubMultiVectorView (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, Teuchos_Index colOffset_in, Teuchos_Index numSubCols_in, Scalar values_in[], Teuchos_Index leadingDim_in)
 Deprecated.
void initialize (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, Teuchos_Index colOffset_in, Teuchos_Index numSubCols_in, Scalar values_in[], Teuchos_Index leadingDim_in)
 Deprecated.

Detailed Description

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

Class for a changeable sub-vector.

This class derives from ConstSubVectorView and adds methods to change 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!

NOTE: It is perfectly safe to derive this class from ConstSubMultiVectorView even through it does not have a virtual destructor. That is because this derived class has no data members that would cause problems in slicing or memory leaks when deleting.

Definition at line 510 of file RTOpPack_Types.hpp.


Constructor & Destructor Documentation

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

Definition at line 513 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView ( Teuchos_Index  numRows_in,
Teuchos_Index  numCols_in 
) [inline]

Definition at line 515 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
Teuchos_Index  colOffset_in,
Teuchos_Index  numSubCols_in,
const ArrayRCP< Scalar > &  values_in,
Teuchos_Index  leadingDim_in 
) [inline]

Definition at line 522 of file RTOpPack_Types.hpp.

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

Definition at line 531 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
Teuchos_Index  colOffset_in,
Teuchos_Index  numSubCols_in,
Scalar  values_in[],
Teuchos_Index  leadingDim_in 
) [inline]

Deprecated.

Definition at line 568 of file RTOpPack_Types.hpp.


Member Function Documentation

template<class Scalar>
void RTOpPack::SubMultiVectorView< Scalar >::initialize ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
Teuchos_Index  colOffset_in,
Teuchos_Index  numSubCols_in,
const ArrayRCP< Scalar > &  values_in,
Teuchos_Index  leadingDim_in 
) [inline]

Definition at line 535 of file RTOpPack_Types.hpp.

template<class Scalar>
const ArrayRCP<Scalar> RTOpPack::SubMultiVectorView< Scalar >::values (  )  const [inline]

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 545 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 553 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 558 of file RTOpPack_Types.hpp.

template<class Scalar>
void RTOpPack::SubMultiVectorView< Scalar >::initialize ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
Teuchos_Index  colOffset_in,
Teuchos_Index  numSubCols_in,
Scalar  values_in[],
Teuchos_Index  leadingDim_in 
) [inline]

Deprecated.

Reimplemented from RTOpPack::ConstSubMultiVectorView< Scalar >.

Definition at line 577 of file RTOpPack_Types.hpp.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:25:48 2010 for Fundamental Vector Reduction/Transformation Operator (RTOp) Interfaces by  doxygen 1.4.7