VTK  9.2.20221001
vtkAOSDataArrayTemplate.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAOSDataArrayTemplate.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
34 #ifndef vtkAOSDataArrayTemplate_h
35 #define vtkAOSDataArrayTemplate_h
36 
37 #include "vtkBuffer.h" // For storage buffer.
38 #include "vtkBuild.h" // For VTK_BUILD_SHARED_LIBS
39 #include "vtkCommonCoreModule.h" // For export macro
40 #include "vtkCompiler.h" // for VTK_USE_EXTERN_TEMPLATE
41 #include "vtkGenericDataArray.h"
42 
43 // The export macro below makes no sense, but is necessary for older compilers
44 // when we export instantiations of this class from vtkCommonCore.
45 VTK_ABI_NAMESPACE_BEGIN
46 template <class ValueTypeT>
47 class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate
48  : public vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>
49 {
51 
52 public:
55  typedef typename Superclass::ValueType ValueType;
56 
58  {
60  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
61  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
62  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
63  };
64 
66 
70  ValueType GetValue(vtkIdType valueIdx) const
71  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
72  {
73  return this->Buffer->GetBuffer()[valueIdx];
74  }
75 
80  VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
81  {
82  this->Buffer->GetBuffer()[valueIdx] = value;
83  }
84 
86 
89  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
90  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
91  {
92  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
93  std::copy(this->Buffer->GetBuffer() + valueIdx,
94  this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents, tuple);
95  }
97 
99 
102  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
103  VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
104  {
105  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
106  std::copy(tuple, tuple + this->NumberOfComponents, this->Buffer->GetBuffer() + valueIdx);
107  }
109 
113  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const VTK_EXPECTS(0 <= tupleIdx &&
114  tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
115  {
116  return this->Buffer->GetBuffer()[this->NumberOfComponents * tupleIdx + comp];
117  }
118 
120 
123  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value) VTK_EXPECTS(0 <= tupleIdx &&
124  tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
125  {
126  const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
127  this->SetValue(valueIdx, value);
128  }
130 
132 
135  void FillTypedComponent(int compIdx, ValueType value) override;
137 
139 
142  void FillValue(ValueType value) override;
143  void Fill(double value) override;
145 
147 
152  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
153  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
155 
157 
165  void* GetVoidPointer(vtkIdType valueIdx) override;
167 
169 
183  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save, int deleteMethod);
185  void SetVoidArray(void* array, vtkIdType size, int save) override;
186  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override;
188 
195  void SetArrayFreeFunction(void (*callback)(void*)) override;
196 
197  // Overridden for optimized implementations:
198  void SetTuple(vtkIdType tupleIdx, const float* tuple) override;
199  void SetTuple(vtkIdType tupleIdx, const double* tuple) override;
200  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
201  // using Superclass::SetTuple;
202  void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
203  {
204  this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source);
205  }
206  void InsertTuple(vtkIdType tupleIdx, const float* source) override;
207  void InsertTuple(vtkIdType tupleIdx, const double* source) override;
208  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
209  // using Superclass::InsertTuple;
210  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
211  {
212  this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source);
213  }
214  void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
215  vtkIdType InsertNextTuple(const float* tuple) override;
216  vtkIdType InsertNextTuple(const double* tuple) override;
217  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
218  // using Superclass::InsertNextTuple;
220  {
221  return this->Superclass::InsertNextTuple(srcTupleIdx, source);
222  }
223  void GetTuple(vtkIdType tupleIdx, double* tuple) override;
224  double* GetTuple(vtkIdType tupleIdx) override;
225 
237 
242  typedef ValueType* Iterator;
243  Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
244  Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
245 
247 
256 
257  int GetArrayType() const override { return vtkAbstractArray::AoSDataArrayTemplate; }
259  bool HasStandardMemoryLayout() const override { return true; }
260  void ShallowCopy(vtkDataArray* other) override;
261 
262  // Reimplemented for efficiency:
264  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
265  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
266  // using Superclass::InsertTuples;
267  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override
268  {
269  this->Superclass::InsertTuples(dstIds, srcIds, source);
270  }
272  vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override
273  {
274  this->Superclass::InsertTuplesStartingAt(dstStart, srcIds, source);
275  }
276 
277 protected:
280 
285  bool AllocateTuples(vtkIdType numTuples);
286 
291  bool ReallocateTuples(vtkIdType numTuples);
292 
294 
295 private:
297  void operator=(const vtkAOSDataArrayTemplate&) = delete;
298 
299  friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>;
300 };
301 
302 // Declare vtkArrayDownCast implementations for AoS containers:
304 
305 VTK_ABI_NAMESPACE_END
306 
307 // This macro is used by the subclasses to create dummy
308 // declarations for these functions such that the wrapper
309 // can see them. The wrappers ignore vtkAOSDataArrayTemplate.
310 #define vtkCreateWrappedArrayInterface(T) \
311  int GetDataType() const override; \
312  void GetTypedTuple(vtkIdType i, T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
313  void SetTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
314  void InsertTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i); \
315  vtkIdType InsertNextTypedTuple(const T* tuple); \
316  T GetValue(vtkIdType id) const VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
317  void SetValue(vtkIdType id, T value) VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
318  bool SetNumberOfValues(vtkIdType number) override; \
319  void InsertValue(vtkIdType id, T f) VTK_EXPECTS(0 <= id); \
320  vtkIdType InsertNextValue(T f); \
321  T* GetValueRange(int comp) VTK_SIZEHINT(2); \
322  T* GetValueRange() VTK_SIZEHINT(2); \
323  T* WritePointer(vtkIdType id, vtkIdType number); \
324  T* GetPointer(vtkIdType id); \
325  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
326  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
327 
328 #endif // header guard
329 
330 // This portion must be OUTSIDE the include blockers. This is used to tell
331 // libraries other than vtkCommonCore that instantiations of
332 // vtkAOSDataArrayTemplate can be found externally. This prevents each library
333 // from instantiating these on their own.
334 #ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
335 #define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
336  namespace vtkDataArrayPrivate \
337  { \
338  VTK_ABI_NAMESPACE_BEGIN \
339  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<T>, double); \
340  VTK_ABI_NAMESPACE_END \
341  } \
342  VTK_ABI_NAMESPACE_BEGIN \
343  template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate<T>; \
344  VTK_ABI_NAMESPACE_END
345 
346 #elif defined(VTK_USE_EXTERN_TEMPLATE)
347 #ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
348 #define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
349 #ifdef _MSC_VER
350 #pragma warning(push)
351 // The following is needed when the vtkAOSDataArrayTemplate is declared
352 // dllexport and is used from another class in vtkCommonCore
353 #pragma warning(disable : 4910) // extern and dllexport incompatible
354 #endif
355 VTK_ABI_NAMESPACE_BEGIN
356 vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
357 VTK_ABI_NAMESPACE_END
358 #ifdef _MSC_VER
359 #pragma warning(pop)
360 #endif
361 #endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
362 
363 // The following clause is only for MSVC
364 #elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
365 #pragma warning(push)
366 
367 // C4091: 'extern ' : ignored on left of 'int' when no variable is declared
368 #pragma warning(disable : 4091)
369 
370 // Compiler-specific extension warning.
371 #pragma warning(disable : 4231)
372 
373 // We need to disable warning 4910 and do an extern dllexport
374 // anyway. When deriving vtkCharArray and other types from an
375 // instantiation of this template the compiler does an explicit
376 // instantiation of the base class. From outside the vtkCommon
377 // library we block this using an extern dllimport instantiation.
378 // For classes inside vtkCommon we should be able to just do an
379 // extern instantiation, but VS complains about missing
380 // definitions. We cannot do an extern dllimport inside vtkCommon
381 // since the symbols are local to the dll. An extern dllexport
382 // seems to be the only way to convince VS to do the right
383 // thing, so we just disable the warning.
384 #pragma warning(disable : 4910) // extern and dllexport incompatible
385 
386 // Use an "extern explicit instantiation" to give the class a DLL
387 // interface. This is a compiler-specific extension.
388 VTK_ABI_NAMESPACE_BEGIN
389 vtkInstantiateTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
390 VTK_ABI_NAMESPACE_END
391 
392 #pragma warning(pop)
393 
394 #endif
395 
396 // VTK-HeaderTest-Exclude: vtkAOSDataArrayTemplate.h
Array-Of-Structs implementation of vtkGenericDataArray.
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
static vtkAOSDataArrayTemplate * New()
void SetVoidArray(void *array, vtkIdType size, int save) override
This method lets the user specify data to be held by the array.
void SetArray(ValueType *array, vtkIdType size, int save)
This method lets the user specify data to be held by the array.
void SetTuple(vtkIdType tupleIdx, const float *tuple) override
Set the data tuple at tupleIdx.
ValueType * WritePointer(vtkIdType valueIdx, vtkIdType numValues)
Get the address of a particular data index.
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
void SetTuple(vtkIdType tupleIdx, const double *tuple) override
Set the data tuple at tupleIdx.
void SetTypedTuple(vtkIdType tupleIdx, const ValueType *tuple)
Set this array's tuple at tupleIdx to the values in tuple.
void * WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override
Get the address of a particular data index.
void InsertTuples(vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray *source) override
Copy n consecutive tuples starting at srcStart from the source array to this array,...
void InsertTuplesStartingAt(vtkIdType dstStart, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations starting at index dstS...
void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array.
void DataElementChanged(vtkIdType)
Tell the array explicitly that a single data element has changed.
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
This method lets the user specify data to be held by the array.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
void * GetVoidPointer(vtkIdType valueIdx) override
Get the address of a particular data index.
void FillValue(ValueType value) override
Set all the values in array to value.
ValueType * GetPointer(vtkIdType valueIdx)
Get the address of a particular data index.
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple from srcTupleIdx in the source array at the end of this array.
void InsertTuple(vtkIdType tupleIdx, const float *source) override
Insert the data tuple at tupleIdx.
void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
Set component comp of the tuple at tupleIdx to value.
static vtkAOSDataArrayTemplate< ValueType > * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkAOSDataArrayTemplate.
void SetArray(ValueType *array, vtkIdType size, int save, int deleteMethod)
This method lets the user specify data to be held by the array.
void SetArrayFreeFunction(void(*callback)(void *)) override
This method allows the user to specify a custom free function to be called when the array is dealloca...
bool ReallocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
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...
double * GetTuple(vtkIdType tupleIdx) override
Get the data tuple at tupleIdx.
void InsertTuple(vtkIdType tupleIdx, const double *source) override
Insert the data tuple at tupleIdx.
bool HasStandardMemoryLayout() const override
Returns true if this array uses the standard memory layout defined in the VTK user guide,...
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...
void FillTypedComponent(int compIdx, ValueType value) override
Set component comp of all tuples to value.
void Fill(double value) override
Set all the values in array to value.
void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override
Insert value at the location specified by tupleIdx and compIdx.
vtkTemplateTypeMacro(SelfType, GenericDataArrayType)
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
~vtkAOSDataArrayTemplate() override
void ShallowCopy(vtkDataArray *other) override
Create a shallow copy of other into this, if possible.
void GetTypedTuple(vtkIdType tupleIdx, ValueType *tuple) const
Copy the tuple at tupleIdx into tuple.
int GetArrayType() const override
Method for type-checking in FastDownCast implementations.
bool AllocateTuples(vtkIdType numTuples)
Allocate space for numTuples.
ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
Get component comp of the tuple at tupleIdx.
ValueType GetValue(vtkIdType valueIdx) const
Get the value at valueIdx.
ValueType * Iterator
Legacy support for array-of-structs value iteration.
vtkAOSDataArrayTemplate< ValueTypeT > SelfType
vtkBuffer< ValueType > * Buffer
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...
Superclass::ValueType ValueType
Abstract superclass for all arrays.
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:166
Base interface for all typed vtkDataArray subclasses.
void DataChanged() override
Tell the array explicitly that the data has changed.
void * GetVoidPointer(vtkIdType valueIdx) override
Default implementation raises a runtime error.
list of point or cell ids
Definition: vtkIdList.h:144
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
@ value
Definition: vtkX3D.h:232
@ size
Definition: vtkX3D.h:265
vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate)
vtkArrayDownCast_TemplateFastCastMacro(vtkAOSDataArrayTemplate)
vtkInstantiateTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkArrayIteratorTemplate)
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
int vtkIdType
Definition: vtkType.h:326
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_ZEROCOPY
#define VTK_NEWINSTANCE