RTOpPack::ConstSubVectorView< Scalar > Class Template Reference

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

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::ConstSubVectorView< Scalar >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 ConstSubVectorView ()
 
 ConstSubVectorView (const ArrayRCP< const Scalar > &values_in)
 
 ConstSubVectorView (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, const ArrayRCP< const Scalar > &values_in, ptrdiff_t stride_in)
 
 ConstSubVectorView (const ConstSubVectorView< Scalar > &sv)
 
void initialize (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, const ArrayRCP< const Scalar > &values_in, ptrdiff_t stride_in)
 
void uninitialize ()
 
void setGlobalOffset (Teuchos_Index globalOffset_in)
 
Teuchos_Index globalOffset () const
 
Teuchos_Index subDim () const
 
const ArrayRCP< const Scalar > values () const
 
ptrdiff_t stride () const
 
const Scalar & operator[] (Teuchos_Index i) const
 Zero-based indexing (Preconditions: values()!=NULL && (0 <= i < subDim())).
const Scalar & operator() (Teuchos_Index i) const
 Zero-based indexing (Preconditions: values()!=NULL && (0 <= i < subDim())).
 ConstSubVectorView (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, const Scalar values_in[], ptrdiff_t stride_in)
 Deprecated.
void initialize (Teuchos_Index globalOffset_in, Teuchos_Index subDim_in, const Scalar values_in[], ptrdiff_t stride_in)
 Deprecated.
void set_uninitialized ()
 Deprecated.

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &out, const ConstSubVectorView< Scalar > &sv)
 

Detailed Description

template<class Scalar>
class RTOpPack::ConstSubVectorView< Scalar >

Class for a non-changeable sub-vector.

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

   x( vec.globalOffset() + k ) = v(k), for k = 0...vec.subDim()-1

 

The stride vec.stride() may be positive (>0) or negative (<0) but not zero (0). A negative stride vec.stride() < 0 allows a reverse traversal of the elements.

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


Constructor & Destructor Documentation

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

Definition at line 128 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::ConstSubVectorView< Scalar >::ConstSubVectorView ( const ArrayRCP< const Scalar > &  values_in  )  [inline]

Definition at line 130 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::ConstSubVectorView< Scalar >::ConstSubVectorView ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
const ArrayRCP< const Scalar > &  values_in,
ptrdiff_t  stride_in 
) [inline]

Definition at line 134 of file RTOpPack_Types.hpp.

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

Definition at line 139 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::ConstSubVectorView< Scalar >::ConstSubVectorView ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
const Scalar  values_in[],
ptrdiff_t  stride_in 
) [inline]

Deprecated.

Definition at line 210 of file RTOpPack_Types.hpp.


Member Function Documentation

template<class Scalar>
void RTOpPack::ConstSubVectorView< Scalar >::initialize ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
const ArrayRCP< const Scalar > &  values_in,
ptrdiff_t  stride_in 
) [inline]

Definition at line 144 of file RTOpPack_Types.hpp.

template<class Scalar>
void RTOpPack::ConstSubVectorView< Scalar >::uninitialize (  )  [inline]

Definition at line 167 of file RTOpPack_Types.hpp.

template<class Scalar>
void RTOpPack::ConstSubVectorView< Scalar >::setGlobalOffset ( Teuchos_Index  globalOffset_in  )  [inline]

Definition at line 170 of file RTOpPack_Types.hpp.

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

Definition at line 178 of file RTOpPack_Types.hpp.

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

Definition at line 180 of file RTOpPack_Types.hpp.

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

Reimplemented in RTOpPack::SubVectorView< Scalar >.

Definition at line 182 of file RTOpPack_Types.hpp.

template<class Scalar>
ptrdiff_t RTOpPack::ConstSubVectorView< Scalar >::stride (  )  const [inline]

Definition at line 184 of file RTOpPack_Types.hpp.

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

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

Reimplemented in RTOpPack::SubVectorView< Scalar >.

Definition at line 187 of file RTOpPack_Types.hpp.

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

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

Reimplemented in RTOpPack::SubVectorView< Scalar >.

Definition at line 196 of file RTOpPack_Types.hpp.

template<class Scalar>
void RTOpPack::ConstSubVectorView< Scalar >::initialize ( Teuchos_Index  globalOffset_in,
Teuchos_Index  subDim_in,
const Scalar  values_in[],
ptrdiff_t  stride_in 
) [inline]

Deprecated.

Reimplemented in RTOpPack::SubVectorView< Scalar >.

Definition at line 216 of file RTOpPack_Types.hpp.

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

Deprecated.

Definition at line 225 of file RTOpPack_Types.hpp.


Friends And Related Function Documentation

template<class Scalar>
std::ostream & operator<< ( std::ostream &  out,
const ConstSubVectorView< Scalar > &  sv 
) [related]

Definition at line 314 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