ERC CISST - cisst software

---

vctDynamicNArrayRefOwner< _elementType, _dimension > Class Template Reference

#include <vctDynamicNArrayRefOwner.h>

Collaboration diagram for vctDynamicNArrayRefOwner< _elementType, _dimension >:

[legend]List of all members.

---

Detailed Description

template<class _elementType, vct::size_type _dimension>
class vctDynamicNArrayRefOwner< _elementType, _dimension >

This templated class owns a dynamically allocated array, but does not provide any other operations

Definition at line 37 of file vctDynamicNArrayRefOwner.h.

Public Types

• enum
• typedef vctDynamicNArrayRefOwner<
  _elementType, DIMENSION > ThisType
• typedef vctVarStrideNArrayIterator<
  ThisType, true > iterator
• typedef vctVarStrideNArrayConstIterator<
  ThisType, true > const_iterator
• typedef vctVarStrideNArrayIterator<
  ThisType, false > reverse_iterator
• typedef vctVarStrideNArrayConstIterator<
  ThisType, false > const_reverse_iterator

Public Member Functions

• VCT_NARRAY_TRAITS_TYPEDEFS (DIMENSION)
• vctDynamicNArrayRefOwner ()
• vctDynamicNArrayRefOwner (pointer data, const nsize_type &sizes, const nstride_type &strides)
• void SetRef (pointer data, const nsize_type &sizes, const nstride_type &strides)
• dimension_type dimension (void) const
• const nsize_type & sizes (void) const
• size_type size (dimension_type dimension) const
• size_type size (void) const
• const nstride_type & strides (void) const
• difference_type stride (dimension_type dimension) const
• pointer Pointer (void)
• pointer Pointer (const nindex_type &indices)
• const_pointer Pointer (void) const
• const_pointer Pointer (const nsize_type &indices) const
• iterator begin (void)
• iterator end (void)
• const_iterator begin (void) const
• const_iterator end (void) const
• reverse_iterator rbegin (void)
• reverse_iterator rend (void)
• const_reverse_iterator rbegin (void) const
• const_reverse_iterator rend (void) const
• bool IsCompact (void) const

Public Attributes

• _elementType

Protected Member Functions

• void UpdateCachedData (void)

Protected Attributes

• nsize_type SizesMember
• nstride_type StridesMember
• pointer Data
• bool IsCompactMember

---

Member Typedef Documentation

template<class _elementType, vct::size_type _dimension>

typedef vctDynamicNArrayRefOwner<_elementType, DIMENSION> vctDynamicNArrayRefOwner< _elementType, _dimension >::ThisType

The type of this owner.

Definition at line 46 of file vctDynamicNArrayRefOwner.h.

---

Member Function Documentation

template<class _elementType, vct::size_type _dimension>

dimension_type vctDynamicNArrayRefOwner< _elementType, _dimension >::dimension

(

void

)

const [inline]

Return the number of dimensions of the nArray.

Returns:

the number of dimensions of this nArray

Definition at line 80 of file vctDynamicNArrayRefOwner.h.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::dimension(), and vctDynamicNArrayRefOwner< _elementType, _dimension >::UpdateCachedData().

template<class _elementType, vct::size_type _dimension>

const nsize_type& vctDynamicNArrayRefOwner< _elementType, _dimension >::sizes

(

void

)

const [inline]

Return the size of each dimension.

Returns:

a vector containing the size of the nArray in each dimension

Definition at line 87 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::SizesMember.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::sizes(), and vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::ValidIndex().

template<class _elementType, vct::size_type _dimension>

size_type vctDynamicNArrayRefOwner< _elementType, _dimension >::size

(

dimension_type

dimension

)

const [inline]

Return the size of a dimension.

Parameters:

dimension

the dimension of interest

Returns:

the size of the nArray in the given dimension

Note:

the dimension is zero-based

Definition at line 98 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::SizesMember.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::size().

template<class _elementType, vct::size_type _dimension>

size_type vctDynamicNArrayRefOwner< _elementType, _dimension >::size

(

void

)

const [inline]

Return the size of the nArray.

Returns:

the number of elements

Note:

This method returns 0 if the dimension of the nArray is zero.

Definition at line 112 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::SizesMember.

Referenced by vctDynamicNArrayRefOwner< _elementType, _dimension >::end(), and vctDynamicNArrayRefOwner< _elementType, _dimension >::rbegin().

template<class _elementType, vct::size_type _dimension>

const nstride_type& vctDynamicNArrayRefOwner< _elementType, _dimension >::strides

(

void

)

const [inline]

Return the strides of each dimension.

Returns:

a vector containing the strides of the nArray in each dimension

Definition at line 122 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::StridesMember.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::strides().

template<class _elementType, vct::size_type _dimension>

difference_type vctDynamicNArrayRefOwner< _elementType, _dimension >::stride

(

dimension_type

dimension

)

const [inline]

Return the stride of a dimension.

Parameters:

dimension

the dimension of interest

Returns:

the stride of the nArray in the given dimension

Definition at line 130 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::StridesMember.

Referenced by vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::stride().

template<class _elementType, vct::size_type _dimension>

pointer vctDynamicNArrayRefOwner< _elementType, _dimension >::Pointer

(

void

)

[inline]

Return a pointer to the nArray's data.

Returns:

a pointer to this nArray's data

Definition at line 140 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::Data.

Referenced by vctDynamicNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Pointer(), and vctDynamicConstNArrayBase< vctDynamicNArrayRefOwner< _elementType, _dimension >, _elementType, _dimension >::Pointer().

template<class _elementType, vct::size_type _dimension>

pointer vctDynamicNArrayRefOwner< _elementType, _dimension >::Pointer

(

const nindex_type &

indices

)

[inline]

Return a pointer to the nArray's data at the specified element.

Returns:

a pointer to this nArray's data at the specified element

Definition at line 147 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::Data, and vctDynamicNArrayRefOwner< _elementType, _dimension >::StridesMember.

template<class _elementType, vct::size_type _dimension>

const_pointer vctDynamicNArrayRefOwner< _elementType, _dimension >::Pointer

(

void

)

const [inline]

Return a const pointer to the nArray's data.

Returns:

a const pointer to this nArray's data

Definition at line 156 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::Data.

template<class _elementType, vct::size_type _dimension>

const_pointer vctDynamicNArrayRefOwner< _elementType, _dimension >::Pointer

(

const nsize_type &

indices

)

const [inline]

Return a const pointer to the nArray's data at the specified element.

Returns:

a const pointer to this nArray's data at the specified element

Definition at line 163 of file vctDynamicNArrayRefOwner.h.

References vctDynamicNArrayRefOwner< _elementType, _dimension >::Data, and vctDynamicNArrayRefOwner< _elementType, _dimension >::StridesMember.

---

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

• vctDynamicNArrayRefOwner.h

---