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< TValueType, VLength >:

[legend]List of all members.

Public Types
typedef TValueType	ValueType
typedef ValueType	CArray [VLength]
typedef ValueType *	Iterator
typedef const ValueType *	ConstIterator
typedef ValueType *	pointer
typedef const ValueType *	const_pointer
typedef ValueType &	reference
typedef const ValueType &	const_reference
typedef unsigned int	SizeType
Public Member Functions
	itkStaticConstMacro (Length, unsigned int, VLength)
	itkStaticConstMacro (Dimension, unsigned int, VLength)
	~FixedArray ()
FixedArray &	operator= (const ValueType r[VLength])
	FixedArray ()
	FixedArray (const ValueType r[VLength])
template<class TFixedArrayValueType>	FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)
template<class TFixedArrayValueType> FixedArray &	operator= (const FixedArray< TFixedArrayValueType, VLength > &r)
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
void	SetElement (unsigned short index, const_reference value)
const_reference	GetElement (unsigned short index) const
ValueType *	GetDataPointer ()
const ValueType *	GetDataPointer () 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 Member Functions
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:

• TValueType = Element type stored at each location in the array.
• VLength = Length of the array.

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 64 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 77 of file itkFixedArray.h.

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 123 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 129 of file itkFixedArray.h.

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< double, VImageDimension >, itk::Point< TCoordRep, VIndexDimension >, itk::Point< TScalarType, itkGetStaticConstMacro(InputSpaceDimension), itk::Point< double, NDimensions >, itk::Point< double, 3 >, itk::Point< double, TDimension >, itk::Point< double, 2 >, itk::Point< TScalarType, itkGetStaticConstMacro(SpaceDimension), itk::Point< double, TPointDimension >, and itk::Point< CoordRepType, itkGetStaticConstMacro(ImageDimension). Definition at line 83 of file itkFixedArray.h. Referenced by itk::FixedArray< TValueType, VLength >::ConstReverseIterator::ConstReverseIterator(), itk::FixedArray< TValueType, VLength >::ConstReverseIterator::operator++(), itk::FixedArray< TValueType, VLength >::ConstReverseIterator::operator--(), and itk::FixedArray< TValueType, VLength >::ConstReverseIterator::operator->().

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< double, VImageDimension >, itk::Point< TCoordRep, VIndexDimension >, itk::Point< TScalarType, itkGetStaticConstMacro(InputSpaceDimension), itk::Point< double, NDimensions >, itk::Point< double, 3 >, itk::Point< double, TDimension >, itk::Point< double, 2 >, itk::Point< TScalarType, itkGetStaticConstMacro(SpaceDimension), itk::Point< double, TPointDimension >, and itk::Point< CoordRepType, itkGetStaticConstMacro(ImageDimension). Definition at line 80 of file itkFixedArray.h. Referenced by itk::FixedArray< TValueType, VLength >::ReverseIterator::operator++(), itk::FixedArray< TValueType, VLength >::ReverseIterator::operator--(), itk::FixedArray< TValueType, VLength >::ReverseIterator::operator->(), and itk::FixedArray< TValueType, VLength >::ReverseIterator::ReverseIterator().

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

A pointer to the ValueType. Definition at line 120 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 126 of file itkFixedArray.h.

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

Definition at line 131 of file itkFixedArray.h.

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::DiffusionTensor3D< TComponent >, itk::Point< TCoordRep, NPointDimension >, itk::RGBPixel< TComponent >, itk::SymmetricSecondRankTensor< TComponent, NDimension >, 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::Point< double, VImageDimension >, itk::Point< TCoordRep, VIndexDimension >, itk::Point< TScalarType, itkGetStaticConstMacro(InputSpaceDimension), itk::Point< double, NDimensions >, itk::Point< double, 3 >, itk::Point< double, TDimension >, itk::Point< double, 2 >, itk::Point< TScalarType, itkGetStaticConstMacro(SpaceDimension), itk::Point< double, TPointDimension >, itk::Point< CoordRepType, itkGetStaticConstMacro(ImageDimension), itk::RGBPixel< float >, itk::RGBPixel< unsigned char >, itk::RGBPixel< TPixel >, itk::SymmetricSecondRankTensor< TComponent, 3 >, itk::Vector< double, TSampleDimension >, itk::Vector< TScalarType, itkGetStaticConstMacro(InputSpaceDimension), itk::Vector< double, 3 >, itk::Vector< double, TDimension >, itk::Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension), itk::Vector< double, 2 >, itk::Vector< NodeValueType,::itk::GetImageDimension< TImageType >::ImageDimension >, itk::Vector< TScalarType, 3 >, itk::Vector< double, VDimension >, itk::Vector< double, TPointDimension >, itk::Vector< CoordRepType, itkGetStaticConstMacro(SpaceDimension), itk::Vector< ScalarType, itkGetStaticConstMacro(ImageDimension), itk::Vector< int, 2 >, itk::Vector< double, NSpaceDimension >, and itk::Vector< TScalarType, 6 >. Definition at line 74 of file itkFixedArray.h. Referenced by itk::FixedArray< TValueType, VLength >::ConstReverseIterator::operator *(), and itk::FixedArray< TValueType, VLength >::ReverseIterator::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 ValueType  r[VLength]  )

Constructors

template<typename TValueType, unsigned int VLength = 3> template<class TFixedArrayValueType> itk::FixedArray< TValueType, VLength >::FixedArray (  const FixedArray< TFixedArrayValueType, VLength > &  r  )  [inline]

Constructor to initialize a fixed array from another of any data type Definition at line 141 of file itkFixedArray.h.

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. Referenced by itk::FixedArray< vnl_vector_fixed< double, VImageDimension >, VCliqueSize >::FixedArray().

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. Referenced by itk::FixedArray< vnl_vector_fixed< double, VImageDimension >, VCliqueSize >::FixedArray().

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

Get various iterators to the array. Referenced by itk::MeasurementVectorTraits::SetLength().

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 201 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 200 of file itkFixedArray.h.

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

Set/Get element methods are more convenient in wrapping languages Definition at line 196 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 172 of file itkFixedArray.h.

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

template<typename TValueType, unsigned int VLength = 3> template<class TFixedArrayValueType> FixedArray& itk::FixedArray< TValueType, VLength >::operator= (  const FixedArray< TFixedArrayValueType, VLength > &  r  )  [inline]

Operator= defined for a variety of types. Definition at line 156 of file itkFixedArray.h.

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 190 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 189 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 188 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 187 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 186 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 185 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 184 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 183 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 182 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 181 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 180 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 179 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> void itk::FixedArray< TValueType, VLength >::SetElement (  unsigned short  index, const_reference  value )  [inline]

Set/Get element methods are more convenient in wrapping languages Definition at line 194 of file itkFixedArray.h.

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:

• itkFixedArray.h

---