ERC CISST - cisst software

vctDynamicNArray< _elementType, _dimension > Class Template Reference
[Vectors]

#include <vctDynamicNArray.h>

Inheritance diagram for vctDynamicNArray< _elementType, _dimension >:

[legend]Collaboration diagram for vctDynamicNArray< _elementType, _dimension >:

[legend]List of all members.

Detailed Description

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

An nArray object of dynamic size.

This class defines a nArray object of dynamic size with memory allocation.

The algebraic operations are mostly inherited from the base classes vctDynamicNArrayBase and vctDynamicConstNArrayBase. Here, we will briefly describe the specific properties of vctDynamicNArray, with a few usage examples.

The class is templated by its element type, that is, the nArray element. Normally, the element should be an arithmetic type, that is, support all the standard arithmetic operations: +, -, *, /, =, ==, <, >, <=, >=, ...
The class is templated by dimension, i.e. for a vector-like nArray the dimension would be 1, 2 for a matrix-like nArray, 3 for a volume, ...
The types nsize_type, nindex_type and nstride_type are defined within the scope of the nArray classes and used in their interfaces to set the sizes, access elements or manipulate the layout.
The class uses dynamically allocated memory, and, more importantly, owns the memory. That is, a vctDynamicNArray object automatically frees the allocated memory it owns when it is destroyed.

To allocate the memory, use one of the following operations.

  // define a typical element type and a couple of useful other types
  typedef double ElementType;
  enum {DIMENSION = 3};
  typedef vctDynamicNArray<ElementType, DIMENSION> ArrayType;
  typedef typename ArrayType::nsize_type SizeType;

  // constructor allocation, empty array
  ArrayType a1;

  // Create an empty nArray and later allocate memory.
  ArrayType a2;
  a2.SetSize(SizeType(5, 7, 8));
  vctRandom(a2, ElementType(0), ElementType(10));

  // Create an nArray of some size and change it later.
  // This operation does not preserve any elements in the resized
  // nArray
  ArrayType a3(SizeType(7, 8, 9));
  a3.SetSize(a2.sizes());
  vctRandom(a3, ElementType(-10), ElementType(0));

  // Store an algebraic result to a new nArray.  In this case,
  // memory is allocated by the algebraic operation, and then
  // attached to the nArray object.
  ArrayType a4 = a3 - a2;

NArray assignment can be facilitated through the Assign method (defined in the base class) or as follows.

  // Initialize all elements to the same value
  ArrayType a5(a3.sizes(), 2.0);

  // Assign one matrix to another.
  vctDynamicNArray<int, DIMENSION> nArrayInt;
  nArrayInt.Assign(a5); // preferred syntax
  nArrayInt = a5; // same operation

A few more notes.

The elements lie in contiguous increasing memory addresses.
There is no direct way of ``disowning'' a vctDynamicNArray, that is taking ownership of its memory.
When a function returns an allocating dynamic nArray object, it is better to return a vctReturnDynamicNArray, which is a helper class designed for transfering the ownership of the allocated memory without reallocation.

Parameters:

	_elementType	the type of an element in the nArray.
	_dimension	the dimension the multi-dimensional array.

See also:: vctDynamicNArrayBase vctDynamicConstNArrayBase

Definition at line 123 of file vctDynamicNArray.h.

Public Types

typedef vctDynamicNArrayBase<
vctDynamicNArrayOwner< _elementType,
_dimension >, _elementType,
_dimension > BaseType
typedef vctDynamicNArray<
_elementType, _dimension > ThisType

Public Member Functions

VCT_NARRAY_TRAITS_TYPEDEFS (_dimension)
vctDynamicNArray ()
vctDynamicNArray (const nsize_type &sizes)
vctDynamicNArray (const nsize_type &sizes, value_type value)
vctDynamicNArray (const vctReturnDynamicNArray< value_type, _dimension > &otherNArray)
template<class _otherNArrayOwnerType, typename _otherNArrayElementType> vctDynamicNArray (const vctDynamicConstNArrayBase< _otherNArrayOwnerType, _otherNArrayElementType, _dimension > &otherNArray)
template<class __nArrayOwnerType, typename __elementType> ThisType & operator= (const vctDynamicConstNArrayBase< __nArrayOwnerType, __elementType, _dimension > &otherNArray)
ThisType & operator= (const ThisType &otherNArray)
ThisType & operator= (const vctReturnDynamicNArray< value_type, _dimension > &otherNArray)
ThisType & operator= (const value_type &value)
template<class __nArrayOwnerType, typename __elementType> ThisType & ForceAssign (const vctDynamicConstNArrayBase< __nArrayOwnerType, __elementType, _dimension > &other)
template<class _elementType, vct::size_type _dimension> vctDynamicNArray (const vctReturnDynamicNArray< _elementType, _dimension > &other)
template<class _elementType, vct::size_type _dimension> vctDynamicNArray< _elementType,
_dimension > & operator= (const vctReturnDynamicNArray< _elementType, _dimension > &other)

void SetSize (const nsize_type &sizes)

Public Attributes

_elementType