ERC CISST - cisst software

---

vctDynamicMatrixOwner< _elementType > Class Template Reference

#include <vctDynamicMatrixOwner.h>

Collaboration diagram for vctDynamicMatrixOwner< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class vctDynamicMatrixOwner< _elementType >

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

Definition at line 39 of file vctDynamicMatrixOwner.h.

Public Types

• enum
• typedef vctDynamicMatrixOwner<
  value_type > ThisType
• typedef vctVarStrideMatrixConstIterator<
  value_type > const_iterator
• typedef vctVarStrideMatrixConstIterator<
  value_type > const_reverse_iterator
• typedef vctVarStrideMatrixIterator<
  value_type > iterator
• typedef vctVarStrideMatrixIterator<
  value_type > reverse_iterator

Public Member Functions

• VCT_NARRAY_TRAITS_TYPEDEFS (DIMENSION)
• vctDynamicMatrixOwner ()
• vctDynamicMatrixOwner (const nsize_type &newSizes, bool rowMajor=VCT_DEFAULT_STORAGE)
• vctDynamicMatrixOwner (size_type rows, size_type cols, bool rowMajor=VCT_DEFAULT_STORAGE)
• ~vctDynamicMatrixOwner ()
• size_type size (void) const
• const nsize_type & sizes (void) const
• size_type rows (void) const
• size_type cols (void) const
• const nstride_type & strides (void) const
• difference_type row_stride (void) const
• difference_type col_stride (void) const
• pointer Pointer (index_type rowIndex, index_type colIndex)
• pointer Pointer (void)
• const_pointer Pointer (index_type rowIndex, index_type colIndex) const
• const_pointer Pointer (void) const
• const_iterator begin (void) const
• const_iterator end (void) const
• iterator begin (void)
• iterator end (void)
• const_reverse_iterator rbegin (void) const
• const_reverse_iterator rend (void) const
• reverse_iterator rbegin (void)
• reverse_iterator rend (void)
• pointer Release ()
• void Disown (void)
• bool IsColMajor (void) const
• bool IsRowMajor (void) const
• bool IsCompact (void) const
• bool StorageOrder (void) const

• void SetSize (size_type rows, size_type cols, bool rowMajor)
• void SetSize (const nsize_type &newSizes, bool rowMajor)

• pointer Own (size_type rows, size_type cols, bool rowMajor, pointer data)
• pointer Own (const nsize_type &newSizes, bool rowMajor, pointer data)

Public Attributes

• _elementType

Protected Attributes

• nsize_type SizesMember
• nstride_type StridesMember
• bool RowMajor
• value_type * Data

---

Member Function Documentation

template<class _elementType>

void vctDynamicMatrixOwner< _elementType >::SetSize	(	size_type	rows,
		size_type	cols,
		bool	rowMajor
	)			[inline]

Non-preserving resize operation. This method discards of all the current data of the dynamic array and allocates new space in the requested size.

Note:

If the storage order and the sizes (both rows and columns) are unchanged, this method does nothing.

If the size is set to zero, the data pointer is set to null (0).

Definition at line 177 of file vctDynamicMatrixOwner.h.

Referenced by vctDynamicMatrix< svlTarget2D >::SetSize(), and vctDynamicMatrixOwner< _elementType >::vctDynamicMatrixOwner().

template<class _elementType>

void vctDynamicMatrixOwner< _elementType >::SetSize	(	const nsize_type &	newSizes,
		bool	rowMajor
	)			[inline]

Non-preserving resize operation. This method discards of all the current data of the dynamic array and allocates new space in the requested size.

Note:

If the storage order and the sizes (both rows and columns) are unchanged, this method does nothing.

If the size is set to zero, the data pointer is set to null (0).

Definition at line 181 of file vctDynamicMatrixOwner.h.

References vctDynamicMatrixOwner< _elementType >::Disown(), vctDynamicMatrixOwner< _elementType >::Own(), and vctDynamicMatrixOwner< _elementType >::RowMajor.

template<class _elementType>

pointer vctDynamicMatrixOwner< _elementType >::Release

(

void

)

[inline]

Release the currently owned data pointer from being owned. Reset this owner's data pointer and size to zero. Return the old data pointer without freeing memory.

Definition at line 193 of file vctDynamicMatrixOwner.h.

References vctDynamicMatrixOwner< _elementType >::Data, vctDynamicMatrixOwner< _elementType >::RowMajor, vctDynamicMatrixOwner< _elementType >::SizesMember, and VCT_DEFAULT_STORAGE.

Referenced by vctDynamicMatrix< _elementType >::operator=(), vctDynamicMatrix< svlTarget2D >::resize(), vctDynamicMatrix< _elementType >::vctDynamicMatrix(), and vctReturnDynamicMatrix< _elementType >::vctReturnDynamicMatrix().

template<class _elementType>

pointer vctDynamicMatrixOwner< _elementType >::Own	(	size_type	rows,
		size_type	cols,
		bool	rowMajor,
		pointer	data
	)			[inline]

Have this owner take ownership of a new data pointer. Return the old data pointer without freeing memory.

Note:

This method returns a pointer to the previously owned memory block but doesn't tell if the old block was row or column major nor the size of the block.

Definition at line 209 of file vctDynamicMatrixOwner.h.

Referenced by vctDynamicMatrix< _elementType >::operator=(), vctDynamicMatrix< svlTarget2D >::resize(), vctDynamicMatrixOwner< _elementType >::SetSize(), vctDynamicMatrix< _elementType >::vctDynamicMatrix(), and vctReturnDynamicMatrix< _elementType >::vctReturnDynamicMatrix().

template<class _elementType>

pointer vctDynamicMatrixOwner< _elementType >::Own	(	const nsize_type &	newSizes,
		bool	rowMajor,
		pointer	data
	)			[inline]

Have this owner take ownership of a new data pointer. Return the old data pointer without freeing memory.

Note:

This method returns a pointer to the previously owned memory block but doesn't tell if the old block was row or column major nor the size of the block.

Definition at line 213 of file vctDynamicMatrixOwner.h.

References vctDynamicMatrixOwner< _elementType >::cols(), vctDynamicMatrixOwner< _elementType >::Data, vctDynamicMatrixOwner< _elementType >::RowMajor, vctDynamicMatrixOwner< _elementType >::rows(), vctDynamicMatrixOwner< _elementType >::SizesMember, and vctDynamicMatrixOwner< _elementType >::StridesMember.

template<class _elementType>

void vctDynamicMatrixOwner< _elementType >::Disown

(

void

)

[inline]

Free the memory allocated for the data pointer. Reset data pointer and size to zero.

Definition at line 227 of file vctDynamicMatrixOwner.h.

References vctDynamicMatrixOwner< _elementType >::Data, vctDynamicMatrixOwner< _elementType >::RowMajor, vctDynamicMatrixOwner< _elementType >::SizesMember, and vctDynamicMatrixOwner< _elementType >::StridesMember.

Referenced by vctDynamicMatrix< _elementType >::operator=(), vctDynamicMatrix< svlTarget2D >::resize(), vctDynamicMatrixOwner< _elementType >::SetSize(), and vctDynamicMatrixOwner< _elementType >::~vctDynamicMatrixOwner().

---

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

• vctDynamicMatrixOwner.h

---