cisst-saw: vctDynamicNArrayLoopEngines< _dimension > Class Template Reference

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

#include <vctDynamicNArrayLoopEngines.h>

Classes
class	MinAndMax

class	Nio

class	NioNi

class	NioNiNi

class	NioSi

class	NioSiNi

class	NoNi

class	NoNiNi

class	NoNiSi

class	NoSiNi

class	SoNi

class	SoNiNi

class	SoNiSi

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) throw (std::runtime_error)

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

template<vct::size_type _dimension>

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

template<vct::size_type _dimension>

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

template<vct::size_type _dimension>

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

template<vct::size_type _dimension>

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

Member Function Documentation

template<vct::size_type _dimension>

static 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.

template<vct::size_type _dimension>

static 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.

template<vct::size_type _dimension>

template<class _elementType , class _pointerType >

static 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.

template<vct::size_type _dimension>

template<class _elementType >

static 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.

template<vct::size_type _dimension>

template<class _elementType >

static 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.

template<vct::size_type _dimension>

static void vctDynamicNArrayLoopEngines< _dimension >::ThrowSizeMismatchException	(	void		)
throw	(	std::runtime_error
	)

inlinestatic

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

template<vct::size_type _dimension>

vctDynamicNArrayLoopEngines< _dimension >::VCT_NARRAY_TRAITS_TYPEDEFS ( _dimension )

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstVector/vctDynamicNArrayLoopEngines.h