VTK  9.4.20250129
vtkAbstractArray.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
3//
65#ifndef vtkAbstractArray_h
66#define vtkAbstractArray_h
67
68#include "vtkCommonCoreModule.h" // For export macro
69#include "vtkIdList.h" // For InsertTuples
70#include "vtkObject.h"
71#include "vtkVariant.h" // for variant arguments
72#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
73
74VTK_ABI_NAMESPACE_BEGIN
76class vtkDataArray;
77class vtkIdList;
78class vtkIdTypeArray;
79class vtkInformation;
84class vtkVariantArray;
85
86class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkAbstractArray : public vtkObject
87{
88public:
90 void PrintSelf(ostream& os, vtkIndent indent) override;
91
95 void PrintValues(ostream& os);
96
105 virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext = 1000) = 0;
106
110 virtual void Initialize() = 0;
111
116 virtual int GetDataType() const = 0;
117
119
124 virtual int GetDataTypeSize() const = 0;
125 static int GetDataTypeSize(int type);
127
135 virtual int GetElementComponentSize() const = 0;
136
138
142 vtkSetClampMacro(NumberOfComponents, int, 1, VTK_INT_MAX);
143 int GetNumberOfComponents() const { return this->NumberOfComponents; }
145
149 void SetComponentName(vtkIdType component, const char* name);
150
155 const char* GetComponentName(vtkIdType component) const;
156
160 bool HasAComponentName() const;
161
167
175 virtual void SetNumberOfTuples(vtkIdType numTuples) = 0;
176
184 virtual bool SetNumberOfValues(vtkIdType numValues);
185
189 vtkIdType GetNumberOfTuples() const { return (this->MaxId + 1) / this->NumberOfComponents; }
190
198 inline vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
199
206 virtual void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) = 0;
207
213 virtual void InsertTuple(
214 vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) = 0;
215
221 virtual void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) = 0;
222
229 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) = 0;
230
236 virtual void InsertTuples(
237 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) = 0;
238
245
251 virtual void GetTuples(vtkIdList* tupleIds, vtkAbstractArray* output);
252
258 virtual void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output);
259
266 virtual bool HasStandardMemoryLayout() const;
267
275 virtual void* GetVoidPointer(vtkIdType valueIdx) = 0;
276
285 virtual void DeepCopy(vtkAbstractArray* da);
286
294 virtual void InterpolateTuple(
295 vtkIdType dstTupleIdx, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) = 0;
296
305 virtual void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1,
306 vtkAbstractArray* source1, vtkIdType srcTupleIdx2, vtkAbstractArray* source2, double t) = 0;
307
313 virtual void Squeeze() = 0;
314
324 virtual vtkTypeBool Resize(vtkIdType numTuples) = 0;
325
327
330 void Reset()
331 {
332 this->MaxId = -1;
333 this->DataChanged();
334 }
336
340 vtkIdType GetSize() const { return this->Size; }
341
345 vtkIdType GetMaxId() const { return this->MaxId; }
346
348 {
352 VTK_DATA_ARRAY_USER_DEFINED
353 };
354
356
373 virtual void SetVoidArray(
374 void* vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save)) = 0;
375 virtual void SetVoidArray(void* array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
376 {
377 this->SetVoidArray(array, size, save);
378 }
380
387 virtual void SetArrayFreeFunction(void (*callback)(void*)) = 0;
388
394 virtual void ExportToVoidPointer(void* out_ptr);
395
404 virtual unsigned long GetActualMemorySize() const = 0;
405
407
410 vtkSetStringMacro(Name);
411 vtkGetStringMacro(Name);
413
417 virtual const char* GetDataTypeAsString() const
418 {
419 return vtkImageScalarTypeNameMacro(this->GetDataType());
420 }
421
432 static vtkAbstractArray* CreateArray(int dataType);
433
438 virtual int IsNumeric() const = 0;
439
443 virtual bool IsIntegral() const;
444
451
458 virtual vtkIdType GetDataSize() const
459 {
460 return this->GetNumberOfComponents() * this->GetNumberOfTuples();
461 }
462
464
471 virtual vtkIdType LookupValue(vtkVariant value) = 0;
472 virtual void LookupValue(vtkVariant value, vtkIdList* valueIds) = 0;
474
479 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues());
480
485 virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)
486 VTK_EXPECTS(0 <= valueIdx) = 0;
487
492 virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)
493 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues()) = 0;
494
503 virtual void DataChanged() = 0;
504
510 virtual void ClearLookup() = 0;
511
564 virtual void GetProminentComponentValues(int comp, vtkVariantArray* values,
565 double uncertainty = 1.e-6, double minimumProminence = 1.e-3);
566
567 // TODO: Implement these lookup functions also.
568 // virtual void LookupRange(vtkVariant min, vtkVariant max, vtkIdList* ids,
569 // bool includeMin = true, bool includeMax = true) = 0;
570 // virtual void LookupGreaterThan(vtkVariant min, vtkIdList* ids, bool includeMin = false) = 0;
571 // virtual void LookupLessThan(vtkVariant max, vtkIdList* ids, bool includeMax = false) = 0;
572
583 bool HasInformation() const { return this->Information != nullptr; }
584
596 virtual int CopyInformation(vtkInformation* infoFrom, vtkTypeBool deep = 1);
597
603
617
631
635 void Modified() override;
636
643
652
653 // Deprecated. Use vtkAbstractArray::MaxDiscreteValues instead.
654 enum
655 {
656 MAX_DISCRETE_VALUES = 32
657 };
658
660
664 vtkGetMacro(MaxDiscreteValues, unsigned int);
665 vtkSetMacro(MaxDiscreteValues, unsigned int);
667
668 enum
669 {
670 AbstractArray = 0,
678
679 DataArrayTemplate = AoSDataArrayTemplate
680 };
681
686 virtual int GetArrayType() const { return AbstractArray; }
687
691 const char* GetArrayTypeAsString() const;
692
693protected:
694 // Construct object with default tuple dimension (number of components) of 1.
697
704
716 virtual void UpdateDiscreteValueSet(double uncertainty, double minProminence);
717
718 vtkIdType Size; // allocated size of data
719 vtkIdType MaxId; // maximum index inserted thus far
720 int NumberOfComponents; // the number of components per tuple
721
722 // maximum number of prominent values before array is considered continuous.
723 unsigned int MaxDiscreteValues;
724
725 char* Name;
726
727 bool RebuildArray; // whether to rebuild the fast lookup data structure.
728
730
731 class vtkInternalComponentNames;
732 vtkInternalComponentNames* ComponentNames; // names for each component
733
734private:
735 vtkAbstractArray(const vtkAbstractArray&) = delete;
736 void operator=(const vtkAbstractArray&) = delete;
737};
738
740
745template <typename ArrayT>
747{
748 inline ArrayT* operator()(vtkAbstractArray* array) { return ArrayT::SafeDownCast(array); }
749};
751
769template <typename ArrayT>
771{
772 // The default vtkArrayDownCast_impl struct uses SafeDownCast, but is
773 // specialized for arrays that support FastDownCast.
774 return vtkArrayDownCast_impl<ArrayT>()(array);
775}
776
777VTK_ABI_NAMESPACE_END
778
780
784#define vtkArrayDownCast_FastCastMacro(ArrayT) \
785 template <> \
786 struct vtkArrayDownCast_impl<ArrayT> \
787 { \
788 inline ArrayT* operator()(vtkAbstractArray* array) \
789 { \
790 return ArrayT::FastDownCast(array); \
791 } \
792 }
794
796
802#define vtkArrayDownCast_TemplateFastCastMacro(ArrayT) \
803 template <typename ValueT> \
804 struct vtkArrayDownCast_impl<ArrayT<ValueT>> \
805 { \
806 inline ArrayT<ValueT>* operator()(vtkAbstractArray* array) \
807 { \
808 return ArrayT<ValueT>::FastDownCast(array); \
809 } \
810 }
812#endif
Abstract superclass for all arrays.
virtual void GetTuples(vtkIdList *tupleIds, vtkAbstractArray *output)
Given a list of tuple ids, return an array of tuples.
bool HasInformation() const
Inquire if this array has an instance of vtkInformation already associated with it.
const char * GetArrayTypeAsString() const
Get the name for the array type as string.
virtual int IsNumeric() const =0
This method is here to make backward compatibility easier.
static vtkInformationInformationVectorKey * PER_FINITE_COMPONENT()
This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses,...
virtual void Initialize()=0
Release storage and reset array to initial state.
void PrintValues(ostream &os)
Print the array values to an ostream object.
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
vtkInformation * GetInformation()
Get an information object that can be used to annotate the array.
virtual int GetElementComponentSize() const =0
Return the size, in bytes, of the lowest-level element of an array.
virtual void SetInformation(vtkInformation *)
Set an information object that can be used to annotate the array.
virtual void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1, vtkAbstractArray *source1, vtkIdType srcTupleIdx2, vtkAbstractArray *source2, double t)=0
Insert the tuple at dstTupleIdx in this array to the tuple interpolated from the two tuple indices,...
virtual void UpdateDiscreteValueSet(double uncertainty, double minProminence)
Obtain the set of unique values taken on by each component of the array, as well as by the tuples of ...
virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
virtual unsigned long GetActualMemorySize() const =0
Return the memory in kibibytes (1024 bytes) consumed by this data array.
int GetNumberOfComponents() const
Set/Get the dimension (n) of the components.
vtkIdType GetSize() const
Return the size of the data.
unsigned int MaxDiscreteValues
vtkInternalComponentNames * ComponentNames
virtual vtkArrayIterator * NewIterator()=0
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
static int GetDataTypeSize(int type)
Return the size of the underlying data type.
virtual void SetVoidArray(void *vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save))=0
This method lets the user specify data to be held by the array.
void SetComponentName(vtkIdType component, const char *name)
Set the name for a component.
virtual vtkTypeBool Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
virtual vtkIdType GetDataSize() const
Returns the size of the data in DataTypeSize units.
static vtkAbstractArray * CreateArray(int dataType)
Creates an array for dataType where dataType is one of VTK_BIT, VTK_CHAR, VTK_UNSIGNED_CHAR,...
virtual vtkVariant GetVariantValue(vtkIdType valueIdx)
Retrieve value from the array as a variant.
vtkIdType GetMaxId() const
What is the maximum id currently in the array.
virtual void SetNumberOfTuples(vtkIdType numTuples)=0
Set the number of tuples (a component group) in the array.
static vtkInformationInformationVectorKey * PER_COMPONENT()
This key is used to hold a vector of COMPONENT_VALUES (and, for vtkDataArray subclasses,...
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 ClearLookup()=0
Delete the associated fast lookup data structure on this array, if it exists.
virtual int GetDataTypeSize() const =0
Return the size of the underlying data type.
static vtkInformationVariantVectorKey * DISCRETE_VALUES()
A key used to hold discrete values taken on either by the tuples of the array (when present in this->...
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...
virtual void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source)=0
Copy the tuples indexed in srcIds from the source array to the tuple locations starting at index dstS...
virtual void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdList *ptIndices, vtkAbstractArray *source, double *weights)=0
Set the tuple at dstTupleIdx in this array to the interpolated tuple value, given the ptIndices in th...
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkInformation * Information
void Reset()
Reset to an empty state, without freeing any memory.
virtual void SetArrayFreeFunction(void(*callback)(void *))=0
This method allows the user to specify a custom free function to be called when the array is dealloca...
int CopyComponentNames(vtkAbstractArray *da)
Copies the component names from the inputted array to the current array make sure that the current ar...
void Modified() override
Removes out-of-date PER_COMPONENT() and PER_FINITE_COMPONENT() values.
virtual void ExportToVoidPointer(void *out_ptr)
This method copies the array data to the void pointer specified by the user.
virtual void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source)=0
Copy n consecutive tuples starting at srcStart from the source array to this array,...
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
virtual void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
virtual bool HasStandardMemoryLayout() const
Returns true if this array uses the standard memory layout defined in the VTK user guide,...
virtual bool IsIntegral() const
This method will return true if and only if an array contains integer-valued data.
bool HasAComponentName() const
Returns if any component has had a name assigned.
static vtkInformationDoubleVectorKey * DISCRETE_VALUE_SAMPLE_PARAMETERS()
A key used to hold conditions under which cached discrete values were generated; the value is a 2-vec...
virtual void * GetVoidPointer(vtkIdType valueIdx)=0
Return a void pointer.
virtual void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray *output)
Get the tuples for the range of tuple ids specified (i.e., p1->p2 inclusive).
static vtkInformationIntegerKey * GUI_HIDE()
This key is a hint to end user interface that this array is internal and should not be shown to the e...
virtual int GetArrayType() const
Method for type-checking in FastDownCast implementations.
virtual vtkIdType LookupValue(vtkVariant value)=0
Return the value indices where a specific value appears.
virtual int GetDataType() const =0
Return the underlying data type.
~vtkAbstractArray() override
virtual void SetVoidArray(void *array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
This method lets the user specify data to be held by the array.
const char * GetComponentName(vtkIdType component) const
Get the component name for a given component.
virtual void LookupValue(vtkVariant value, vtkIdList *valueIds)=0
Return the value indices where a specific value appears.
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
virtual const char * GetDataTypeAsString() const
Get the name of a data type as a string.
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
virtual void Squeeze()=0
Free any unnecessary memory.
virtual void GetProminentComponentValues(int comp, vtkVariantArray *values, double uncertainty=1.e-6, double minimumProminence=1.e-3)
Populate the given vtkVariantArray with a set of distinct values taken on by the requested component ...
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
virtual int CopyInformation(vtkInformation *infoFrom, vtkTypeBool deep=1)
Copy information instance.
Abstract superclass to iterate over elements in an vtkAbstractArray.
abstract superclass for arrays of numeric data
list of point or cell ids
Definition vtkIdList.h:133
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition vtkIndent.h:108
Key for integer values in vtkInformation.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition vtkObject.h:162
An array holding vtkVariants.
A type representing the union of many types.
Definition vtkVariant.h:162
Implementation of vtkArrayDownCast.
ArrayT * operator()(vtkAbstractArray *array)
int vtkTypeBool
Definition vtkABI.h:64
ArrayT * vtkArrayDownCast(vtkAbstractArray *array)
vtkArrayDownCast is to be used by generic (e.g.
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition vtkType.h:315
#define VTK_INT_MAX
Definition vtkType.h:144
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_MARSHAL_EXCLUDE_REASON_IS_INTERNAL
#define VTK_EXPECTS(x)
#define VTK_MARSHALAUTO
#define VTK_MARSHALEXCLUDE(reason)
#define VTK_NEWINSTANCE