VTK  9.3.20240617
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//
55#ifndef vtkAbstractArray_h
56#define vtkAbstractArray_h
57
58#include "vtkCommonCoreModule.h" // For export macro
59#include "vtkIdList.h" // For InsertTuples
60#include "vtkObject.h"
61#include "vtkVariant.h" // for variant arguments
62#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
63
64#include "vtk_nlohmannjson.h"
65#include VTK_NLOHMANN_JSON(json_fwd.hpp)
66
67VTK_ABI_NAMESPACE_BEGIN
69class vtkDataArray;
70class vtkIdList;
71class vtkIdTypeArray;
72class vtkInformation;
77class vtkVariantArray;
78
79class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkAbstractArray : public vtkObject
80{
81public:
83 void PrintSelf(ostream& os, vtkIndent indent) override;
84 void PrintValues(ostream& os);
85 nlohmann::json SerializeValues();
86
95 virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext = 1000) = 0;
96
100 virtual void Initialize() = 0;
101
106 virtual int GetDataType() const = 0;
107
109
114 virtual int GetDataTypeSize() const = 0;
115 static int GetDataTypeSize(int type);
117
125 virtual int GetElementComponentSize() const = 0;
126
128
132 vtkSetClampMacro(NumberOfComponents, int, 1, VTK_INT_MAX);
133 int GetNumberOfComponents() const { return this->NumberOfComponents; }
135
139 void SetComponentName(vtkIdType component, const char* name);
140
145 const char* GetComponentName(vtkIdType component) const;
146
150 bool HasAComponentName() const;
151
157
165 virtual void SetNumberOfTuples(vtkIdType numTuples) = 0;
166
174 virtual bool SetNumberOfValues(vtkIdType numValues);
175
179 vtkIdType GetNumberOfTuples() const { return (this->MaxId + 1) / this->NumberOfComponents; }
180
188 inline vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
189
196 virtual void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) = 0;
197
203 virtual void InsertTuple(
204 vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) = 0;
205
211 virtual void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) = 0;
212
219 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) = 0;
220
226 virtual void InsertTuples(
227 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) = 0;
228
235
241 virtual void GetTuples(vtkIdList* tupleIds, vtkAbstractArray* output);
242
248 virtual void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output);
249
256 virtual bool HasStandardMemoryLayout() const;
257
265 virtual void* GetVoidPointer(vtkIdType valueIdx) = 0;
266
275 virtual void DeepCopy(vtkAbstractArray* da);
276
284 virtual void InterpolateTuple(
285 vtkIdType dstTupleIdx, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) = 0;
286
295 virtual void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1,
296 vtkAbstractArray* source1, vtkIdType srcTupleIdx2, vtkAbstractArray* source2, double t) = 0;
297
303 virtual void Squeeze() = 0;
304
314 virtual vtkTypeBool Resize(vtkIdType numTuples) = 0;
315
317
320 void Reset()
321 {
322 this->MaxId = -1;
323 this->DataChanged();
324 }
326
330 vtkIdType GetSize() const { return this->Size; }
331
335 vtkIdType GetMaxId() const { return this->MaxId; }
336
338 {
342 VTK_DATA_ARRAY_USER_DEFINED
343 };
344
346
363 virtual void SetVoidArray(
364 void* vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save)) = 0;
365 virtual void SetVoidArray(void* array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
366 {
367 this->SetVoidArray(array, size, save);
368 }
370
377 virtual void SetArrayFreeFunction(void (*callback)(void*)) = 0;
378
384 virtual void ExportToVoidPointer(void* out_ptr);
385
394 virtual unsigned long GetActualMemorySize() const = 0;
395
397
400 vtkSetStringMacro(Name);
401 vtkGetStringMacro(Name);
403
407 virtual const char* GetDataTypeAsString() const
408 {
409 return vtkImageScalarTypeNameMacro(this->GetDataType());
410 }
411
422 static vtkAbstractArray* CreateArray(int dataType);
423
428 virtual int IsNumeric() const = 0;
429
433 virtual bool IsIntegral() const;
434
441
448 virtual vtkIdType GetDataSize() const
449 {
450 return this->GetNumberOfComponents() * this->GetNumberOfTuples();
451 }
452
454
461 virtual vtkIdType LookupValue(vtkVariant value) = 0;
462 virtual void LookupValue(vtkVariant value, vtkIdList* valueIds) = 0;
464
469 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues());
470
475 virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)
476 VTK_EXPECTS(0 <= valueIdx) = 0;
477
482 virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)
483 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues()) = 0;
484
493 virtual void DataChanged() = 0;
494
500 virtual void ClearLookup() = 0;
501
554 virtual void GetProminentComponentValues(int comp, vtkVariantArray* values,
555 double uncertainty = 1.e-6, double minimumProminence = 1.e-3);
556
557 // TODO: Implement these lookup functions also.
558 // virtual void LookupRange(vtkVariant min, vtkVariant max, vtkIdList* ids,
559 // bool includeMin = true, bool includeMax = true) = 0;
560 // virtual void LookupGreaterThan(vtkVariant min, vtkIdList* ids, bool includeMin = false) = 0;
561 // virtual void LookupLessThan(vtkVariant max, vtkIdList* ids, bool includeMax = false) = 0;
562
573 bool HasInformation() const { return this->Information != nullptr; }
574
586 virtual int CopyInformation(vtkInformation* infoFrom, vtkTypeBool deep = 1);
587
593
607
621
625 void Modified() override;
626
633
642
643 // Deprecated. Use vtkAbstractArray::MaxDiscreteValues instead.
644 enum
645 {
646 MAX_DISCRETE_VALUES = 32
647 };
648
650
654 vtkGetMacro(MaxDiscreteValues, unsigned int);
655 vtkSetMacro(MaxDiscreteValues, unsigned int);
657
658 enum
659 {
660 AbstractArray = 0,
668
669 DataArrayTemplate = AoSDataArrayTemplate
670 };
671
676 virtual int GetArrayType() const { return AbstractArray; }
677
681 const char* GetArrayTypeAsString() const;
682
683protected:
684 // Construct object with default tuple dimension (number of components) of 1.
687
694
706 virtual void UpdateDiscreteValueSet(double uncertainty, double minProminence);
707
708 vtkIdType Size; // allocated size of data
709 vtkIdType MaxId; // maximum index inserted thus far
710 int NumberOfComponents; // the number of components per tuple
711
712 // maximum number of prominent values before array is considered continuous.
713 unsigned int MaxDiscreteValues;
714
715 char* Name;
716
717 bool RebuildArray; // whether to rebuild the fast lookup data structure.
718
720
721 class vtkInternalComponentNames;
722 vtkInternalComponentNames* ComponentNames; // names for each component
723
724private:
725 vtkAbstractArray(const vtkAbstractArray&) = delete;
726 void operator=(const vtkAbstractArray&) = delete;
727};
728
730
735template <typename ArrayT>
737{
738 inline ArrayT* operator()(vtkAbstractArray* array) { return ArrayT::SafeDownCast(array); }
739};
741
759template <typename ArrayT>
761{
762 // The default vtkArrayDownCast_impl struct uses SafeDownCast, but is
763 // specialized for arrays that support FastDownCast.
764 return vtkArrayDownCast_impl<ArrayT>()(array);
765}
766
767VTK_ABI_NAMESPACE_END
768
770
774#define vtkArrayDownCast_FastCastMacro(ArrayT) \
775 template <> \
776 struct vtkArrayDownCast_impl<ArrayT> \
777 { \
778 inline ArrayT* operator()(vtkAbstractArray* array) { return ArrayT::FastDownCast(array); } \
779 }
781
783
789#define vtkArrayDownCast_TemplateFastCastMacro(ArrayT) \
790 template <typename ValueT> \
791 struct vtkArrayDownCast_impl<ArrayT<ValueT>> \
792 { \
793 inline ArrayT<ValueT>* operator()(vtkAbstractArray* array) \
794 { \
795 return ArrayT<ValueT>::FastDownCast(array); \
796 } \
797 }
799#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)
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.
nlohmann::json SerializeValues()
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