cisst-saw
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
vctDynamicNArrayLoopEngines< _dimension > Class Template Reference

Container class for the dynamic nArray engines. More...

#include <vctDynamicNArrayLoopEngines.h>

Classes

class  SoNi
class  SoNiNi
class  SoNiSi
class  NoNiNi
class  NoNiSi
class  NoSiNi
class  NioSi
class  NioNi
class  NoNi
class  Nio
class  NioSiNi
class  NioNiNi
class  MinAndMax

Public Types

typedef vct::size_type size_type
typedef vct::stride_type stride_type
typedef vct::difference_type difference_type
typedef vct::index_type index_type

Public Member Functions

 VCT_NARRAY_TRAITS_TYPEDEFS (_dimension)

Static Public Member Functions

static void ThrowSizeMismatchException (void) CISST_THROW(std
static void CalculateSTND (nstride_type &stnd, const nsize_type &sizes, const nstride_type &strides)
static void CalculateOTND (nstride_type &otnd, const nstride_type &strides, const nstride_type &stnd)
template<class _elementType>
static void InitializeTargets (vctFixedSizeVector< const _elementType *, _dimension > &targets, const nsize_type &sizes, const nstride_type &strides, const _elementType *basePtr)
template<class _elementType>
static void SyncCurrentPointer (const _elementType *&currentPointer, const nstride_type &otnd, difference_type numberOfWrappedDimensions)
template<class _elementType, class _pointerType>
static dimension_type IncrementPointers (vctFixedSizeVector< const _elementType *, _dimension > &targets, _pointerType &currentPointer, const nstride_type &strides, const nstride_type &stnd)

Detailed Description

template<vct::size_type _dimension>
class vctDynamicNArrayLoopEngines< _dimension >

Container class for the dynamic nArray engines.

See also
SoNi SoNiNi SoNiSi NoNiNi NoNiSi NoSiNi NioSi NioNi NoNi Nio NioSiNi MinAndMax

Member Typedef Documentation

◆ difference_type

template<vct::size_type _dimension>
typedef vct::difference_type vctDynamicNArrayLoopEngines< _dimension >::difference_type

◆ index_type

template<vct::size_type _dimension>
typedef vct::index_type vctDynamicNArrayLoopEngines< _dimension >::index_type

◆ size_type

template<vct::size_type _dimension>
typedef vct::size_type vctDynamicNArrayLoopEngines< _dimension >::size_type

◆ stride_type

template<vct::size_type _dimension>
typedef vct::stride_type vctDynamicNArrayLoopEngines< _dimension >::stride_type

Member Function Documentation

◆ CalculateOTND()

template<vct::size_type _dimension>
void vctDynamicNArrayLoopEngines< _dimension >::CalculateOTND ( nstride_type & otnd,
const nstride_type & strides,
const nstride_type & stnd )
inlinestatic

Helper function to calculate the pointer offsets to the next dimension.

◆ CalculateSTND()

template<vct::size_type _dimension>
void vctDynamicNArrayLoopEngines< _dimension >::CalculateSTND ( nstride_type & stnd,
const nsize_type & sizes,
const nstride_type & strides )
inlinestatic

Helper function to calculate the strides to next dimension.

◆ IncrementPointers()

template<vct::size_type _dimension>
template<class _elementType, class _pointerType>
dimension_type vctDynamicNArrayLoopEngines< _dimension >::IncrementPointers ( vctFixedSizeVector< const _elementType *, _dimension > & targets,
_pointerType & currentPointer,
const nstride_type & strides,
const nstride_type & stnd )
inlinestatic

Helper function to increment the current pointer and any necessary target pointers.

◆ InitializeTargets()

template<vct::size_type _dimension>
template<class _elementType>
void vctDynamicNArrayLoopEngines< _dimension >::InitializeTargets ( vctFixedSizeVector< const _elementType *, _dimension > & targets,
const nsize_type & sizes,
const nstride_type & strides,
const _elementType * basePtr )
inlinestatic

Helper function to calculate the initial targets.

◆ SyncCurrentPointer()

template<vct::size_type _dimension>
template<class _elementType>
void vctDynamicNArrayLoopEngines< _dimension >::SyncCurrentPointer ( const _elementType *& currentPointer,
const nstride_type & otnd,
difference_type numberOfWrappedDimensions )
inlinestatic

Helper function to synchronize the given nArray's current pointer with the master nArray's current pointer.

◆ ThrowSizeMismatchException()

template<vct::size_type _dimension>
void vctDynamicNArrayLoopEngines< _dimension >::ThrowSizeMismatchException ( void )
inlinestatic

Helper function to throw an exception whenever sizes mismatch. This enforces that a standard message is sent.

◆ VCT_NARRAY_TRAITS_TYPEDEFS()

template<vct::size_type _dimension>
vctDynamicNArrayLoopEngines< _dimension >::VCT_NARRAY_TRAITS_TYPEDEFS ( _dimension )
The documentation for this class was generated from the following file:
Generated by doxygen 1.18.0