ITK
6.0.0
Insight Toolkit
|
#include <itkFixedArray.h>
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.
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<>.
Definition at line 53 of file itkFixedArray.h.
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 | 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) | |
itkLegacyMacro (ReverseIterator rBegin();) itkLegacyMacro(ConstReverseIterator rBegin() const | |
itkLegacyMacro (ReverseIterator rEnd();) itkLegacyMacro(ConstReverseIterator rEnd() const | |
template<typename TFixedArrayValueType > | |
FixedArray & | operator= (const FixedArray< TFixedArrayValueType, VLength > &r) |
FixedArray & | operator= (const ValueType r[VLength]) |
bool | operator== (const FixedArray &r) const |
reverse_iterator | rbegin () |
const_reverse_iterator | rbegin () const |
reverse_iterator | rend () |
const_reverse_iterator | rend () const |
SizeType | Size () const |
constexpr SizeType | size () const |
void | swap (FixedArray &other) |
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 |
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.
using itk::FixedArray< TValue, VLength >::const_iterator = const ValueType * |
using itk::FixedArray< TValue, VLength >::const_pointer = const ValueType * |
A const pointer to the ValueType.
Definition at line 172 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::const_reference = const ValueType & |
A const reference to the ValueType.
Definition at line 178 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::const_reverse_iterator = std::reverse_iterator<const_iterator> |
Definition at line 188 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::ConstIterator = const ValueType * |
A const iterator through the array.
Definition at line 72 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::Iterator = ValueType * |
An iterator through the array.
Definition at line 69 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::iterator = ValueType * |
The return type of the non-const overloads of begin() and end().
Definition at line 181 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::pointer = ValueType * |
A pointer to the ValueType.
Definition at line 169 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::reference = ValueType & |
A reference to the ValueType.
Definition at line 175 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::reverse_iterator = std::reverse_iterator<iterator> |
Definition at line 186 of file itkFixedArray.h.
using itk::FixedArray< TValue, VLength >::SizeType = unsigned int |
Definition at line 190 of file itkFixedArray.h.
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.
|
default |
Default-constructor.
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.
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.
|
inlineexplicit |
Explicit constructor for std::array.
Definition at line 208 of file itkFixedArray.h.
|
inline |
Constructor to initialize a fixed array from another of any data type
Definition at line 215 of file itkFixedArray.h.
References itk::FixedArray< TValue, VLength >::cbegin().
|
inline |
Definition at line 226 of file itkFixedArray.h.
Iterator itk::FixedArray< TValue, VLength >::Begin | ( | ) |
Get an Iterator for the beginning of the FixedArray.
Referenced by itk::CopyMeshToMeshPoints(), and itk::DTITubeSpatialObjectPoint< TPointDimension >::SetTensorMatrix().
ConstIterator itk::FixedArray< TValue, VLength >::Begin | ( | ) | const |
Get a ConstIterator for the beginning of the FixedArray.
|
inlineconstexprnoexcept |
Definition at line 351 of file itkFixedArray.h.
|
inlineconstexprnoexcept |
Definition at line 345 of file itkFixedArray.h.
|
inlineconstexprnoexcept |
Definition at line 339 of file itkFixedArray.h.
Referenced by itk::FixedArray< TValue, VLength >::FixedArray(), and itk::FixedArray< TValue, VLength >::operator=().
|
inlineconstexprnoexcept |
Definition at line 357 of file itkFixedArray.h.
|
inline |
Definition at line 381 of file itkFixedArray.h.
|
inline |
Definition at line 399 of file itkFixedArray.h.
|
inline |
Definition at line 299 of file itkFixedArray.h.
|
inline |
Definition at line 305 of file itkFixedArray.h.
Iterator itk::FixedArray< TValue, VLength >::End | ( | ) |
Get an Iterator for the end of the FixedArray.
Referenced by itk::DTITubeSpatialObjectPoint< TPointDimension >::SetTensorMatrix().
ConstIterator itk::FixedArray< TValue, VLength >::End | ( | ) | const |
Get a ConstIterator for the end of the FixedArray.
|
inlineconstexprnoexcept |
Definition at line 369 of file itkFixedArray.h.
|
inlineconstexprnoexcept |
Definition at line 363 of file itkFixedArray.h.
void itk::FixedArray< TValue, VLength >::Fill | ( | const ValueType & | ) |
Set all the elements of the container to the input value.
Referenced by 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().
|
inlinestaticconstexpr |
Return an FixedArray with the given value assigned to all elements.
Definition at line 437 of file itkFixedArray.h.
|
inline |
Return a pointer to the data.
Definition at line 287 of file itkFixedArray.h.
Referenced by itk::Accessor::RGBToVectorPixelAccessor< T >::Get(), itk::Accessor::VectorToRGBPixelAccessor< T >::Get(), itk::MetaArrayWriter::SetInput(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::SetOutputPixel(), itk::ImageBase< VImageDimension >::TransformLocalVectorToPhysicalVector(), itk::GradientRecursiveGaussianImageFilter< TInputImage, TOutputImage >::TransformOutputPixel(), and itk::ImageBase< VImageDimension >::TransformPhysicalVectorToLocalVector().
|
inline |
Definition at line 293 of file itkFixedArray.h.
|
inline |
Set/Get element methods are more convenient in wrapping languages
Definition at line 279 of file itkFixedArray.h.
itk::FixedArray< TValue, VLength >::ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION | ( | FixedArray< TValue, VLength > | ) |
itk::FixedArray< TValue, VLength >::itkLegacyMacro | ( | ReverseIterator rBegin(); | ) | const |
Get a begin ReverseIterator. Get a begin ConstReverseIterator.
itk::FixedArray< TValue, VLength >::itkLegacyMacro | ( | ReverseIterator rEnd(); | ) | const |
Get an end ReverseIterator. Get an end ConstReverseIterator.
|
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 239 of file itkFixedArray.h.
References itk::FixedArray< TValue, VLength >::cbegin().
FixedArray & itk::FixedArray< TValue, VLength >::operator= | ( | const ValueType | r[VLength] | ) |
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.
|
inlineconstexpr |
Allow the FixedArray to be indexed normally. No bounds checking is done.
Definition at line 267 of file itkFixedArray.h.
|
inlineconstexpr |
Allow the FixedArray to be indexed normally. No bounds checking is done.
Definition at line 268 of file itkFixedArray.h.
|
inline |
Definition at line 375 of file itkFixedArray.h.
|
inline |
Definition at line 387 of file itkFixedArray.h.
|
inline |
Definition at line 393 of file itkFixedArray.h.
|
inline |
Definition at line 405 of file itkFixedArray.h.
|
inline |
Set/Get element methods are more convenient in wrapping languages
Definition at line 274 of file itkFixedArray.h.
SizeType itk::FixedArray< TValue, VLength >::Size | ( | ) | const |
Size of the container.
|
inlineconstexpr |
Definition at line 415 of file itkFixedArray.h.
|
inline |
Definition at line 425 of file itkFixedArray.h.
References itk::FixedArray< TValue, VLength >::m_InternalArray, and itk::swap().
Referenced by itk::swap().
|
staticconstexpr |
Dimension constant
Definition at line 60 of file itkFixedArray.h.
|
staticconstexpr |
Length constant
Definition at line 57 of file itkFixedArray.h.
|
private |
Internal C array representation.
Definition at line 432 of file itkFixedArray.h.
Referenced by itk::FixedArray< TValue, VLength >::swap().