VTK  9.3.0
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
57 #ifndef vtkGenericDataArray_h
58 #define vtkGenericDataArray_h
59 
60 #include "vtkDataArray.h"
61 
62 #include "vtkCompiler.h" // for VTK_USE_EXTERN_TEMPLATE
64 #include "vtkSmartPointer.h"
65 #include "vtkTypeTraits.h"
66 
67 #include <cassert>
68 
69 VTK_ABI_NAMESPACE_BEGIN
70 template <class DerivedT, class ValueTypeT>
72 {
74 
75 public:
76  typedef ValueTypeT ValueType;
78 
82  enum
83  {
85  };
86 
91 
99  inline ValueType GetValue(vtkIdType valueIdx) const
100  {
101  return static_cast<const DerivedT*>(this)->GetValue(valueIdx);
102  }
103 
112  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
113  {
114  static_cast<DerivedT*>(this)->SetValue(valueIdx, value);
115  }
116 
125  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
126  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
127  {
128  static_cast<const DerivedT*>(this)->GetTypedTuple(tupleIdx, tuple);
129  }
130 
139  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
140  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
141  {
142  static_cast<DerivedT*>(this)->SetTypedTuple(tupleIdx, tuple);
143  }
144 
150  ValueType GetTypedComponent(vtkIdType tupleIdx, int compIdx) const VTK_EXPECTS(0 <= tupleIdx &&
151  tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents())
152  {
153  return static_cast<const DerivedT*>(this)->GetTypedComponent(tupleIdx, compIdx);
154  }
155 
161  void SetTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType value)
162  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
163  VTK_EXPECTS(0 <= compIdx && compIdx < GetNumberOfComponents())
164  {
165  static_cast<DerivedT*>(this)->SetTypedComponent(tupleIdx, compIdx, value);
166  }
167 
169 
173  void* GetVoidPointer(vtkIdType valueIdx) override;
175  void SetVoidArray(void*, vtkIdType, int) override;
176  void SetVoidArray(void*, vtkIdType, int, int) override;
177  void SetArrayFreeFunction(void (*callback)(void*)) override;
178  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
179  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
181 
188  void RemoveTuple(vtkIdType tupleIdx) override;
189 
194 
199 
203  void InsertTypedTuple(vtkIdType tupleIdx, const ValueType* t);
204 
209 
214  void InsertTypedComponent(vtkIdType tupleIdx, int compIdx, ValueType val);
215 
217 
229  ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
230  void GetValueRange(ValueType range[2], int comp);
233 
239  void GetValueRange(ValueType range[2]) { this->GetValueRange(range, 0); }
240 
247  ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
248  void GetFiniteValueRange(ValueType range[2], int comp);
251  void GetFiniteValueRange(ValueType range[2]) { this->GetFiniteValueRange(range, 0); }
258  vtkIdType Capacity() { return this->Size; }
259 
263  virtual void FillTypedComponent(int compIdx, ValueType value);
264 
268  virtual void FillValue(ValueType value);
269 
270  int GetDataType() const override;
271  int GetDataTypeSize() const override;
272  bool HasStandardMemoryLayout() const override;
273  vtkTypeBool Allocate(vtkIdType size, vtkIdType ext = 1000) override;
274  vtkTypeBool Resize(vtkIdType numTuples) override;
275  void SetNumberOfComponents(int num) override;
276  void SetNumberOfTuples(vtkIdType number) override;
277  void Initialize() override;
278  void Squeeze() override;
279  void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override;
280  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
281  // using Superclass::SetTuple;
282  void SetTuple(vtkIdType tupleIdx, const float* tuple) override
283  {
284  this->Superclass::SetTuple(tupleIdx, tuple);
285  }
286  void SetTuple(vtkIdType tupleIdx, const double* tuple) override
287  {
288  this->Superclass::SetTuple(tupleIdx, tuple);
289  }
290 
292  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;
293  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
294  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
295  // using Superclass::InsertTuples;
297  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override
298  {
299  this->Superclass::InsertTuples(dstStart, n, srcStart, source);
300  }
301 
302  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override;
303  void InsertTuple(vtkIdType tupleIdx, const float* source) override;
304  void InsertTuple(vtkIdType tupleIdx, const double* source) override;
305  void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
307  vtkIdType InsertNextTuple(const float* tuple) override;
308  vtkIdType InsertNextTuple(const double* tuple) override;
309  void GetTuples(vtkIdList* tupleIds, vtkAbstractArray* output) override;
310  void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output) override;
311  double* GetTuple(vtkIdType tupleIdx) override;
312  void GetTuple(vtkIdType tupleIdx, double* tuple) override;
314  double* weights) override;
315  void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray* source1,
316  vtkIdType srcTupleIdx2, vtkAbstractArray* source2, double t) override;
317  void SetComponent(vtkIdType tupleIdx, int compIdx, double value) override;
318  double GetComponent(vtkIdType tupleIdx, int compIdx) override;
319  void SetVariantValue(vtkIdType valueIdx, vtkVariant value) override;
321  void InsertVariantValue(vtkIdType valueIdx, vtkVariant value) override;
324  void LookupValue(vtkVariant value, vtkIdList* valueIds) override;
325  virtual void LookupTypedValue(ValueType value, vtkIdList* valueIds);
326  void ClearLookup() override;
327  void DataChanged() override;
328  void FillComponent(int compIdx, double value) override;
330 
331 protected:
334 
340  inline bool AllocateTuples(vtkIdType numTuples)
341  {
342  return static_cast<DerivedT*>(this)->AllocateTuples(numTuples);
343  }
344 
350  inline bool ReallocateTuples(vtkIdType numTuples)
351  {
352  return static_cast<DerivedT*>(this)->ReallocateTuples(numTuples);
353  }
354 
355  // This method resizes the array if needed so that the given tuple index is
356  // valid/accessible.
358 
367  ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
368 
377  ValueType range[2], int comp, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
378 
386  ValueType* ranges, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
387 
393  ValueType range[2], const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
394 
402  ValueType* ranges, const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
403 
409  ValueType range[2], const unsigned char* ghosts, unsigned char ghostsToSkip = 0xff);
410 
411  std::vector<double> LegacyTuple;
412  std::vector<ValueType> LegacyValueRange;
413  std::vector<ValueType> LegacyValueRangeFull;
414 
416 
417 private:
418  vtkGenericDataArray(const vtkGenericDataArray&) = delete;
419  void operator=(const vtkGenericDataArray&) = delete;
420 };
421 VTK_ABI_NAMESPACE_END
422 
423 // these predeclarations are needed before the .txx include for MinGW
424 namespace vtkDataArrayPrivate
425 {
426 VTK_ABI_NAMESPACE_BEGIN
427 template <typename A, typename R, typename T>
428 bool DoComputeScalarRange(A*, R*, T, const unsigned char* ghosts, unsigned char ghostsToSkip);
429 template <typename A, typename R>
431  A*, R[2], AllValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
432 template <typename A, typename R>
434  A*, R[2], FiniteValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
435 VTK_ABI_NAMESPACE_END
436 } // namespace vtkDataArrayPrivate
437 
438 #include "vtkGenericDataArray.txx"
439 
440 // Adds an implementation of NewInstanceInternal() that returns an AoS
441 // (unmapped) VTK array, if possible. This allows the pipeline to copy and
442 // propagate the array when the array data is not modifiable. Use this in
443 // combination with vtkAbstractTypeMacro or vtkAbstractTemplateTypeMacro
444 // (instead of vtkTypeMacro) to avoid adding the default NewInstance
445 // implementation.
446 #define vtkAOSArrayNewInstanceMacro(thisClass) \
447 protected: \
448  vtkObjectBase* NewInstanceInternal() const override \
449  { \
450  if (vtkDataArray* da = vtkDataArray::CreateDataArray(thisClass::VTK_DATA_TYPE)) \
451  { \
452  return da; \
453  } \
454  return thisClass::New(); \
455  } \
456  \
457 public:
458 
459 #endif
460 
461 // This portion must be OUTSIDE the include blockers. This is used to tell
462 // libraries other than vtkCommonCore that instantiations of
463 // the GetValueRange lookups can be found externally. This prevents each library
464 // from instantiating these on their own.
465 // Additionally it helps hide implementation details that pull in system
466 // headers.
467 // We only provide these specializations for the 64-bit integer types, since
468 // other types can reuse the double-precision mechanism in
469 // vtkDataArray::GetRange without losing precision.
470 #ifdef VTK_GDA_VALUERANGE_INSTANTIATING
471 
472 // Forward declare necessary stuffs:
473 VTK_ABI_NAMESPACE_BEGIN
474 template <typename ValueType>
476 template <typename ValueType>
478 
479 #ifdef VTK_USE_SCALED_SOA_ARRAYS
480 template <typename ValueType>
482 #endif
483 VTK_ABI_NAMESPACE_END
484 
485 #define VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(ArrayType, ValueType) \
486  template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange( \
487  ArrayType*, ValueType*, vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
488  template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(ArrayType*, ValueType*, \
489  vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char); \
490  template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
491  vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
492  template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
493  vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char);
494 
495 #ifdef VTK_USE_SCALED_SOA_ARRAYS
496 
497 #define VTK_INSTANTIATE_VALUERANGE_VALUETYPE(ValueType) \
498  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
499  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType) \
500  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkScaledSOADataArrayTemplate<ValueType>, ValueType)
501 
502 #else // VTK_USE_SCALED_SOA_ARRAYS
503 
504 #define VTK_INSTANTIATE_VALUERANGE_VALUETYPE(ValueType) \
505  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
506  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType)
507 
508 #endif
509 
510 #elif defined(VTK_USE_EXTERN_TEMPLATE) // VTK_GDA_VALUERANGE_INSTANTIATING
511 
512 #ifndef VTK_GDA_TEMPLATE_EXTERN
513 #define VTK_GDA_TEMPLATE_EXTERN
514 #ifdef _MSC_VER
515 #pragma warning(push)
516 // The following is needed when the following is declared
517 // dllexport and is used from another class in vtkCommonCore
518 #pragma warning(disable : 4910) // extern and dllexport incompatible
519 #endif
520 
521 VTK_ABI_NAMESPACE_BEGIN
522 // Forward declare necessary stuffs:
523 template <typename ValueType>
525 template <typename ValueType>
527 
528 #ifdef VTK_USE_SCALED_SOA_ARRAYS
529 template <typename ValueType>
531 #endif
532 
533 VTK_ABI_NAMESPACE_END
534 
535 namespace vtkDataArrayPrivate
536 {
537 VTK_ABI_NAMESPACE_BEGIN
538 template <typename A, typename R, typename T>
539 bool DoComputeScalarRange(A*, R*, T, const unsigned char* ghosts, unsigned char ghostsToSkip);
540 template <typename A, typename R>
542  A*, R[2], AllValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
543 template <typename A, typename R>
545  A*, R[2], FiniteValues, const unsigned char* ghosts, unsigned char ghostsToSkip);
546 VTK_ABI_NAMESPACE_END
547 } // namespace vtkDataArrayPrivate
548 
549 #define VTK_DECLARE_VALUERANGE_ARRAYTYPE(ArrayType, ValueType) \
550  extern template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange( \
551  ArrayType*, ValueType*, vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
552  extern template VTKCOMMONCORE_EXPORT bool DoComputeScalarRange(ArrayType*, ValueType*, \
553  vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char); \
554  extern template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
555  vtkDataArrayPrivate::AllValues, const unsigned char*, unsigned char); \
556  extern template VTKCOMMONCORE_EXPORT bool DoComputeVectorRange(ArrayType*, ValueType[2], \
557  vtkDataArrayPrivate::FiniteValues, const unsigned char*, unsigned char);
558 
559 #ifdef VTK_USE_SCALED_SOA_ARRAYS
560 
561 #define VTK_DECLARE_VALUERANGE_VALUETYPE(ValueType) \
562  VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
563  VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType) \
564  VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkScaledSOADataArrayTemplate<ValueType>, ValueType)
565 
566 #else // VTK_USE_SCALED_SOA_ARRAYS
567 
568 #define VTK_DECLARE_VALUERANGE_VALUETYPE(ValueType) \
569  VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<ValueType>, ValueType) \
570  VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkSOADataArrayTemplate<ValueType>, ValueType)
571 
572 #endif
573 
574 namespace vtkDataArrayPrivate
575 {
576 VTK_ABI_NAMESPACE_BEGIN
577 // These are instantiated in vtkGenericDataArrayValueRange${i}.cxx
581 VTK_DECLARE_VALUERANGE_VALUETYPE(unsigned long long)
582 
583 // This is instantiated in vtkGenericDataArray.cxx
585 
586 // These are instantiated in vtkFloatArray.cxx, vtkDoubleArray.cxx, etc
600 
601 // These are instantiated in vtkSOADataArrayTemplateInstantiate${i}.cxx
615 
616 // These are instantiated in vtkScaledSOADataArrayTemplateInstantiate${i}.cxx
617 #ifdef VTK_USE_SCALED_SOA_ARRAYS
631 #endif // VTK_USE_SCALED_SOA_ARRAYS
632 
633 VTK_ABI_NAMESPACE_END
634 } // namespace vtkDataArrayPrivate
635 
636 #undef VTK_DECLARE_VALUERANGE_ARRAYTYPE
637 #undef VTK_DECLARE_VALUERANGE_VALUETYPE
638 
639 #ifdef _MSC_VER
640 #pragma warning(pop)
641 #endif
642 #endif // VTK_GDA_TEMPLATE_EXTERN
643 
644 #endif // VTK_GDA_VALUERANGE_INSTANTIATING
645 
646 // 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.
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
Definition: vtkDataArray.h:45
internal class used by vtkGenericDataArray to support LookupValue.
Base interface for all typed vtkDataArray subclasses.
ValueType * WritePointer(vtkIdType valueIdx, vtkIdType numValues)
Default implementation raises a runtime error.
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.
void DataChanged() override
Tell the array explicitly that the data has changed.
ValueType * GetValueRange(int comp)
Get the range of array values for the given component in the native data type.
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.
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.
void * WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override
Default implementation raises a runtime error.
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.
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 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...
double * GetTuple(vtkIdType tupleIdx) override
Get the data tuple at tupleIdx.
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.
ValueType * GetFiniteValueRange()
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
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.
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
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.
ValueType * GetPointer(vtkIdType valueIdx)
Default implementation raises a runtime error.
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 * GetVoidPointer(vtkIdType valueIdx) override
Default implementation raises a runtime error.
ValueType * GetFiniteValueRange(int comp)
These methods are analogous to the GetValueRange methods, except that the only consider finite values...
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...
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void Squeeze() override
Free any unnecessary memory.
bool EnsureAccessToTuple(vtkIdType tupleIdx)
vtkGenericDataArrayLookupHelper< SelfType > Lookup
std::vector< double > LegacyTuple
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
See documentation from parent class.
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.
ValueType * GetValueRange()
Get the range of array values for the 0th component in the native data type.
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.
void Initialize() override
Release storage and reset array to initial state.
list of point or cell ids
Definition: vtkIdList.h:23
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:53
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.
bool DoComputeScalarRange(A *, R *, T, const unsigned char *ghosts, unsigned char ghostsToSkip)
bool DoComputeVectorRange(A *, R[2], AllValues, const unsigned char *ghosts, unsigned char ghostsToSkip)
@ value
Definition: vtkX3D.h:220
@ range
Definition: vtkX3D.h:238
@ size
Definition: vtkX3D.h:253
Template defining traits of native types used by VTK.
Definition: vtkTypeTraits.h:23
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