#include <vctDynamicNArrayRefOwner.h>

Public Types
enum	{ DIMENSION = _dimension }
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_CONTAINER_TRAITS_TYPEDEFS (_elementType)
	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

Protected Member Functions
void	UpdateCachedData (void)

Protected Attributes
nsize_type	SizesMember
nstride_type	StridesMember
pointer	Data
bool	IsCompactMember

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

Member Typedef Documentation

◆ const_iterator

template<class _elementType, vct::size_type _dimension>

typedef vctVarStrideNArrayConstIterator<ThisType, true> vctDynamicNArrayRefOwner< _elementType, _dimension >::const_iterator

◆ const_reverse_iterator

template<class _elementType, vct::size_type _dimension>

typedef vctVarStrideNArrayConstIterator<ThisType, false> vctDynamicNArrayRefOwner< _elementType, _dimension >::const_reverse_iterator

◆ iterator

template<class _elementType, vct::size_type _dimension>

typedef vctVarStrideNArrayIterator<ThisType, true> vctDynamicNArrayRefOwner< _elementType, _dimension >::iterator

◆ reverse_iterator

template<class _elementType, vct::size_type _dimension>

typedef vctVarStrideNArrayIterator<ThisType, false> vctDynamicNArrayRefOwner< _elementType, _dimension >::reverse_iterator

◆ ThisType

template<class _elementType, vct::size_type _dimension>

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

The type of this owner.

Member Enumeration Documentation

◆ anonymous enum

template<class _elementType, vct::size_type _dimension>

anonymous enum

Enumerator
DIMENSION

Constructor & Destructor Documentation

◆ vctDynamicNArrayRefOwner() [1/2]

template<class _elementType, vct::size_type _dimension>

vctDynamicNArrayRefOwner< _elementType, _dimension >::vctDynamicNArrayRefOwner ( )

inline

◆ vctDynamicNArrayRefOwner() [2/2]

template<class _elementType, vct::size_type _dimension>

vctDynamicNArrayRefOwner< _elementType, _dimension >::vctDynamicNArrayRefOwner	(	pointer	data,
		const nsize_type &	sizes,
		const nstride_type &	strides )

inline

Member Function Documentation

◆ begin() [1/2]

template<class _elementType, vct::size_type _dimension>

iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::begin ( void )

inline

◆ begin() [2/2]

template<class _elementType, vct::size_type _dimension>

const_iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::begin ( void ) const

inline

◆ dimension()

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

◆ end() [1/2]

template<class _elementType, vct::size_type _dimension>

iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::end ( void )

inline

◆ end() [2/2]

template<class _elementType, vct::size_type _dimension>

const_iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::end ( void ) const

inline

◆ IsCompact()

template<class _elementType, vct::size_type _dimension>

bool vctDynamicNArrayRefOwner< _elementType, _dimension >::IsCompact ( void ) const

inline

◆ Pointer() [1/4]

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

◆ Pointer() [2/4]

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

◆ Pointer() [3/4]

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

◆ Pointer() [4/4]

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

◆ rbegin() [1/2]

template<class _elementType, vct::size_type _dimension>

reverse_iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::rbegin ( void )

inline

◆ rbegin() [2/2]

template<class _elementType, vct::size_type _dimension>

const_reverse_iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::rbegin ( void ) const

inline

◆ rend() [1/2]

template<class _elementType, vct::size_type _dimension>

reverse_iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::rend ( void )

inline

◆ rend() [2/2]

template<class _elementType, vct::size_type _dimension>

const_reverse_iterator vctDynamicNArrayRefOwner< _elementType, _dimension >::rend ( void ) const

inline

◆ SetRef()

template<class _elementType, vct::size_type _dimension>

void vctDynamicNArrayRefOwner< _elementType, _dimension >::SetRef	(	pointer	data,
		const nsize_type &	sizes,
		const nstride_type &	strides )

inline

◆ size() [1/2]

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

◆ size() [2/2]

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.

◆ sizes()

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

◆ stride()

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

◆ strides()

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

◆ UpdateCachedData()

template<class _elementType, vct::size_type _dimension>

void vctDynamicNArrayRefOwner< _elementType, _dimension >::UpdateCachedData ( void )

inlineprotected

◆ VCT_CONTAINER_TRAITS_TYPEDEFS()

template<class _elementType, vct::size_type _dimension>

vctDynamicNArrayRefOwner< _elementType, _dimension >::VCT_CONTAINER_TRAITS_TYPEDEFS ( _elementType )

◆ VCT_NARRAY_TRAITS_TYPEDEFS()

template<class _elementType, vct::size_type _dimension>

vctDynamicNArrayRefOwner< _elementType, _dimension >::VCT_NARRAY_TRAITS_TYPEDEFS ( DIMENSION )

Member Data Documentation

◆ Data

template<class _elementType, vct::size_type _dimension>

pointer vctDynamicNArrayRefOwner< _elementType, _dimension >::Data

protected

◆ IsCompactMember

template<class _elementType, vct::size_type _dimension>

bool vctDynamicNArrayRefOwner< _elementType, _dimension >::IsCompactMember

protected

◆ SizesMember

template<class _elementType, vct::size_type _dimension>

nsize_type vctDynamicNArrayRefOwner< _elementType, _dimension >::SizesMember

protected

◆ StridesMember

template<class _elementType, vct::size_type _dimension>

nstride_type vctDynamicNArrayRefOwner< _elementType, _dimension >::StridesMember

protected

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

tmp/cisst-saw/cisst/cisstVector/vctDynamicNArrayRefOwner.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ const_iterator

◆ const_reverse_iterator

◆ iterator

◆ reverse_iterator

◆ ThisType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vctDynamicNArrayRefOwner() [1/2]

◆ vctDynamicNArrayRefOwner() [2/2]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ dimension()

◆ end() [1/2]

◆ end() [2/2]

◆ IsCompact()

◆ Pointer() [1/4]

◆ Pointer() [2/4]

◆ Pointer() [3/4]

◆ Pointer() [4/4]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ SetRef()

◆ size() [1/2]

◆ size() [2/2]

◆ sizes()

◆ stride()

◆ strides()

◆ UpdateCachedData()

◆ VCT_CONTAINER_TRAITS_TYPEDEFS()

◆ VCT_NARRAY_TRAITS_TYPEDEFS()

Member Data Documentation

◆ Data

◆ IsCompactMember

◆ SizesMember

◆ StridesMember