RTOp Package Browser (Single Doxygen Collection) Version of the Day
Public Member Functions
RTOpPack::SubVectorView< Scalar > Class Template Reference

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

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::SubVectorView< Scalar >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SubVectorView ()
 
 SubVectorView (const ArrayRCP< Scalar > &values_in)
 
 SubVectorView (Ordinal globalOffset_in, Ordinal subDim_in, const ArrayRCP< Scalar > &values_in, ptrdiff_t stride_in)
 
 SubVectorView (Ordinal subDim_in)
 
 SubVectorView (const SubVectorView< Scalar > &sv)
 
void initialize (Ordinal globalOffset_in, Ordinal subDim_in, const ArrayRCP< Scalar > &values_in, ptrdiff_t stride_in)
 
const ArrayRCP< Scalar > values () const
 
Scalar & operator[] (Ordinal i) const
 Zero-based indexing (Preconditions: values()!=NULL && (0 <= i < subDim())).
Scalar & operator() (Ordinal i) const
 Zero-based indexing (Preconditions: values()!=NULL && (0 <= i < subDim())).
RTOP_DEPRECATED SubVectorView (Ordinal globalOffset_in, Ordinal subDim_in, Scalar values_in[], ptrdiff_t stride_in)
 Deprecated.
RTOP_DEPRECATED void initialize (Ordinal globalOffset_in, Ordinal subDim_in, Scalar values_in[], ptrdiff_t stride_in)
 Deprecated.

Detailed Description

template<class Scalar>
class RTOpPack::SubVectorView< 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. This means this class has shallow copy semantics. You have been warned!

NOTE: It is perfectly safe to derive this class from ConstSubVectorView 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 265 of file RTOpPack_Types.hpp.


Constructor & Destructor Documentation

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

Definition at line 268 of file RTOpPack_Types.hpp.

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

Definition at line 270 of file RTOpPack_Types.hpp.

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

Definition at line 274 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOpPack::SubVectorView< Scalar >::SubVectorView ( Ordinal  subDim_in) [inline]

Definition at line 279 of file RTOpPack_Types.hpp.

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

Definition at line 283 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOP_DEPRECATED RTOpPack::SubVectorView< Scalar >::SubVectorView ( Ordinal  globalOffset_in,
Ordinal  subDim_in,
Scalar  values_in[],
ptrdiff_t  stride_in 
) [inline]

Deprecated.

Definition at line 302 of file RTOpPack_Types.hpp.


Member Function Documentation

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

Definition at line 287 of file RTOpPack_Types.hpp.

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

Reimplemented from RTOpPack::ConstSubVectorView< Scalar >.

Definition at line 291 of file RTOpPack_Types.hpp.

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

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

Reimplemented from RTOpPack::ConstSubVectorView< Scalar >.

Definition at line 295 of file RTOpPack_Types.hpp.

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

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

Reimplemented from RTOpPack::ConstSubVectorView< Scalar >.

Definition at line 299 of file RTOpPack_Types.hpp.

template<class Scalar>
RTOP_DEPRECATED void RTOpPack::SubVectorView< Scalar >::initialize ( Ordinal  globalOffset_in,
Ordinal  subDim_in,
Scalar  values_in[],
ptrdiff_t  stride_in 
) [inline]

Deprecated.

Reimplemented from RTOpPack::ConstSubVectorView< Scalar >.

Definition at line 307 of file RTOpPack_Types.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines