Fundamental Vector Reduction/Transformation Operator (RTOp) Interfaces  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
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]

Public Member Functions

 SubMultiVectorView ()
 
 SubMultiVectorView (Ordinal numRows_in, Ordinal numCols_in)
 
 SubMultiVectorView (Ordinal globalOffset_in, Ordinal subDim_in, Ordinal colOffset_in, Ordinal numSubCols_in, const ArrayRCP< Scalar > &values_in, Ordinal leadingDim_in)
 
 SubMultiVectorView (const SubMultiVectorView< Scalar > &smv)
 
void initialize (Ordinal globalOffset_in, Ordinal subDim_in, Ordinal colOffset_in, Ordinal numSubCols_in, const ArrayRCP< Scalar > &values_in, Ordinal leadingDim_in)
 
const ArrayRCP< Scalar > values () const
 
Scalar & operator() (Ordinal i, Ordinal j) const
 Zero-based indexing (Preconditions: values()!=NULL && (0<=i< subDim()) && (0<=j<numSubCols()). More...
 
SubVectorView< Scalar > col (const Ordinal j) const
 Return a SubVectorView view of the jth sub-column (Preconditions: values()!=NULL && && (0<=j<numSubCols()). More...
 
- Public Member Functions inherited from RTOpPack::ConstSubMultiVectorView< Scalar >
 ConstSubMultiVectorView ()
 
 ConstSubMultiVectorView (Ordinal globalOffset_in, Ordinal subDim_in, Ordinal colOffset_in, Ordinal numSubCols_in, const ArrayRCP< const Scalar > &values_in, Ordinal leadingDim_in)
 
 ConstSubMultiVectorView (const ConstSubMultiVectorView< Scalar > &smv)
 
void initialize (Ordinal globalOffset_in, Ordinal subDim_in, Ordinal colOffset_in, Ordinal numSubCols_in, const ArrayRCP< const Scalar > &values_in, Ordinal leadingDim_in)
 
void uninitialize ()
 
void setGlobalOffset (Ordinal globalOffset_in)
 
Ordinal globalOffset () const
 
Ordinal subDim () const
 
Ordinal colOffset () const
 
Ordinal numSubCols () const
 
const ArrayRCP< const Scalar > values () const
 
Ordinal leadingDim () const
 
const Scalar & operator() (Ordinal i, Ordinal j) const
 Zero-based indexing (Preconditions: values()!=NULL && (0<=i<subDim()) && (0<=j< numSubCols()). More...
 
ConstSubVectorView< Scalar > col (const Ordinal j) const
 Return a ConstSubVectorView view of the jth sub-column (Preconditions: values()!=NULL && (0<=j<numSubCols()). More...
 

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

Constructor & Destructor Documentation

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

Definition at line 476 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::SubMultiVectorView< Scalar >::SubMultiVectorView ( Ordinal  numRows_in,
Ordinal  numCols_in 
)
inline

Definition at line 478 of file RTOpPack_Types.hpp.

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

Definition at line 485 of file RTOpPack_Types.hpp.

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

Definition at line 494 of file RTOpPack_Types.hpp.

Member Function Documentation

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

Definition at line 498 of file RTOpPack_Types.hpp.

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

Definition at line 508 of file RTOpPack_Types.hpp.

template<class Scalar>
Scalar& RTOpPack::SubMultiVectorView< Scalar >::operator() ( Ordinal  i,
Ordinal  j 
) const
inline

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

Definition at line 516 of file RTOpPack_Types.hpp.

template<class Scalar>
SubVectorView<Scalar> RTOpPack::SubMultiVectorView< Scalar >::col ( const Ordinal  j) const
inline

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

Definition at line 521 of file RTOpPack_Types.hpp.


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