Thyra Version of the Day
Public Member Functions
Thyra::DetachedVectorView< Scalar > Class Template Reference

Create an explicit mutable (non-const) view of a VectorBase object. More...

#include <Thyra_DetachedVectorView.hpp>

List of all members.

Public Member Functions

 DetachedVectorView (const Teuchos::RCP< VectorBase< Scalar > > &v, const Range1D &rng=Range1D(), const bool forceUnitStride=false)
 Construct an explicit mutable (non-const) view of a subset of elements.
 DetachedVectorView (VectorBase< Scalar > &v, const Range1D &rng=Range1D(), const bool forceUnitStride=false)
 Construct an explicit mutable (non-const) view of a subset of elements.
 ~DetachedVectorView ()
 Commits back the the explicit view on the VectorBase object v passed to DetachedVectorView().
const RTOpPack::SubVectorView
< Scalar > & 
sv () const
 Returns the explicit view as an RTOpPack::ConstSubVectorView<Scalar> object.
Teuchos_Ordinal globalOffset () const
 Returns the global offset for the explicit view.
Teuchos_Ordinal subDim () const
 Returns the dimension of the explicit view.
Scalar * values () const
 Return a pointer to a Scalar array containing the explicit view.
ptrdiff_t stride () const
 Return the stride between elements in the array returned from this->values().
Scalar & operator[] (Teuchos_Ordinal i) const
 Zero-based indexing: Preconditions: values()!=NULL && (0 <= i < subDim()-1).
Scalar & operator() (Teuchos_Ordinal i) const
 Zero-based indexing: Preconditions: values()!=NULL && (0 <= i < subDim()-1).

Detailed Description

template<class Scalar>
class Thyra::DetachedVectorView< Scalar >

Create an explicit mutable (non-const) view of a VectorBase object.

This utility class makes it easy to explicitly access a contiguous subset of elements in any VectorBase object and change the VectorBase object.

Warning! Creating an explicit view of an arbitrary VectorBase object may be a very expensive operation (such as with distributed-memory vectors) and should only be done in special cases (such as when the vector is an in-core vector). There several specialized use cases where creating these types of explicit views are necessary but in most cases this should not be done.

If one wants to only read the elements in a VectorBase object then one should use the utility class ConstDetachedVectorView.

The default constructor, copy constructor and assignment operators are not allowed.

Definition at line 254 of file Thyra_DetachedVectorView.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Thyra::DetachedVectorView< Scalar >::DetachedVectorView ( const Teuchos::RCP< VectorBase< Scalar > > &  v,
const Range1D rng = Range1D(),
const bool  forceUnitStride = false 
) [inline]

Construct an explicit mutable (non-const) view of a subset of elements.

Parameters:
v[in] The vector that a view will be taken. This object must be maintained until *this is destroyed. The elements in v are not guaranteed to be updated until *this is destroyed.
rng[in] the range of element indices that the explicit view will be taken.
forceUnitStride[in] If true then the view will have unit stride.

Preconditions:

  • [rng.full_range()==false] rng.ubound() < v.space()->dim()

Postconditions:

Definition at line 293 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Thyra::DetachedVectorView< Scalar >::DetachedVectorView ( VectorBase< Scalar > &  v,
const Range1D rng = Range1D(),
const bool  forceUnitStride = false 
) [inline]

Construct an explicit mutable (non-const) view of a subset of elements.

Parameters:
v[in] The vector that a view will be taken. This object must be maintained until *this is destroyed. The elements in v are not guaranteed to be updated until *this is destroyed.
rng[in] the range of element indices that the explicit view will be taken.
forceUnitStride[in] If true then the view will have unit stride.

Preconditions:

  • [rng.full_range()==false] rng.ubound() < v.space()->dim()

Postconditions:

Definition at line 334 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Thyra::DetachedVectorView< Scalar >::~DetachedVectorView ( ) [inline]

Commits back the the explicit view on the VectorBase object v passed to DetachedVectorView().

Definition at line 342 of file Thyra_DetachedVectorView.hpp.


Member Function Documentation

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

Returns the explicit view as an RTOpPack::ConstSubVectorView<Scalar> object.

Definition at line 363 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Teuchos_Ordinal Thyra::DetachedVectorView< Scalar >::globalOffset ( ) const [inline]

Returns the global offset for the explicit view.

Definition at line 366 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Teuchos_Ordinal Thyra::DetachedVectorView< Scalar >::subDim ( ) const [inline]

Returns the dimension of the explicit view.

Definition at line 369 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Scalar* Thyra::DetachedVectorView< Scalar >::values ( ) const [inline]

Return a pointer to a Scalar array containing the explicit view.

Definition at line 374 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
ptrdiff_t Thyra::DetachedVectorView< Scalar >::stride ( ) const [inline]

Return the stride between elements in the array returned from this->values().

Definition at line 379 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Scalar& Thyra::DetachedVectorView< Scalar >::operator[] ( Teuchos_Ordinal  i) const [inline]

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

Definition at line 384 of file Thyra_DetachedVectorView.hpp.

template<class Scalar>
Scalar& Thyra::DetachedVectorView< Scalar >::operator() ( Teuchos_Ordinal  i) const [inline]

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

Definition at line 388 of file Thyra_DetachedVectorView.hpp.


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