#include <itkFixedArray.h>

Detailed Description

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

Simulate a standard C array with copy semantics.

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

TValue	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<>.

ITK Sphinx Examples:

All ITK Sphinx Examples

Create A Fixed Array

Examples: Examples/Statistics/ImageToListSampleAdaptor.cxx, Examples/Statistics/PointSetToAdaptor.cxx, and Examples/Statistics/ScalarImageMarkovRandomField1.cxx.

Definition at line 53 of file itkFixedArray.h.

Inheritance diagram for itk::FixedArray< TValue, VLength >:

Classes
class	ConstReverseIterator

class	ReverseIterator

Public Types
using	CArray = ValueType[VLength]

using	const_iterator = const ValueType *

using	const_pointer = const ValueType *

using	const_reference = const ValueType &

using	const_reverse_iterator = std::reverse_iterator<const_iterator>

using	ConstIterator = const ValueType *

using	Iterator = ValueType *

using	iterator = ValueType *

using	pointer = ValueType *

using	reference = ValueType &

using	reverse_iterator = std::reverse_iterator<iterator>

using	SizeType = unsigned int

using	value_type = TValue

using	ValueType = TValue

Public Member Functions
Iterator	Begin ()

ConstIterator	Begin () const

constexpr const_iterator	begin () const noexcept

constexpr iterator	begin () noexcept

constexpr const_iterator	cbegin () const noexcept

constexpr const_iterator	cend () const noexcept

const_reverse_iterator	crbegin () const

const_reverse_iterator	crend () const

ValueType *	data ()

const ValueType *	data () const

Iterator	End ()

ConstIterator	End () const

constexpr const_iterator	end () const noexcept

constexpr iterator	end () noexcept

void	Fill (const ValueType &)

	FixedArray ()=default

template<typename TFixedArrayValueType>
	FixedArray (const FixedArray< TFixedArrayValueType, VLength > &r)

	FixedArray (const std::array< ValueType, VLength > &stdArray)

template<typename TScalarValue>
	FixedArray (const TScalarValue *r)

ValueType *	GetDataPointer ()

const ValueType *	GetDataPointer () const

	ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (FixedArray)

template<typename TFixedArrayValueType>
FixedArray &	operator= (const FixedArray< TFixedArrayValueType, VLength > &r)

FixedArray &	operator= (const ValueType r[VLength])

bool	operator== (const FixedArray &r) const

ReverseIterator	rBegin ()

ConstReverseIterator	rBegin () const

reverse_iterator	rbegin ()

const_reverse_iterator	rbegin () const

ReverseIterator	rEnd ()

ConstReverseIterator	rEnd () const

reverse_iterator	rend ()

const_reverse_iterator	rend () const

SizeType	Size () const

constexpr SizeType	size () const

void	swap (FixedArray &other) noexcept


	FixedArray (const ValueType r[VLength])

	FixedArray (const ValueType &)


ITK_GCC_PRAGMA_PUSH ITK_GCC_SUPPRESS_Warray_bounds constexpr reference	operator[] (unsigned int index)

constexpr const_reference	operator[] (unsigned int index) const


ITK_GCC_PRAGMA_POP void	SetElement (unsigned int index, const_reference value)

const_reference	GetElement (unsigned int index) const

Static Public Member Functions
static constexpr FixedArray	Filled (const ValueType &value)

Static Public Attributes
static constexpr unsigned int	Dimension = VLength

static constexpr unsigned int	Length = VLength

Private Attributes
CArray	m_InternalArray

Member Typedef Documentation

◆ CArray

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::CArray = ValueType[VLength]

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

Definition at line 66 of file itkFixedArray.h.

◆ const_iterator

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::const_iterator = const ValueType *

The return type of cbegin() and cend(), and the const overloads of begin() and end().

Definition at line 205 of file itkFixedArray.h.

◆ const_pointer

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::const_pointer = const ValueType *

A const pointer to the ValueType.

Definition at line 193 of file itkFixedArray.h.

◆ const_reference

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::const_reference = const ValueType &

A const reference to the ValueType.

Definition at line 199 of file itkFixedArray.h.

◆ const_reverse_iterator

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::const_reverse_iterator = std::reverse_iterator<const_iterator>

Definition at line 209 of file itkFixedArray.h.

◆ ConstIterator

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::ConstIterator = const ValueType *

A const iterator through the array.

Definition at line 72 of file itkFixedArray.h.

◆ Iterator

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::Iterator = ValueType *

An iterator through the array.

Definition at line 69 of file itkFixedArray.h.

◆ iterator

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::iterator = ValueType *

The return type of the non-const overloads of begin() and end().

Definition at line 202 of file itkFixedArray.h.

◆ pointer

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::pointer = ValueType *

A pointer to the ValueType.

Definition at line 190 of file itkFixedArray.h.

◆ reference

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::reference = ValueType &

A reference to the ValueType.

Definition at line 196 of file itkFixedArray.h.

◆ reverse_iterator

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::reverse_iterator = std::reverse_iterator<iterator>

Definition at line 207 of file itkFixedArray.h.

◆ SizeType

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::SizeType = unsigned int

Definition at line 211 of file itkFixedArray.h.

◆ value_type

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::value_type = TValue

The type of an element.

Definition at line 187 of file itkFixedArray.h.

◆ ValueType

template<typename TValue, unsigned int VLength = 3>

using itk::FixedArray< TValue, VLength >::ValueType = TValue

The element type stored at each location in the FixedArray.

Definition at line 63 of file itkFixedArray.h.

Constructor & Destructor Documentation

◆ FixedArray() [1/6]

template<typename TValue, unsigned int VLength = 3>

itk::FixedArray< TValue, VLength >::FixedArray ( )

default

Default-constructor.

Note: The other five "special member functions" are defaulted implicitly, following the C++ "Rule of Zero".

◆ FixedArray() [2/6]

template<typename TValue, unsigned int VLength = 3>

itk::FixedArray< TValue, VLength >::FixedArray ( const ValueType r[VLength] )

Conversion constructors.

Constructor assumes input points to array of correct size. Values are copied individually instead of with a binary copy. This allows the ValueType's assignment operator to be executed.

◆ FixedArray() [3/6]

template<typename TValue, unsigned int VLength = 3>

itk::FixedArray< TValue, VLength >::FixedArray ( const ValueType & )

Conversion constructors.

Constructor assumes input points to array of correct size. Values are copied individually instead of with a binary copy. This allows the ValueType's assignment operator to be executed.

◆ FixedArray() [4/6]

template<typename TValue, unsigned int VLength = 3>

itk::FixedArray< TValue, VLength >::FixedArray ( const std::array< ValueType, VLength > & stdArray )

inlineexplicit

Explicit constructor for std::array.

Definition at line 229 of file itkFixedArray.h.

◆ FixedArray() [5/6]

template<typename TValue, unsigned int VLength = 3>

template<typename TFixedArrayValueType>

itk::FixedArray< TValue, VLength >::FixedArray ( const FixedArray< TFixedArrayValueType, VLength > & r )

inline

Constructor to initialize a fixed array from another of any data type

Definition at line 236 of file itkFixedArray.h.

◆ FixedArray() [6/6]

template<typename TValue, unsigned int VLength = 3>

template<typename TScalarValue>

itk::FixedArray< TValue, VLength >::FixedArray ( const TScalarValue * r )

inline

Definition at line 247 of file itkFixedArray.h.

Member Function Documentation

◆ Begin() [1/2]

template<typename TValue, unsigned int VLength = 3>

Iterator itk::FixedArray< TValue, VLength >::Begin ( )

Get an Iterator for the beginning of the FixedArray.

Referenced by itk::DTITubeSpatialObjectPoint< TDimension >::SetTensorMatrix(), and itk::DTITubeSpatialObjectPoint< TDimension >::SetTensorMatrix().

◆ Begin() [2/2]

template<typename TValue, unsigned int VLength = 3>

ConstIterator itk::FixedArray< TValue, VLength >::Begin ( ) const

nodiscard

Get a ConstIterator for the beginning of the FixedArray.

◆ begin() [1/2]

template<typename TValue, unsigned int VLength = 3>

const_iterator itk::FixedArray< TValue, VLength >::begin ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 380 of file itkFixedArray.h.

◆ begin() [2/2]

template<typename TValue, unsigned int VLength = 3>

iterator itk::FixedArray< TValue, VLength >::begin ( )

inlineconstexprnoexcept

Definition at line 374 of file itkFixedArray.h.

◆ cbegin()

template<typename TValue, unsigned int VLength = 3>

const_iterator itk::FixedArray< TValue, VLength >::cbegin ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 368 of file itkFixedArray.h.

Referenced by itk::FixedArray< CoordinateType, VPointDimension *2 >::FixedArray(), and itk::FixedArray< CoordinateType, VPointDimension *2 >::operator=().

◆ cend()

template<typename TValue, unsigned int VLength = 3>

const_iterator itk::FixedArray< TValue, VLength >::cend ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 386 of file itkFixedArray.h.

◆ crbegin()

template<typename TValue, unsigned int VLength = 3>

const_reverse_iterator itk::FixedArray< TValue, VLength >::crbegin ( ) const

inlinenodiscard

Definition at line 410 of file itkFixedArray.h.

◆ crend()

template<typename TValue, unsigned int VLength = 3>

const_reverse_iterator itk::FixedArray< TValue, VLength >::crend ( ) const

inlinenodiscard

Definition at line 428 of file itkFixedArray.h.

◆ data() [1/2]

template<typename TValue, unsigned int VLength = 3>

ValueType * itk::FixedArray< TValue, VLength >::data ( )

inline

Definition at line 328 of file itkFixedArray.h.

◆ data() [2/2]

template<typename TValue, unsigned int VLength = 3>

const ValueType * itk::FixedArray< TValue, VLength >::data ( ) const

inlinenodiscard

Definition at line 334 of file itkFixedArray.h.

◆ End() [1/2]

template<typename TValue, unsigned int VLength = 3>

Iterator itk::FixedArray< TValue, VLength >::End ( )

Get an Iterator for the end of the FixedArray.

Referenced by itk::DTITubeSpatialObjectPoint< TDimension >::SetTensorMatrix(), and itk::DTITubeSpatialObjectPoint< TDimension >::SetTensorMatrix().

◆ End() [2/2]

template<typename TValue, unsigned int VLength = 3>

ConstIterator itk::FixedArray< TValue, VLength >::End ( ) const

nodiscard

Get a ConstIterator for the end of the FixedArray.

◆ end() [1/2]

template<typename TValue, unsigned int VLength = 3>

const_iterator itk::FixedArray< TValue, VLength >::end ( ) const

inlinenodiscardconstexprnoexcept

Definition at line 398 of file itkFixedArray.h.

◆ end() [2/2]

template<typename TValue, unsigned int VLength = 3>

iterator itk::FixedArray< TValue, VLength >::end ( )

inlineconstexprnoexcept

Definition at line 392 of file itkFixedArray.h.

◆ Fill()

template<typename TValue, unsigned int VLength = 3>

void itk::FixedArray< TValue, VLength >::Fill ( const ValueType & )

Set all the elements of the container to the input value.

Referenced by itk::RGBAPixel< T >::RGBAPixel(), itk::NumericTraits< CovariantVector< T, D > >::SetLength(), itk::NumericTraits< DiffusionTensor3D< T > >::SetLength(), itk::NumericTraits< FixedArray< T, D > >::SetLength(), itk::NumericTraits< Point< T, D > >::SetLength(), itk::NumericTraits< RGBAPixel< T > >::SetLength(), itk::NumericTraits< RGBPixel< T > >::SetLength(), itk::NumericTraits< SymmetricSecondRankTensor< T, D > >::SetLength(), and itk::NumericTraits< Vector< T, D > >::SetLength().

◆ Filled()

template<typename TValue, unsigned int VLength = 3>

static constexpr FixedArray itk::FixedArray< TValue, VLength >::Filled ( const ValueType & value )

inlinestaticconstexpr

Return an FixedArray with the given value assigned to all elements.

Definition at line 466 of file itkFixedArray.h.

◆ GetDataPointer() [1/2]

template<typename TValue, unsigned int VLength = 3>

ValueType * itk::FixedArray< TValue, VLength >::GetDataPointer ( )

inline

Return a pointer to the data.

Definition at line 316 of file itkFixedArray.h.

Referenced by itk::Accessor::RGBToVectorPixelAccessor< T >::Get(), itk::Accessor::VectorToRGBPixelAccessor< T >::Get(), itk::MetaArrayWriter::SetInput(), itk::MetaArrayWriter::SetInput(), itk::MetaArrayWriter::SetInput(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel(), itk::ImageBase< VImageDimension >::TransformLocalVectorToPhysicalVector(), itk::GradientRecursiveGaussianImageFilter< MovingImageType, GradientImageType >::TransformOutputPixel(), and itk::ImageBase< VImageDimension >::TransformPhysicalVectorToLocalVector().

◆ GetDataPointer() [2/2]

template<typename TValue, unsigned int VLength = 3>

const ValueType * itk::FixedArray< TValue, VLength >::GetDataPointer ( ) const

inlinenodiscard

Definition at line 322 of file itkFixedArray.h.

◆ GetElement()

template<typename TValue, unsigned int VLength = 3>

const_reference itk::FixedArray< TValue, VLength >::GetElement ( unsigned int index ) const

inlinenodiscard

Set/Get element methods are more convenient in wrapping languages

Definition at line 309 of file itkFixedArray.h.

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

template<typename TValue, unsigned int VLength = 3>

itk::FixedArray< TValue, VLength >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION ( FixedArray< TValue, VLength > )

◆ operator=() [1/2]

template<typename TValue, unsigned int VLength = 3>

template<typename TFixedArrayValueType>

FixedArray & itk::FixedArray< TValue, VLength >::operator= ( const FixedArray< TFixedArrayValueType, VLength > & r )

inline

Operator= defined for a variety of types.

The assignment operator assumes input points to array of correct size. Values are copied individually instead of with a binary copy. This allows the ValueType's assignment operator to be executed.

Definition at line 260 of file itkFixedArray.h.

◆ operator=() [2/2]

template<typename TValue, unsigned int VLength = 3>

FixedArray & itk::FixedArray< TValue, VLength >::operator= ( const ValueType r[VLength] )

◆ operator==()

template<typename TValue, unsigned int VLength = 3>

bool itk::FixedArray< TValue, VLength >::operator== ( const FixedArray< TValue, 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.

Referenced by itk::Point< CoordinateType, VPointDimension >::operator==().

◆ operator[]() [1/2]

template<typename TValue, unsigned int VLength = 3>

ITK_GCC_PRAGMA_PUSH ITK_GCC_SUPPRESS_Warray_bounds constexpr reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned int index )

inlineconstexpr

Allow the FixedArray to be indexed normally. No bounds checking is done.

Definition at line 290 of file itkFixedArray.h.

Referenced by itk::RGBAPixel< T >::GetAlpha(), itk::RGBAPixel< T >::GetBlue(), itk::RGBAPixel< T >::GetGreen(), itk::RGBAPixel< T >::GetNthComponent(), itk::RGBAPixel< T >::GetRed(), itk::RGBAPixel< T >::Set(), itk::RGBAPixel< T >::SetAlpha(), itk::RGBAPixel< T >::SetBlue(), itk::RGBAPixel< T >::SetGreen(), itk::RGBAPixel< T >::SetNthComponent(), and itk::RGBAPixel< T >::SetRed().

◆ operator[]() [2/2]

template<typename TValue, unsigned int VLength = 3>

const_reference itk::FixedArray< TValue, VLength >::operator[] ( unsigned int index ) const

inlineconstexpr

Allow the FixedArray to be indexed normally. No bounds checking is done.

Definition at line 295 of file itkFixedArray.h.

◆ rBegin() [1/2]

template<typename TValue, unsigned int VLength = 3>

ReverseIterator itk::FixedArray< TValue, VLength >::rBegin ( )

Get a begin ReverseIterator.

◆ rBegin() [2/2]

template<typename TValue, unsigned int VLength = 3>

ConstReverseIterator itk::FixedArray< TValue, VLength >::rBegin ( ) const

Get a begin ConstReverseIterator.

◆ rbegin() [1/2]

template<typename TValue, unsigned int VLength = 3>

reverse_iterator itk::FixedArray< TValue, VLength >::rbegin ( )

inline

Definition at line 404 of file itkFixedArray.h.

◆ rbegin() [2/2]

template<typename TValue, unsigned int VLength = 3>

const_reverse_iterator itk::FixedArray< TValue, VLength >::rbegin ( ) const

inlinenodiscard

Definition at line 416 of file itkFixedArray.h.

◆ rEnd() [1/2]

template<typename TValue, unsigned int VLength = 3>

ReverseIterator itk::FixedArray< TValue, VLength >::rEnd ( )

Get an end ReverseIterator.

◆ rEnd() [2/2]

template<typename TValue, unsigned int VLength = 3>

ConstReverseIterator itk::FixedArray< TValue, VLength >::rEnd ( ) const

Get an end ConstReverseIterator.

◆ rend() [1/2]

template<typename TValue, unsigned int VLength = 3>

reverse_iterator itk::FixedArray< TValue, VLength >::rend ( )

inline

Definition at line 422 of file itkFixedArray.h.

◆ rend() [2/2]

template<typename TValue, unsigned int VLength = 3>

const_reverse_iterator itk::FixedArray< TValue, VLength >::rend ( ) const

inlinenodiscard

Definition at line 434 of file itkFixedArray.h.

◆ SetElement()

template<typename TValue, unsigned int VLength = 3>

ITK_GCC_PRAGMA_POP void itk::FixedArray< TValue, VLength >::SetElement	(	unsigned int	index,
		const_reference	value )

inline

Set/Get element methods are more convenient in wrapping languages

Definition at line 304 of file itkFixedArray.h.

◆ Size()

template<typename TValue, unsigned int VLength = 3>

SizeType itk::FixedArray< TValue, VLength >::Size ( ) const

nodiscard

Size of the container.

◆ size()

template<typename TValue, unsigned int VLength = 3>

SizeType itk::FixedArray< TValue, VLength >::size ( ) const

inlinenodiscardconstexpr

Definition at line 444 of file itkFixedArray.h.

◆ swap()

template<typename TValue, unsigned int VLength = 3>

void itk::FixedArray< TValue, VLength >::swap ( FixedArray< TValue, VLength > & other )

inlinenoexcept

Definition at line 454 of file itkFixedArray.h.

Member Data Documentation

◆ Dimension

template<typename TValue, unsigned int VLength = 3>

unsigned int itk::FixedArray< TValue, VLength >::Dimension = VLength

staticconstexpr

Dimension constant

Definition at line 60 of file itkFixedArray.h.

◆ Length

template<typename TValue, unsigned int VLength = 3>

unsigned int itk::FixedArray< TValue, VLength >::Length = VLength

staticconstexpr

Length constant

Definition at line 57 of file itkFixedArray.h.

◆ m_InternalArray

template<typename TValue, unsigned int VLength = 3>

CArray itk::FixedArray< TValue, VLength >::m_InternalArray

private

Internal C array representation.

Definition at line 461 of file itkFixedArray.h.

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

itkFixedArray.h

Detailed Description

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Member Typedef Documentation

◆ CArray

◆ const_iterator

◆ const_pointer

◆ const_reference

◆ const_reverse_iterator

◆ ConstIterator

◆ Iterator

◆ iterator

◆ pointer

◆ reference

◆ reverse_iterator

◆ SizeType

◆ value_type

◆ ValueType

Constructor & Destructor Documentation

◆ FixedArray() [1/6]

◆ FixedArray() [2/6]

◆ FixedArray() [3/6]

◆ FixedArray() [4/6]

◆ FixedArray() [5/6]

◆ FixedArray() [6/6]

Member Function Documentation

◆ Begin() [1/2]

◆ Begin() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cbegin()

◆ cend()

◆ crbegin()

◆ crend()

◆ data() [1/2]

◆ data() [2/2]

◆ End() [1/2]

◆ End() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ Fill()

◆ Filled()

◆ GetDataPointer() [1/2]

◆ GetDataPointer() [2/2]

◆ GetElement()

◆ ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ rBegin() [1/2]

◆ rBegin() [2/2]

◆ rbegin() [1/2]

◆ rbegin() [2/2]

◆ rEnd() [1/2]

◆ rEnd() [2/2]

◆ rend() [1/2]

◆ rend() [2/2]

◆ SetElement()

◆ Size()

◆ size()

◆ swap()

Member Data Documentation

◆ Dimension

◆ Length

◆ m_InternalArray