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

#include <RTOpPack_Types.hpp>

Inheritance diagram for RTOpPack::SubVectorView< Scalar >:

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())`). More...

Scalar &	operator() (Ordinal i) const
	Zero-based indexing (Preconditions: `values()!=NULL && (0 <= i < subDim())`). More...

Public Member Functions inherited from RTOpPack::ConstSubVectorView< Scalar >
	ConstSubVectorView ()

	ConstSubVectorView (const ArrayRCP< const Scalar > &values_in)

	ConstSubVectorView (Ordinal globalOffset_in, Ordinal subDim_in, const ArrayRCP< const Scalar > &values_in, ptrdiff_t stride_in)

	ConstSubVectorView (const ConstSubVectorView< Scalar > &sv)

void	initialize (Ordinal globalOffset_in, Ordinal subDim_in, const ArrayRCP< const Scalar > &values_in, ptrdiff_t stride_in)

void	uninitialize ()

void	setGlobalOffset (Ordinal globalOffset_in)

Ordinal	globalOffset () const

Ordinal	subDim () const

const ArrayRCP< const Scalar >	values () const

ptrdiff_t	stride () const

const Scalar &	operator[] (Ordinal i) const
	Zero-based indexing (Preconditions: `values()!=NULL && (0 <= i < subDim())`). More...

const Scalar &	operator() (Ordinal i) const
	Zero-based indexing (Preconditions: `values()!=NULL && (0 <= i < subDim())`). More...

Additional Inherited Members
Related Functions inherited from RTOpPack::ConstSubVectorView< Scalar >
template<class Scalar >
std::ostream &	operator<< (std::ostream &out, const ConstSubVectorView< Scalar > &sv)

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

Constructor & Destructor Documentation

template<class Scalar>

RTOpPack::SubVectorView< Scalar >::SubVectorView ( )

inline

Definition at line 250 of file RTOpPack_Types.hpp.

template<class Scalar>

RTOpPack::SubVectorView< Scalar >::SubVectorView ( const ArrayRCP< Scalar > & values_in )

inline

Definition at line 252 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 256 of file RTOpPack_Types.hpp.

template<class Scalar>

RTOpPack::SubVectorView< Scalar >::SubVectorView ( Ordinal subDim_in )

inline

Definition at line 261 of file RTOpPack_Types.hpp.

template<class Scalar>

RTOpPack::SubVectorView< Scalar >::SubVectorView ( const SubVectorView< Scalar > & sv )

inline

Definition at line 265 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 269 of file RTOpPack_Types.hpp.

template<class Scalar>

const ArrayRCP<Scalar> RTOpPack::SubVectorView< Scalar >::values ( ) const

inline

Definition at line 273 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())).

Definition at line 277 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())).

Definition at line 281 of file RTOpPack_Types.hpp.

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

RTOpPack_Types.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Scalar> class RTOpPack::SubVectorView< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

template<class Scalar>
class RTOpPack::SubVectorView< Scalar >