vtkGenericDataArray Concept Methods

These signatures must be reimplemented in subclasses as public, non-virtual methods. More...

Functions
ValueType	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::GetValue (vtkIdType valueIdx) const
	Get the value at valueIdx.
void	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::SetValue (vtkIdType valueIdx, ValueType value)
	Set the value at valueIdx to value.
void	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::GetTypedTuple (vtkIdType tupleIdx, ValueType *tuple) const
	Copy the tuple at tupleIdx into tuple.
void	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::SetTypedTuple (vtkIdType tupleIdx, const ValueType *tuple)
	Set this array's tuple at tupleIdx to the values in tuple.
ValueType	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::GetTypedComponent (vtkIdType tupleIdx, int compIdx) const
	Get component compIdx of the tuple at tupleIdx.
void	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::SetTypedComponent (vtkIdType tupleIdx, int compIdx, ValueType value)
	Set component compIdx of the tuple at tupleIdx to value.
bool	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::AllocateTuples (vtkIdType numTuples)
	Allocate space for numTuples.
bool	vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::ReallocateTuples (vtkIdType numTuples)
	Allocate space for numTuples.

Detailed Description

These signatures must be reimplemented in subclasses as public, non-virtual methods.

Ideally, they should be inlined and as efficient as possible to ensure the best performance possible.

Function Documentation

GetValue()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

ValueType vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::GetValue ( vtkIdType valueIdx ) const

inline

Get the value at valueIdx.

valueIdx assumes AOS ordering.

Note

GetTypedComponent is preferred over this method. It is faster for SOA arrays, and shows equivalent performance for AOS arrays when NumberOfComponents is known to the compiler (See vtkAssume.h).

Definition at line 106 of file vtkGenericDataArray.h.

SetValue()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

void vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::SetValue ( vtkIdType valueIdx, ValueType value )

inline

Set the value at valueIdx to value.

valueIdx assumes AOS ordering.

Note

SetTypedComponent is preferred over this method. It is faster for SOA arrays, and shows equivalent performance for AOS arrays when NumberOfComponents is known to the compiler (See vtkAssume.h).

Definition at line 118 of file vtkGenericDataArray.h.

GetTypedTuple()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

void vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::GetTypedTuple ( vtkIdType tupleIdx, ValueType * tuple ) const

inline

Copy the tuple at tupleIdx into tuple.

Note

GetTypedComponent is preferred over this method. The overhead of copying the tuple is significant compared to the more performant component-wise access methods, which typically optimize to raw memory access.

Definition at line 132 of file vtkGenericDataArray.h.

SetTypedTuple()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

void vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::SetTypedTuple ( vtkIdType tupleIdx, const ValueType * tuple )

inline

Set this array's tuple at tupleIdx to the values in tuple.

Note

SetTypedComponent is preferred over this method. The overhead of copying the tuple is significant compared to the more performant component-wise access methods, which typically optimize to raw memory access.

Definition at line 146 of file vtkGenericDataArray.h.

GetTypedComponent()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

ValueType vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::GetTypedComponent ( vtkIdType tupleIdx, int compIdx ) const

inline

Get component compIdx of the tuple at tupleIdx.

This is typically the fastest way to access array data.

Definition at line 157 of file vtkGenericDataArray.h.

SetTypedComponent()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

void vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::SetTypedComponent ( vtkIdType tupleIdx, int compIdx, ValueType value )

inline

Set component compIdx of the tuple at tupleIdx to value.

This is typically the fastest way to set array data.

Definition at line 169 of file vtkGenericDataArray.h.

AllocateTuples()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

bool vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::AllocateTuples ( vtkIdType numTuples )

inlineprotected

Allocate space for numTuples.

Old data is not preserved. If numTuples == 0, all data is freed.

Definition at line 363 of file vtkGenericDataArray.h.

ReallocateTuples()

template<class DerivedT, class ValueTypeT, int ArrayType = vtkArrayTypes::VTK_DATA_ARRAY>

bool vtkGenericDataArray< DerivedT, ValueTypeT, ArrayType >::ReallocateTuples ( vtkIdType numTuples )

inlineprotected

Allocate space for numTuples.

Old data is preserved. If numTuples == 0, all data is freed.

Definition at line 373 of file vtkGenericDataArray.h.