VTK  9.3.20240424
vtkGenericDataArray.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
166#ifndef vtkGenericDataArray_h
167#define vtkGenericDataArray_h
168
169#include "vtkDataArray.h"
170
171#include "vtkCompiler.h" // for VTK_USE_EXTERN_TEMPLATE
173#include "vtkSmartPointer.h"
174#include "vtkTypeTraits.h"
175
176#include <cassert>
177
178VTK_ABI_NAMESPACE_BEGIN
179template <class DerivedT, class ValueTypeT>
181{
183
184public:
185 typedef ValueTypeT ValueType;
187
191 enum
192 {
194 };
195
200
208 inline ValueType GetValue(vtkIdType valueIdx) const
209 {
210 return static_cast<const DerivedT*>(this)->GetValue(valueIdx);
211 }
212
220 void SetValue(vtkIdType valueIdx, ValueType value)
221 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
222 {
223 static_cast<DerivedT*>(this)->SetValue(valueIdx, value);
224 }
225
234 void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
235 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
236 {
237 static_cast<const DerivedT*>(this)->GetTypedTuple(tupleIdx, tuple);
238 }
239
248 void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
249 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
250 {
251 static_cast<DerivedT*>(this)->SetTypedTuple(tupleIdx, tuple);
252 }
253
259 ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const VTK_EXPECTS(0 <= tupleIdx &&
260 tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents())
261 {
262 return static_cast<const DerivedT*>(this)->GetTypedComponent(tupleIdx, compIdx);
263 }
264
270 void SetTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType value)
271 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
272 VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents())
273 {
274 static_cast<DerivedT*>(this)->SetTypedComponent(tupleIdx, compIdx, value);
275 }
276
278
282 void* GetVoidPointer(vtkIdType valueIdx) override;
284 void SetVoidArray(void*, vtkIdType, int) override;
285 void SetVoidArray(void*, vtkIdType, int, int) override;
286 void SetArrayFreeFunction(void (*callback)(void*)) override;
287 void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
290
297 void RemoveTuple(vtkIdType tupleIdx) override;
298
303
307 void InsertValue(vtkIdType valueIdx, ValueType value);
308
312 void InsertTypedTuple(vtkIdType tupleIdx, const ValueType* t);
313
318
323 void InsertTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType val);
324
326
338 ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
339 void GetValueRange(ValueType range[2], int comp);
342
348 void GetValueRange(ValueType range[2]) { this->GetValueRange(range, 0); }
349
356 ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
357 void GetFiniteValueRange(ValueType range[2], int comp);
360 void GetFiniteValueRange(ValueType range[2]) { this->GetFiniteValueRange(range, 0); }
367 vtkIdType Capacity() { return this->Size; }
368
372 virtual void FillTypedComponent(int compIdx, ValueType value);
373
377 virtual void FillValue(ValueType value);
378
379 int GetDataType() const override;
380 int GetDataTypeSize() const override;
381 bool HasStandardMemoryLayout() const override;
382 vtkTypeBool Allocate(vtkIdType size, vtkIdType ext = 1000) override;
383 vtkTypeBool Resize(vtkIdType numTuples) override;
384 void SetNumberOfComponents(int num) override;
385 void SetNumberOfTuples(vtkIdType number) override;
386 void Initialize() override;
387 void Squeeze() override;
388 void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override;
389 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
390 // using Superclass::SetTuple;
391 void SetTuple(vtkIdType tupleIdx, const float* tuple) override
392 {
393 this->Superclass::SetTuple(tupleIdx, tuple);
394 }
395 void SetTuple(vtkIdType tupleIdx, const double* tuple) override
396 {
397 this->Superclass::SetTuple(tupleIdx, tuple);
398 }
399
401 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
402 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
403 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
404 // using Superclass::InsertTuples;
406 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override
407 {
408 this->Superclass::InsertTuples(dstStart, n, srcStart, source);
409 }
410
411 void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override;
412 void InsertTuple(vtkIdType tupleIdx, const float* source) override;
413 void InsertTuple(vtkIdType tupleIdx, const double* source) override;
414 void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
416 vtkIdType InsertNextTuple(const float* tuple) override;
417 vtkIdType InsertNextTuple(const double* tuple) override;
418 void GetTuples(vtkIdList* tupleIds, vtkAbstractArray* output) override;
419 void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
420 double* GetTuple(vtkIdType tupleIdx) override;
421 void GetTuple(vtkIdType tupleIdx, double* tuple) override;
423 double* weights) override;
424 void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray* source1,
425 vtkIdType srcTupleIdx2, vtkAbstractArray* source2, double t) override;
426 void SetComponent(vtkIdType tupleIdx, int compIdx, double value) override;
427 double GetComponent(vtkIdType tupleIdx, int compIdx) override;
428 void SetVariantValue(vtkIdType valueIdx, vtkVariant value) override;
430 void InsertVariantValue(vtkIdType valueIdx, vtkVariant value) override;
433 void LookupValue(vtkVariant value, vtkIdList* valueIds) override;
434 virtual void LookupTypedValue(ValueType value, vtkIdList* valueIds);
435 void ClearLookup() override;
436 void DataChanged() override;
437 void FillComponent(int compIdx, double value) override;
439
440protected:
443
449 inline bool AllocateTuples(vtkIdType numTuples)
450 {
451 return static_cast<DerivedT*>(this)->AllocateTuples(numTuples);
452 }
453
459 inline bool ReallocateTuples(vtkIdType numTuples)
460 {
461 return static_cast<DerivedT*>(this)->ReallocateTuples(numTuples);
462 }
463
464 // This method resizes the array if needed so that the given tuple index is
465 // valid/accessible.
467
476 ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
477
486 ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
487
495 ValueType* ranges, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
496
502 ValueType range[2], const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
503
511 ValueType* ranges, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
512
518 ValueType range[2], const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
519
520 std::vector<double> LegacyTuple;
521 std::vector<ValueType> LegacyValueRange;
522 std::vector<ValueType> LegacyValueRangeFull;
523
525
526private:
528 void operator=(const vtkGenericDataArray&) = delete;
529};
530VTK_ABI_NAMESPACE_END
531
532// these predeclarations are needed before the .txx include for MinGW
533namespace vtkDataArrayPrivate
534{
535VTK_ABI_NAMESPACE_BEGIN
536template <typename A, typename R, typename T>
537VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(
538 A*, R*, T, const unsigned char* ghosts, unsigned char ghostsToSkip);
539template <typename A, typename R>
540VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(
541 A*, R[2], AllValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
542template <typename A, typename R>
543VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(
544 A*, R[2], FiniteValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
545VTK_ABI_NAMESPACE_END
546} // namespace vtkDataArrayPrivate
547
548#include "vtkGenericDataArray.txx"
549
550// Adds an implementation of NewInstanceInternal() that returns an AoS
551// (unmapped) VTK array, if possible. This allows the pipeline to copy and
552// propagate the array when the array data is not modifiable. Use this in
553// combination with vtkAbstractTypeMacro or vtkAbstractTemplateTypeMacro
554// (instead of vtkTypeMacro) to avoid adding the default NewInstance
555// implementation.
556#define vtkAOSArrayNewInstanceMacro(thisClass) \
557protected: \
558 vtkObjectBase* NewInstanceInternal() const override \
559 { \
560 if (vtkDataArray* da = vtkDataArray::CreateDataArray(thisClass::VTK_DATA_TYPE)) \
561 { \
562 return da; \
563 } \
564 return thisClass::New(); \
565 } \
566 \
567public:
568
569#endif
570
571// This portion must be OUTSIDE the include blockers. This is used to tell
572// libraries other than vtkCommonCore that instantiations of
573// the GetValueRange lookups can be found externally. This prevents each library
574// from instantiating these on their own.
575// Additionally it helps hide implementation details that pull in system
576// headers.
577// We only provide these specializations for the 64-bit integer types, since
578// other types can reuse the double-precision mechanism in
579// vtkDataArray::GetRange without losing precision.
580#ifdef VTK_GDA_VALUERANGE_INSTANTIATING
581
582// Forward declare necessary stuffs:
583VTK_ABI_NAMESPACE_BEGIN
584template <typename ValueType>
586template <typename ValueType>
588
589#ifdef VTK_USE_SCALED_SOA_ARRAYS
590template <typename ValueType>
592#endif
593VTK_ABI_NAMESPACE_END
594
595#define VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(ArrayType, ValueType) \
596 template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange( \
597 ArrayType*, ValueType*, vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
598 template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(ArrayType*, ValueType*, \
599 vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char); \
600 template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
601 vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
602 template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
603 vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char);
604
605#ifdef VTK_USE_SCALED_SOA_ARRAYS
606
607#define VTK_INSTANTIATE_VALUERANGE_VALUETYPE(ValueType) \
608 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
609 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType) \
610 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkScaledSOADataArrayTemplate<ValueType>, ValueType)
611
612#else // VTK_USE_SCALED_SOA_ARRAYS
613
614#define VTK_INSTANTIATE_VALUERANGE_VALUETYPE(ValueType) \
615 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
616 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType)
617
618#endif
619
620#elif defined(VTK_USE_EXTERN_TEMPLATE) // VTK_GDA_VALUERANGE_INSTANTIATING
621
622#ifndef VTK_GDA_TEMPLATE_EXTERN
623#define VTK_GDA_TEMPLATE_EXTERN
624#ifdef _MSC_VER
625#pragma warning(push)
626// The following is needed when the following is declared
627// dllexport and is used from another class in vtkCommonCore
628#pragma warning(disable : 4910) // extern and dllexport incompatible
629#endif
630
631VTK_ABI_NAMESPACE_BEGIN
632// Forward declare necessary stuffs:
633template <typename ValueType>
635template <typename ValueType>
637
638#ifdef VTK_USE_SCALED_SOA_ARRAYS
639template <typename ValueType>
641#endif
642
643VTK_ABI_NAMESPACE_END
644
645namespace vtkDataArrayPrivate
646{
647VTK_ABI_NAMESPACE_BEGIN
648template <typename A, typename R, typename T>
649VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(
650 A*, R*, T, const unsigned char* ghosts, unsigned char ghostsToSkip);
651template <typename A, typename R>
652VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(
653 A*, R[2], AllValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
654template <typename A, typename R>
655VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(
656 A*, R[2], FiniteValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
657VTK_ABI_NAMESPACE_END
658} // namespace vtkDataArrayPrivate
659
660#define VTK_DECLARE_VALUERANGE_ARRAYTYPE(ArrayType, ValueType) \
661 extern template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange( \
662 ArrayType*, ValueType*, vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
663 extern template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(ArrayType*, ValueType*, \
664 vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char); \
665 extern template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
666 vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
667 extern template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
668 vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char);
669
670#ifdef VTK_USE_SCALED_SOA_ARRAYS
671
672#define VTK_DECLARE_VALUERANGE_VALUETYPE(ValueType) \
673 VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
674 VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType) \
675 VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkScaledSOADataArrayTemplate<ValueType>, ValueType)
676
677#else // VTK_USE_SCALED_SOA_ARRAYS
678
679#define VTK_DECLARE_VALUERANGE_VALUETYPE(ValueType) \
680 VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
681 VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType)
682
683#endif
684
685namespace vtkDataArrayPrivate
686{
687VTK_ABI_NAMESPACE_BEGIN
688// These are instantiated in vtkGenericDataArrayValueRange${i}.cxx
692VTK_DECLARE_VALUERANGE_VALUETYPE(unsigned long long)
693
694// This is instantiated in vtkGenericDataArray.cxx
696
697// These are instantiated in vtkFloatArray.cxx, vtkDoubleArray.cxx, etc
711
712// These are instantiated in vtkSOADataArrayTemplateInstantiate${i}.cxx
726
727// These are instantiated in vtkScaledSOADataArrayTemplateInstantiate${i}.cxx
728#ifdef VTK_USE_SCALED_SOA_ARRAYS
742#endif // VTK_USE_SCALED_SOA_ARRAYS
743
744VTK_ABI_NAMESPACE_END
745} // namespace vtkDataArrayPrivate
746
747#undef VTK_DECLARE_VALUERANGE_ARRAYTYPE
748#undef VTK_DECLARE_VALUERANGE_VALUETYPE
749
750#ifdef _MSC_VER
751#pragma warning(pop)
752#endif
753#endif // VTK_GDA_TEMPLATE_EXTERN
754
755#endif // VTK_GDA_VALUERANGE_INSTANTIATING
756
757// VTK-HeaderTest-Exclude: vtkGenericDataArray.h
Array-Of-Structs implementation of vtkGenericDataArray.
Abstract superclass for all arrays.
int GetNumberOfComponents() const
Set/Get the dimension (n) of the components.
vtkIdType GetNumberOfTuples() const
Get the number of complete tuples (a component group) in the array.
virtual void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array.
virtual void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source)=0
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
Abstract superclass to iterate over elements in an vtkAbstractArray.
abstract superclass for arrays of numeric data
internal class used by vtkGenericDataArray to support LookupValue.
Base interface for all typed vtkDataArray subclasses.
vtkTypeBool Allocate(vtkIdType size, vtkIdType ext=1000) override
Allocate memory for this array.
virtual void FillValue(ValueType value)
Set all the values in array to value.
std::vector< ValueType > LegacyValueRange
void SetNumberOfComponents(int num) override
Set/Get the dimension (n) of the components.
ValueType * GetFiniteValueRange()
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
void DataChanged() override
Tell the array explicitly that the data has changed.
void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override
Insert value at the location specified by tupleIdx and compIdx.
void ComputeValueRange(ValueType range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Compute the range for a specific component.
vtkIdType LookupValue(vtkVariant value) override
Return the value indices where a specific value appears.
double GetComponent(vtkIdType tupleIdx, int compIdx) override
Return the data component at the location specified by tupleIdx and compIdx.
void InsertVariantValue(vtkIdType valueIdx, vtkVariant value) override
Insert a value into the array from a variant.
void SetTuple(vtkIdType tupleIdx, const double *tuple) override
Set the data tuple at tupleIdx.
std::vector< ValueType > LegacyValueRangeFull
void InsertTuple(vtkIdType tupleIdx, const float *source) override
Insert the data tuple at tupleIdx.
ValueType * GetPointer(vtkIdType valueIdx)
Default implementation raises a runtime error.
bool ComputeScalarValueRange(ValueType *ranges, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Computes the range for each component of an array, the length of ranges must be two times the number ...
void RemoveTuple(vtkIdType tupleIdx) override
Removes a tuple at the given index.
void InsertTypedTuple(vtkIdType tupleIdx, const ValueType *t)
Insert (memory allocation performed) the tuple t at tupleIdx.
void SetNumberOfTuples(vtkIdType number) override
Set the number of tuples (a component group) in the array.
bool ComputeFiniteScalarValueRange(ValueType *ranges, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Computes the range for each component of an array, the length of ranges must be two times the number ...
vtkTypeBool Resize(vtkIdType numTuples) override
Resize the array to the requested number of tuples and preserve data.
ValueType * WritePointer(vtkIdType valueIdx, vtkIdType numValues)
Default implementation raises a runtime error.
double * GetTuple(vtkIdType tupleIdx) override
Get the data tuple at tupleIdx.
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
See documentation from parent class.
void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source) override
See documentation from parent class.
vtkTemplateTypeMacro(SelfType, vtkDataArray)
void * GetVoidPointer(vtkIdType valueIdx) override
Default implementation raises a runtime error.
void FillComponent(int compIdx, double value) override
Fill a component of a data array with a specified value.
void GetValueRange(ValueType range[2], int comp)
Get the range of array values for the given component in the native data type.
void GetValueRange(ValueType range[2])
void GetFiniteValueRange(ValueType range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
void SetVoidArray(void *, vtkIdType, int, int) override
Default implementation raises a runtime error.
vtkIdType Capacity()
Return the capacity in typeof T units of the current array.
void SetVariantValue(vtkIdType valueIdx, vtkVariant value) override
Set a value in the array from a variant.
vtkVariant GetVariantValue(vtkIdType valueIdx) override
Retrieve value from the array as a variant.
void InsertTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType val)
Insert (memory allocation performed) the value at the specified tuple and component location.
void ClearLookup() override
Delete the associated fast lookup data structure on this array, if it exists.
void GetTuple(vtkIdType tupleIdx, double *tuple) override
Get the data tuple at tupleIdx by filling in a user-provided array, Make sure that your array is larg...
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
See documentation from parent class.
virtual void LookupTypedValue(ValueType value, vtkIdList *valueIds)
vtkIdType InsertNextTuple(const double *tuple) override
Insert the data tuple at the end of the array and return the tuple index at which the data was insert...
void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output) override
Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive).
void SetVoidArray(void *, vtkIdType, int) override
Default implementation raises a runtime error.
void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights) override
Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in th...
void GetValueRange(ValueType range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Get the range of array values for the given component in the native data type.
vtkIdType InsertNextTuple(const float *tuple) override
Insert the data tuple at the end of the array and return the tuple index at which the data was insert...
virtual vtkIdType LookupTypedValue(ValueType value)
virtual void FillTypedComponent(int compIdx, ValueType value)
Set component comp of all tuples to value.
bool HasStandardMemoryLayout() const override
Returns true if this array uses the standard memory layout defined in the VTK user guide,...
int GetDataTypeSize() const override
Return the size of the underlying data type.
void ComputeFiniteValueRange(ValueType range[2], int comp, const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Compute the range for a specific component.
ValueType * GetFiniteValueRange(int comp)
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
void SetArrayFreeFunction(void(*callback)(void *)) override
Default implementation raises a runtime error.
bool ComputeVectorValueRange(ValueType range[2], const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Returns true if the range was computed.
void GetFiniteValueRange(ValueType range[2], int comp)
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
bool ComputeFiniteVectorValueRange(ValueType range[2], const unsigned char *ghosts, unsigned char ghostsToSkip=0xff)
Returns true if the range was computed.
void SetTuple(vtkIdType tupleIdx, const float *tuple) override
Set the data tuple at tupleIdx.
~vtkGenericDataArray() override
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void LookupValue(vtkVariant value, vtkIdList *valueIds) override
Return the value indices where a specific value appears.
void InsertValue(vtkIdType valueIdx, ValueType value)
Insert data at a specified position in the array.
void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, vtkAbstractArray *source2, double t) override
Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices,...
void InsertTuple(vtkIdType tupleIdx, const double *source) override
Insert the data tuple at tupleIdx.
void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
See documentation from parent class.
void GetFiniteValueRange(ValueType range[2])
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
void Squeeze() override
Free any unnecessary memory.
bool EnsureAccessToTuple(vtkIdType tupleIdx)
vtkGenericDataArrayLookupHelper< SelfType > Lookup
std::vector< double > LegacyTuple
ValueType * GetValueRange(int comp)
Get the range of array values for the given component in the native data type.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
See documentation from parent class.
void * WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override
Default implementation raises a runtime error.
int GetDataType() const override
Return the underlying data type.
void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output) override
Given a list of tuple ids, return an array of tuples.
void SetComponent(vtkIdType tupleIdx, int compIdx, double value) override
Set the data component at the location specified by tupleIdx and compIdx to value.
vtkIdType InsertNextValue(ValueType value)
Insert data at the end of the array.
vtkIdType InsertNextTypedTuple(const ValueType *t)
Insert (memory allocation performed) the tuple onto the end of the array.
void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
See documentation from parent class.
ValueType * GetValueRange()
Get the range of array values for the 0th component in the native data type.
void Initialize() override
Release storage and reset array to initial state.
list of point or cell ids
Definition vtkIdList.h:133
Struct-Of-Arrays implementation of vtkGenericDataArray.
Struct-Of-Arrays implementation of vtkGenericDataArray with a scaling factor.
A type representing the union of many types.
Definition vtkVariant.h:162
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
void SetTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType value)
Set component compIdx of the tuple at tupleIdx to value.
ValueType GetValue(vtkIdType valueIdx) const
Get the value at valueIdx.
void SetTypedTuple(vtkIdType tupleIdx, const ValueType *tuple)
Set this array's tuple at tupleIdx to the values in tuple.
void GetTypedTuple(vtkIdType tupleIdx, ValueType *tuple) const
Copy the tuple at tupleIdx into tuple.
bool ReallocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const
Get component compIdx of the tuple at tupleIdx.
bool AllocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(A *, R *, T, const unsigned char *ghosts, unsigned char ghostsToSkip)
VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(A *, R[2], AllValues, const unsigned char *ghosts, unsigned char ghostsToSkip)
Template defining traits of native types used by VTK.
int vtkTypeBool
Definition vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define VTK_DECLARE_VALUERANGE_ARRAYTYPE(ArrayType, ValueType)
#define VTK_DECLARE_VALUERANGE_VALUETYPE(ValueType)
int vtkIdType
Definition vtkType.h:315
#define VTK_SIZEHINT(...)
#define VTK_EXPECTS(x)
#define VTK_NEWINSTANCE