RTOpPack::ConstSubMultiVectorView< Scalar > Class Template Reference

Class for a non-mutable sub-multi-vector (submatrix). More...

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::ConstSubMultiVectorView< Scalar >:

[legend]
List of all members.

Public Member Functions

 ConstSubMultiVectorView ()
 
 ConstSubMultiVectorView (Teuchos_Index globalOffset, Teuchos_Index subDim, Teuchos_Index colOffset, Teuchos_Index numSubCols, const Scalar *values, Teuchos_Index leadingDim)
 
 ConstSubMultiVectorView (const ConstSubMultiVectorView< 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 ()
 
void setGlobalOffset (Teuchos_Index globalOffset)
 
Teuchos_Index globalOffset () const
 
Teuchos_Index subDim () const
 
Teuchos_Index colOffset () const
 
Teuchos_Index numSubCols () const
 
const Scalar * values () const
 
Teuchos_Index leadingDim () const
 
const Scalar & operator() (Teuchos_Index i, Teuchos_Index j) const
 Zero-based indexing (Preconditions: values()!=NULL && (0<=i<subDim()) && (0<=j< numSubCols()).
ConstSubVectorView< Scalar > col (const Teuchos_Index j) const
 Return a ConstSubVectorView view of the jth sub-column (Preconditions: values()!=NULL && (0<=j<numSubCols()).

Private Attributes

Teuchos_Index globalOffset_
Teuchos_Index subDim_
Teuchos_Index colOffset_
Teuchos_Index numSubCols_
const Scalar * values_
Teuchos_Index leadingDim_

Detailed Description

template<class Scalar>
class RTOpPack::ConstSubMultiVectorView< Scalar >

Class for a non-mutable sub-multi-vector (submatrix).

For a sub-multi-vector mv, the corresponding entries in the global multi-vector X(j) (one based) are as follows:


  X(mv.globalOffset()+k1,mv.colOffset()+k2) = mv(k1,k2), for k1=0...mv.subDim()-1, k2=0...mv.numSubCols()-1
 
Unlike vectors, there can only be a unit stride between vector elements in a particular column and there is a Fortran-like leading dimension mv.leadingDim() that separates corresponding elements in each column sub-vector.

The raw pointer to the first element, in the first column can be obtained from the function mv.values().

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 391 of file RTOpPack_Types.hpp.


Constructor & Destructor Documentation

template<class Scalar>
RTOpPack::ConstSubMultiVectorView< Scalar >::ConstSubMultiVectorView  )  [inline]
 

Definition at line 394 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::ConstSubMultiVectorView< Scalar >::ConstSubMultiVectorView Teuchos_Index  globalOffset,
Teuchos_Index  subDim,
Teuchos_Index  colOffset,
Teuchos_Index  numSubCols,
const Scalar *  values,
Teuchos_Index  leadingDim
[inline]
 

Definition at line 399 of file RTOpPack_Types.hpp.

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

Definition at line 409 of file RTOpPack_Types.hpp.


Member Function Documentation

template<class Scalar>
void RTOpPack::ConstSubMultiVectorView< Scalar >::initialize Teuchos_Index  globalOffset,
Teuchos_Index  subDim,
Teuchos_Index  colOffset,
Teuchos_Index  numSubCols,
const Scalar *  values,
Teuchos_Index  leadingDim
[inline]
 

Reimplemented in RTOpPack::SubMultiVectorView< Scalar >.

Definition at line 415 of file RTOpPack_Types.hpp.

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

Reimplemented in RTOpPack::SubMultiVectorView< Scalar >.

Definition at line 423 of file RTOpPack_Types.hpp.

template<class Scalar>
void RTOpPack::ConstSubMultiVectorView< Scalar >::setGlobalOffset Teuchos_Index  globalOffset  )  [inline]
 

Definition at line 426 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::globalOffset  )  const [inline]
 

Definition at line 428 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::subDim  )  const [inline]
 

Definition at line 430 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::colOffset  )  const [inline]
 

Definition at line 432 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::numSubCols  )  const [inline]
 

Definition at line 434 of file RTOpPack_Types.hpp.

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

Reimplemented in RTOpPack::SubMultiVectorView< Scalar >.

Definition at line 436 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::leadingDim  )  const [inline]
 

Definition at line 438 of file RTOpPack_Types.hpp.

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

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

Reimplemented in RTOpPack::SubMultiVectorView< Scalar >.

Definition at line 440 of file RTOpPack_Types.hpp.

template<class Scalar>
ConstSubVectorView<Scalar> RTOpPack::ConstSubMultiVectorView< Scalar >::col const Teuchos_Index  j  )  const [inline]
 

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

Reimplemented in RTOpPack::SubMultiVectorView< Scalar >.

Definition at line 455 of file RTOpPack_Types.hpp.


Member Data Documentation

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::globalOffset_ [private]
 

Definition at line 466 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::subDim_ [private]
 

Definition at line 467 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::colOffset_ [private]
 

Definition at line 468 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::numSubCols_ [private]
 

Definition at line 469 of file RTOpPack_Types.hpp.

template<class Scalar>
const Scalar* RTOpPack::ConstSubMultiVectorView< Scalar >::values_ [private]
 

Definition at line 470 of file RTOpPack_Types.hpp.

template<class Scalar>
Teuchos_Index RTOpPack::ConstSubMultiVectorView< Scalar >::leadingDim_ [private]
 

Definition at line 471 of file RTOpPack_Types.hpp.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:30:43 2008 for RTOp Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1