ML Reference
Public Types | Public Attributes | Protected Member Functions
ml::TVectorNDBase< CompIntType, NumDim > Class Template Reference

TVectorNDBase is the data container class for the TVector template providing ND functionality for integer vectors. More...

#include <mlIntegerVector.h>

List of all members.

Public Types

enum  { NumberOfDimensions = NumDim }
 Enumerator defining the dimension of this class. More...
typedef CompIntType ComponentType
 Integer type used by this vector.

Public Attributes

ComponentType array [NumberOfDimensions]
 Provides access to all members as an array; the caller must guarantee that indexes are within [0,...,NumDim-1].

Protected Member Functions

 TVectorNDBase ()
 Do not allow a direct creation of this class as object, because this container does not initialize itself, it must be done only by derived classes for performance reasons.

Detailed Description

template<typename CompIntType, VectorDimIdxType NumDim>
class ml::TVectorNDBase< CompIntType, NumDim >

TVectorNDBase is the data container class for the TVector template providing ND functionality for integer vectors.

Parameters:
CompIntTypeis the integer type used as component member type; only signed integer types are tested/recommended.
NumDimis the Dimension of the vector, must be > 0.

Definition at line 34 of file mlIntegerVector.h.

Member Typedef Documentation

template<typename CompIntType, VectorDimIdxType NumDim>
typedef CompIntType ml::TVectorNDBase< CompIntType, NumDim >::ComponentType

Integer type used by this vector.

Definition at line 39 of file mlIntegerVector.h.

Member Enumeration Documentation

template<typename CompIntType, VectorDimIdxType NumDim>
anonymous enum

Enumerator defining the dimension of this class.

Enumerator:
NumberOfDimensions 

Definition at line 42 of file mlIntegerVector.h.

Constructor & Destructor Documentation

template<typename CompIntType, VectorDimIdxType NumDim>
ml::TVectorNDBase< CompIntType, NumDim >::TVectorNDBase ( ) [inline, protected]

Do not allow a direct creation of this class as object, because this container does not initialize itself, it must be done only by derived classes for performance reasons.

Definition at line 53 of file mlIntegerVector.h.

Member Data Documentation

template<typename CompIntType, VectorDimIdxType NumDim>
ComponentType ml::TVectorNDBase< CompIntType, NumDim >::array[NumberOfDimensions]

Provides access to all members as an array; the caller must guarantee that indexes are within [0,...,NumDim-1].

Definition at line 46 of file mlIntegerVector.h.

Referenced by ml::AbstractPersistenceOutputStream::write().

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