VTK  9.3.0
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
63VTK_ABI_NAMESPACE_BEGIN
65class vtkDataArray;
66class vtkIdList;
67class vtkIdTypeArray;
68class vtkInformation;
73class vtkVariantArray;
74
75class VTKCOMMONCORE_EXPORT vtkAbstractArray : public vtkObject
76{
77public:
79 void PrintSelf(ostream& os, vtkIndent indent) override;
80
89 virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext = 1000) = 0;
90
94 virtual void Initialize() = 0;
95
100 virtual int GetDataType() const = 0;
101
103
108 virtual int GetDataTypeSize() const = 0;
109 static int GetDataTypeSize(int type);
111
119 virtual int GetElementComponentSize() const = 0;
120
122
126 vtkSetClampMacro(NumberOfComponents, int, 1, VTK_INT_MAX);
127 int GetNumberOfComponents() const { return this->NumberOfComponents; }
129
133 void SetComponentName(vtkIdType component, const char* name);
134
139 const char* GetComponentName(vtkIdType component) const;
140
144 bool HasAComponentName() const;
145
151
159 virtual void SetNumberOfTuples(vtkIdType numTuples) = 0;
160
167 virtual bool SetNumberOfValues(vtkIdType numValues);
168
172 vtkIdType GetNumberOfTuples() const { return (this->MaxId + 1) / this->NumberOfComponents; }
173
180 inline vtkIdType GetNumberOfValues() const { return (this->MaxId + 1); }
181
188 virtual void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) = 0;
189
195 virtual void InsertTuple(
196 vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) = 0;
197
203 virtual void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) = 0;
204
211 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) = 0;
212
218 virtual void InsertTuples(
219 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) = 0;
220
227
233 virtual void GetTuples(vtkIdList* tupleIds, vtkAbstractArray* output);
234
240 virtual void GetTuples(vtkIdType p1, vtkIdType p2, vtkAbstractArray* output);
241
248 virtual bool HasStandardMemoryLayout() const;
249
257 virtual void* GetVoidPointer(vtkIdType valueIdx) = 0;
258
267 virtual void DeepCopy(vtkAbstractArray* da);
268
276 virtual void InterpolateTuple(
277 vtkIdType dstTupleIdx, vtkIdList* ptIndices, vtkAbstractArray* source, double* weights) = 0;
278
287 virtual void InterpolateTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx1,
288 vtkAbstractArray* source1, vtkIdType srcTupleIdx2, vtkAbstractArray* source2, double t) = 0;
289
295 virtual void Squeeze() = 0;
296
306 virtual vtkTypeBool Resize(vtkIdType numTuples) = 0;
307
309
312 void Reset()
313 {
314 this->MaxId = -1;
315 this->DataChanged();
316 }
318
322 vtkIdType GetSize() const { return this->Size; }
323
327 vtkIdType GetMaxId() const { return this->MaxId; }
328
330 {
334 VTK_DATA_ARRAY_USER_DEFINED
335 };
336
338
355 virtual void SetVoidArray(
356 void* vtkNotUsed(array), vtkIdType vtkNotUsed(size), int vtkNotUsed(save)) = 0;
357 virtual void SetVoidArray(void* array, vtkIdType size, int save, int vtkNotUsed(deleteMethod))
358 {
359 this->SetVoidArray(array, size, save);
360 }
362
369 virtual void SetArrayFreeFunction(void (*callback)(void*)) = 0;
370
376 virtual void ExportToVoidPointer(void* out_ptr);
377
386 virtual unsigned long GetActualMemorySize() const = 0;
387
389
392 vtkSetStringMacro(Name);
393 vtkGetStringMacro(Name);
395
399 virtual const char* GetDataTypeAsString() const
400 {
401 return vtkImageScalarTypeNameMacro(this->GetDataType());
402 }
403
414 static vtkAbstractArray* CreateArray(int dataType);
415
420 virtual int IsNumeric() const = 0;
421
428
435 virtual vtkIdType GetDataSize() const
436 {
437 return this->GetNumberOfComponents() * this->GetNumberOfTuples();
438 }
439
441
448 virtual vtkIdType LookupValue(vtkVariant value) = 0;
449 virtual void LookupValue(vtkVariant value, vtkIdList* valueIds) = 0;
451
456 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues());
457
462 virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)
463 VTK_EXPECTS(0 <= valueIdx) = 0;
464
469 virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)
470 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues()) = 0;
471
480 virtual void DataChanged() = 0;
481
487 virtual void ClearLookup() = 0;
488
541 virtual void GetProminentComponentValues(int comp, vtkVariantArray* values,
542 double uncertainty = 1.e-6, double minimumProminence = 1.e-3);
543
544 // TODO: Implement these lookup functions also.
545 // virtual void LookupRange(vtkVariant min, vtkVariant max, vtkIdList* ids,
546 // bool includeMin = true, bool includeMax = true) = 0;
547 // virtual void LookupGreaterThan(vtkVariant min, vtkIdList* ids, bool includeMin = false) = 0;
548 // virtual void LookupLessThan(vtkVariant max, vtkIdList* ids, bool includeMax = false) = 0;
549
560 bool HasInformation() const { return this->Information != nullptr; }
561
573 virtual int CopyInformation(vtkInformation* infoFrom, vtkTypeBool deep = 1);
574
580
594
608
612 void Modified() override;
613
620
629
630 // Deprecated. Use vtkAbstractArray::MaxDiscreteValues instead.
631 enum
632 {
633 MAX_DISCRETE_VALUES = 32
634 };
635
637
641 vtkGetMacro(MaxDiscreteValues, unsigned int);
642 vtkSetMacro(MaxDiscreteValues, unsigned int);
644
645 enum
646 {
647 AbstractArray = 0,
655
656 DataArrayTemplate = AoSDataArrayTemplate
657 };
658
663 virtual int GetArrayType() const { return AbstractArray; }
664
668 const char* GetArrayTypeAsString() const;
669
670protected:
671 // Construct object with default tuple dimension (number of components) of 1.
674
681
693 virtual void UpdateDiscreteValueSet(double uncertainty, double minProminence);
694
695 vtkIdType Size; // allocated size of data
696 vtkIdType MaxId; // maximum index inserted thus far
697 int NumberOfComponents; // the number of components per tuple
698
699 // maximum number of prominent values before array is considered continuous.
700 unsigned int MaxDiscreteValues;
701
702 char* Name;
703
704 bool RebuildArray; // whether to rebuild the fast lookup data structure.
705
707
708 class vtkInternalComponentNames;
709 vtkInternalComponentNames* ComponentNames; // names for each component
710
711private:
712 vtkAbstractArray(const vtkAbstractArray&) = delete;
713 void operator=(const vtkAbstractArray&) = delete;
714};
715
717
722template <typename ArrayT>
724{
725 inline ArrayT* operator()(vtkAbstractArray* array) { return ArrayT::SafeDownCast(array); }
726};
728
746template <typename ArrayT>
748{
749 // The default vtkArrayDownCast_impl struct uses SafeDownCast, but is
750 // specialized for arrays that support FastDownCast.
751 return vtkArrayDownCast_impl<ArrayT>()(array);
752}
753
754VTK_ABI_NAMESPACE_END
755
757
761#define vtkArrayDownCast_FastCastMacro(ArrayT) \
762 template <> \
763 struct vtkArrayDownCast_impl<ArrayT> \
764 { \
765 inline ArrayT* operator()(vtkAbstractArray* array) { return ArrayT::FastDownCast(array); } \
766 }
768
770
776#define vtkArrayDownCast_TemplateFastCastMacro(ArrayT) \
777 template <typename ValueT> \
778 struct vtkArrayDownCast_impl<ArrayT<ValueT>> \
779 { \
780 inline ArrayT<ValueT>* operator()(vtkAbstractArray* array) \
781 { \
782 return ArrayT<ValueT>::FastDownCast(array); \
783 } \
784 }
786#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.
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,...
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 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 bool SetNumberOfValues(vtkIdType numValues)
Specify the number of values (tuples * components) for this object to hold.
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,...
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
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:23
dynamic, self-adjusting array of vtkIdType
a simple class to control print indentation
Definition vtkIndent.h:29
Key for integer values in vtkInformation.
Store vtkAlgorithm input/output information.
abstract base class for most VTK objects
Definition vtkObject.h:49
An array holding vtkVariants.
A type representing the union of many types.
Definition vtkVariant.h:53
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_EXPECTS(x)
#define VTK_NEWINSTANCE