Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::FixedArray< TValueType, VLength > Class Template Reference
[Data Representation Objects]

Simulate a standard C array with copy semnatics. More...

#include <itkFixedArray.h>

Inheritance diagram for itk::FixedArray:

Inheritance graph
[legend]
List of all members.

Public Types

typedef TValueType ValueType
typedef ValueType CArray [VLength]
typedef ValueTypeIterator
typedef const ValueTypeConstIterator
typedef ValueTypepointer
typedef const ValueTypeconst_pointer
typedef ValueTypereference
typedef const ValueTypeconst_reference
typedef unsigned int SizeType

Public Methods

 itkStaticConstMacro (Length, unsigned int, VLength)
 itkStaticConstMacro (Dimension, unsigned int, VLength)
 ~FixedArray ()
 FixedArray ()
 FixedArray (const FixedArray &r)
 FixedArray (const ValueType r[VLength])
FixedArray & operator= (const FixedArray &r)
FixedArray & operator= (const ValueType r[VLength])
bool operator== (const FixedArray &r) const
bool operator!= (const FixedArray &r) const
reference operator[] (short index)
const_reference operator[] (short index) const
reference operator[] (unsigned short index)
const_reference operator[] (unsigned short index) const
reference operator[] (int index)
const_reference operator[] (int index) const
reference operator[] (unsigned int index)
const_reference operator[] (unsigned int index) const
reference operator[] (long index)
const_reference operator[] (long index) const
reference operator[] (unsigned long index)
const_reference operator[] (unsigned long index) const
ValueTypeGetDataPointer ()
const ValueTypeGetDataPointer () const
Iterator Begin ()
ConstIterator Begin () const
Iterator End ()
ConstIterator End () const
ReverseIterator rBegin ()
ConstReverseIterator rBegin () const
ReverseIterator rEnd ()
ConstReverseIterator rEnd () const
SizeType Size () const
void Fill (const ValueType &)

Static Public Methods

FixedArray Filled (const ValueType &)

Detailed Description

template<typename TValueType, unsigned int VLength = 3>
class itk::FixedArray< TValueType, VLength >

Simulate a standard C array with copy semnatics.

Simulates a standard C array, except that copy semantics are used instead of reference semantics. Also, arrays of different sizes cannot be assigned to one another, and size information is known for function returns.

Template parameters for class FixedArray:

The length of the array is fixed at compile time. If you wish to specify the length of the array at run-time, use the class itk::Array. If you wish to change to change the length of the array at run-time, you're best off using std::vector<>.

Definition at line 59 of file itkFixedArray.h.


Member Typedef Documentation

template<typename TValueType, unsigned int VLength = 3>
typedef ValueType itk::FixedArray< TValueType, VLength >::CArray[VLength]
 

A type representing the C-array version of this FixedArray.

Definition at line 72 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::GetDataPointer().

template<typename TValueType, unsigned int VLength = 3>
typedef const ValueType* itk::FixedArray< TValueType, VLength >::const_pointer
 

A const pointer to the ValueType.

Definition at line 114 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
typedef const ValueType& itk::FixedArray< TValueType, VLength >::const_reference
 

A const reference to the ValueType.

Definition at line 120 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::operator[]().

template<typename TValueType, unsigned int VLength = 3>
typedef const ValueType* itk::FixedArray< TValueType, VLength >::ConstIterator
 

A const iterator through the array.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, itk::Point< TCoordRep, NPointDimension >, itk::Point< ScalarType, TDimension >, itk::Point< double, VImageDimension >, itk::Point< TCoordRep, VIndexDimension >, itk::Point< double, NDimensions >, and itk::Point< double, TPointDimension >.

Definition at line 78 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::GetDataPointer().

template<typename TValueType, unsigned int VLength = 3>
typedef ValueType* itk::FixedArray< TValueType, VLength >::Iterator
 

An iterator through the array.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, itk::Point< TCoordRep, NPointDimension >, itk::Point< ScalarType, TDimension >, itk::Point< double, VImageDimension >, itk::Point< TCoordRep, VIndexDimension >, itk::Point< double, NDimensions >, and itk::Point< double, TPointDimension >.

Definition at line 75 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::GetDataPointer().

template<typename TValueType, unsigned int VLength = 3>
typedef ValueType* itk::FixedArray< TValueType, VLength >::pointer
 

A pointer to the ValueType.

Definition at line 111 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
typedef ValueType& itk::FixedArray< TValueType, VLength >::reference
 

A reference to the ValueType.

Definition at line 117 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::operator!=(), and itk::FixedArray< TComponent, 4 >::operator[]().

template<typename TValueType, unsigned int VLength = 3>
typedef unsigned int itk::FixedArray< TValueType, VLength >::SizeType
 

Definition at line 122 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::GetDataPointer().

template<typename TValueType, unsigned int VLength = 3>
typedef TValueType itk::FixedArray< TValueType, VLength >::ValueType
 

The element type stored at each location in the FixedArray.

Reimplemented in itk::ContinuousIndex< TCoordRep, VIndexDimension >, itk::CovariantVector< T, NVectorDimension >, itk::Point< TCoordRep, NPointDimension >, itk::RGBPixel< TComponent >, itk::Vector< T, NVectorDimension >, itk::CovariantVector< double, VImageDimension >, itk::CovariantVector< double, 3 >, itk::CovariantVector< double, 2 >, itk::CovariantVector< double, VDimension >, itk::CovariantVector< double, TPointDimension >, itk::CovariantVector< int, 3 >, itk::Point< ScalarType, TDimension >, itk::Point< double, VImageDimension >, itk::Point< TCoordRep, VIndexDimension >, itk::Point< double, NDimensions >, itk::Point< double, TPointDimension >, itk::RGBPixel< T >, itk::RGBPixel< TPixel >, itk::Vector< T, 3 >, itk::Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension), itk::Vector< double, 2 >, itk::Vector< double, VDimension >, itk::Vector< double, TPointDimension >, and itk::Vector< int, 2 >.

Definition at line 69 of file itkFixedArray.h.

Referenced by itk::FixedArray< TComponent, 4 >::GetDataPointer(), and itk::FixedArray< TComponent, 4 >::operator[]().


Constructor & Destructor Documentation

template<typename TValueType, unsigned int VLength = 3>
itk::FixedArray< TValueType, VLength >::FixedArray  
 

Constructors

template<typename TValueType, unsigned int VLength = 3>
itk::FixedArray< TValueType, VLength >::FixedArray const FixedArray< TValueType, VLength > &    r
 

Constructors

template<typename TValueType, unsigned int VLength = 3>
itk::FixedArray< TValueType, VLength >::FixedArray const ValueType    r[VLength]
 

Constructors

template<typename TValueType, unsigned int VLength = 3>
itk::FixedArray< TValueType, VLength >::~FixedArray  
 

This destructor is not virtual for performance reasons. However, this means that subclasses cannot allocate memory.


Member Function Documentation

template<typename TValueType, unsigned int VLength = 3>
ConstIterator itk::FixedArray< TValueType, VLength >::Begin   const
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
Iterator itk::FixedArray< TValueType, VLength >::Begin  
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
ConstIterator itk::FixedArray< TValueType, VLength >::End   const
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
Iterator itk::FixedArray< TValueType, VLength >::End  
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
void itk::FixedArray< TValueType, VLength >::Fill const ValueType  
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
FixedArray itk::FixedArray< TValueType, VLength >::Filled const ValueType   [static]
 

template<typename TValueType, unsigned int VLength = 3>
const ValueType* itk::FixedArray< TValueType, VLength >::GetDataPointer   const [inline]
 

Return a pointer to the data.

Definition at line 167 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
ValueType* itk::FixedArray< TValueType, VLength >::GetDataPointer   [inline]
 

Return a pointer to the data.

Definition at line 166 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
itk::FixedArray< TValueType, VLength >::itkStaticConstMacro Dimension   ,
unsigned    int,
VLength   
 

Dimension constant

template<typename TValueType, unsigned int VLength = 3>
itk::FixedArray< TValueType, VLength >::itkStaticConstMacro Length   ,
unsigned    int,
VLength   
 

Length constant

template<typename TValueType, unsigned int VLength = 3>
bool itk::FixedArray< TValueType, VLength >::operator!= const FixedArray< TValueType, VLength > &    r const [inline]
 

Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.

Definition at line 144 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
FixedArray& itk::FixedArray< TValueType, VLength >::operator= const ValueType    r[VLength]
 

Operator= defined for a variety of types.

template<typename TValueType, unsigned int VLength = 3>
FixedArray& itk::FixedArray< TValueType, VLength >::operator= const FixedArray< TValueType, VLength > &    r
 

Operator= defined for a variety of types.

template<typename TValueType, unsigned int VLength = 3>
bool itk::FixedArray< TValueType, VLength >::operator== const FixedArray< TValueType, VLength > &    r const
 

Operators == and != are used to compare whether two arrays are equal. Note that arrays are equal when the number of components (size) is the same, and each component value is equal.

template<typename TValueType, unsigned int VLength = 3>
const_reference itk::FixedArray< TValueType, VLength >::operator[] unsigned long    index const [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 162 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
reference itk::FixedArray< TValueType, VLength >::operator[] unsigned long    index [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 161 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
const_reference itk::FixedArray< TValueType, VLength >::operator[] long    index const [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 160 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
reference itk::FixedArray< TValueType, VLength >::operator[] long    index [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 159 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
const_reference itk::FixedArray< TValueType, VLength >::operator[] unsigned int    index const [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 158 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
reference itk::FixedArray< TValueType, VLength >::operator[] unsigned int    index [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 157 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
const_reference itk::FixedArray< TValueType, VLength >::operator[] int    index const [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 156 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
reference itk::FixedArray< TValueType, VLength >::operator[] int    index [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 155 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
const_reference itk::FixedArray< TValueType, VLength >::operator[] unsigned short    index const [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 154 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
reference itk::FixedArray< TValueType, VLength >::operator[] unsigned short    index [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 153 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
const_reference itk::FixedArray< TValueType, VLength >::operator[] short    index const [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 152 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
reference itk::FixedArray< TValueType, VLength >::operator[] short    index [inline]
 

Allow the FixedArray to be indexed normally. No bounds checking is done. The separate versions are a work-around for an integer conversion bug in Visual C++.

Definition at line 151 of file itkFixedArray.h.

template<typename TValueType, unsigned int VLength = 3>
ConstReverseIterator itk::FixedArray< TValueType, VLength >::rBegin   const
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
ReverseIterator itk::FixedArray< TValueType, VLength >::rBegin  
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
ConstReverseIterator itk::FixedArray< TValueType, VLength >::rEnd   const
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
ReverseIterator itk::FixedArray< TValueType, VLength >::rEnd  
 

Get various iterators to the array.

template<typename TValueType, unsigned int VLength = 3>
SizeType itk::FixedArray< TValueType, VLength >::Size   const
 

Get various iterators to the array.


The documentation for this class was generated from the following file:
Generated at Fri May 21 01:26:32 2004 for ITK by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2000