vctForwardDeclarations.h File Reference

Forward declarations and #define for cisstVector. More...

#include <cisstCommon/cmnPortability.h>
#include <cisstVector/vctContainerTraits.h>

Go to the source code of this file.

Classes
class	vctVarStrideNArrayIterator< _ownerType, _forward >
class	vctVarStrideNArrayConstIterator< _ownerType, _forward >
class	vctFixedSizeConstVectorBase< _size, _stride, _elementType, _dataPtrType >
	A template for a fixed length vector with fixed spacing in memory. More...
class	vctFixedSizeVectorBase< _size, _stride, _elementType, _dataPtrType >
	A template for a fixed length vector with fixed spacing in memory. More...
class	vctFixedSizeConstVectorRef< _elementType, _size, _stride >
	An implementation of the ``abstract'' vctFixedSizeConstVectorBase. More...
class	vctFixedSizeVectorRef< _elementType, _size, _stride >
	An implementation of the ``abstract'' vctFixedSizeVectorBase. More...
class	vctFixedSizeVector< _elementType, _size >
	Implementation of a fixed-size vector using template metaprogramming. More...
class	vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >
	A template for a fixed size matrix with fixed spacing in memory. More...
class	vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >
	A template for a fixed size matrix with fixed spacings in memory. More...
class	vctFixedSizeConstMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >
	An implementation of the ``abstract'' vctFixedSizeConstMatrixBase. More...
class	vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >
	An implementation of the ``abstract'' vctFixedSizeMatrixBase. More...
class	vctFixedSizeMatrix< _elementType, _rows, _cols, _rowMajor >
	Implementation of a fixed-size matrix using template metaprogramming. More...
class	vctDynamicConstVectorBase< _vectorOwnerType, _elementType >
class	vctDynamicVectorBase< _vectorOwnerType, _elementType >
class	vctDynamicConstVectorRef< _elementType >
	Dynamic vector referencing existing memory (const) More...
class	vctDynamicVectorRef< _elementType >
	Dynamic vector referencing existing memory. More...
class	vctDynamicVector< _elementType >
	A vector object of dynamic size. More...
class	vctReturnDynamicVector< _elementType >
class	vctDynamicVectorOwner< _elementType >
class	vctDynamicVectorRefOwner< _elementType >
class	vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >
class	vctDynamicMatrixBase< _matrixOwnerType, _elementType >
class	vctDynamicConstMatrixRef< _elementType >
	Dynamic matrix referencing existing memory (const) More...
class	vctDynamicMatrixRef< _elementType >
	Dynamic matrix referencing existing memory. More...
class	vctDynamicMatrix< _elementType >
	A matrix object of dynamic size. More...
class	vctReturnDynamicMatrix< _elementType >
class	vctDynamicMatrixOwner< _elementType >
class	vctDynamicMatrixRefOwner< _elementType >
class	vctDynamicConstNArrayBase< _nArrayOwnerType, _elementType, _dimension >
class	vctDynamicNArrayBase< _nArrayOwnerType, _elementType, _dimension >
class	vctDynamicConstNArrayRef< _elementType, _dimension >
	Dynamic nArray referencing existing memory (const) More...
class	vctDynamicNArrayRef< _elementType, _dimension >
	Dynamic nArray referencing existing memory. More...
class	vctDynamicNArray< _elementType, _dimension >
	An nArray object of dynamic size. More...
class	vctReturnDynamicNArray< _elementType, _dimension >
class	vctDynamicNArrayOwner< _elementType, _dimension >
class	vctDynamicNArrayRefOwner< _elementType, _dimension >
class	vctMatrixRotation3ConstBase< _containerType >
	Define a rotation matrix for a space of dimension 3. More...
class	vctMatrixRotation3Base< _containerType >
	Define a rotation matrix for a space of dimension 3. More...
class	vctMatrixRotation3< _elementType, _rowMajor >
	Define a rotation matrix for a space of dimension 3. More...
class	vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >
	Define a rotation matrix for a space of dimension 3. More...
class	vctMatrixRotation3ConstRef< _elementType, _rowStride, _colStride >
	Define a rotation matrix for a space of dimension 3. More...
class	vctQuaternionBase< _containerType >
	Define a quaternion container. More...
class	vctQuaternionRotation3Base< _containerType >
	Define a rotation quaternion for a space of dimension 3. More...
class	vctAxisAngleRotation3< _elementType >
	Define a rotation based on an axis and an angle for a space of dimension 3. More...
class	vctRodriguezRotation3Base< _containerType >
	Define a rotation based on the rodriguez representation for a space of dimension 3. More...
class	vctRodriguezRotation3< _elementType >
	Define a rotation based on the rodriguez representation for a space of dimension 3. This representation is based on a vector. The direction of the vector determines the axis of rotation and its norm defines the amplitude of the rotation. More...
class	vctEulerRotation3< _order >
class	vctMatrixRotation2Base< _containerType >
	Define a rotation matrix for a space of dimension 2. More...
class	vctFrameBase< _rotationType >
	Template base class for a frame. More...
class	vctFrame4x4ConstBase< _containerType >
	Template base class for a 4x4 frame. More...
class	vctFrame4x4Base< _containerType >
	Template base class for a 4x4 frame. More...
class	vctFrame4x4< _elementType, _rowMajor >
	Template base class for a 4x4 frame. More...

Namespaces
	vctEulerRotation3Order

Macros
#define	_vctForwardDeclarations_h

Enumerations
enum	vctEulerRotation3Order::OrderType { vctEulerRotation3Order::ZYZ, vctEulerRotation3Order::ZYX }

Variables
const bool	VCT_NORMALIZE = true
const bool	VCT_DO_NOT_NORMALIZE = false
Definition of the storage order used for the matrices.
The default for cisstVector is row major (VCT_ROW_MAJOR) which is the default convention for C/C++ code. In order to support some numerical libraries in Fortran (or Fortran compatible), cisstVector also support column major order (VCT_COL_MAJOR).
const bool	VCT_ROW_MAJOR = true
const bool	VCT_COL_MAJOR = false
const bool	VCT_DEFAULT_STORAGE = VCT_ROW_MAJOR
const bool	VCT_FORTRAN_ORDER = VCT_COL_MAJOR

Detailed Description

Forward declarations and #define for cisstVector.

Macro Definition Documentation

#define _vctForwardDeclarations_h

Variable Documentation

const bool VCT_COL_MAJOR = false

Value to use for a column major storage order.

const bool VCT_DEFAULT_STORAGE = VCT_ROW_MAJOR

Default storage order used in cisstVector.

const bool VCT_DO_NOT_NORMALIZE = false

Value used to NOT force the normalization of the input for rotation constructors. Not only the input will not be normalized, but the constructor or method will not check if the input is normalized. See classes vctMatrixRotation3Base, vctQuaternionRotation3Base, vctAxisAngleRotation3, vctRodriguezRotation3Base, etc.

const bool VCT_FORTRAN_ORDER = VCT_COL_MAJOR

More friendly value to use for Fortran storage. Equivalent to VCT_COL_MAJOR.

const bool VCT_NORMALIZE = true

Value used to force the normalization of the input for rotation constructors. See classes vctMatrixRotation3Base, vctQuaternionRotation3Base, vctAxisAngleRotation3, vctRodriguezRotation3Base, etc.

const bool VCT_ROW_MAJOR = true

Value to use for a row major storage order.