VTK  9.2.6
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=========================================================================*/
31#ifndef vtkAOSDataArrayTemplate_h
32#define vtkAOSDataArrayTemplate_h
33
34#include "vtkBuffer.h" // For storage buffer.
35#include "vtkBuild.h" // For VTK_BUILD_SHARED_LIBS
36#include "vtkCommonCoreModule.h" // For export macro
37#include "vtkCompiler.h" // for VTK_USE_EXTERN_TEMPLATE
38#include "vtkGenericDataArray.h"
39
40// The export macro below makes no sense, but is necessary for older compilers
41// when we export instantiations of this class from vtkCommonCore.
42template <class ValueTypeT>
43class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate
44 : public vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>
45{
47
48public:
51 typedef typename Superclass::ValueType ValueType;
52
54 {
57 VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
58 VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
59 };
60
62
67 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
68 {
69 return this->Buffer->GetBuffer()[valueIdx];
70 }
71
75 void SetValue(vtkIdType valueIdx, ValueType value)
76 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
77 {
78 this->Buffer->GetBuffer()[valueIdx] = value;
79 }
80
82
85 void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
86 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
87 {
88 const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
89 std::copy(this->Buffer->GetBuffer() + valueIdx,
90 this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents, tuple);
91 }
93
95
98 void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
99 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
100 {
101 const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
102 std::copy(tuple, tuple + this->NumberOfComponents, this->Buffer->GetBuffer() + valueIdx);
103 }
105
109 ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const VTK_EXPECTS(0 <= tupleIdx &&
110 tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
111 {
112 return this->Buffer->GetBuffer()[this->NumberOfComponents * tupleIdx + comp];
113 }
114
116
119 void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value) VTK_EXPECTS(0 <= tupleIdx &&
120 tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
121 {
122 const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
123 this->SetValue(valueIdx, value);
124 }
126
128
131 void FillTypedComponent(int compIdx, ValueType value) override;
133
135
138 void FillValue(ValueType value) override;
139 void Fill(double value) override;
141
143
149 void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
151
153
161 void* GetVoidPointer(vtkIdType valueIdx) override;
163
165
179 void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save, int deleteMethod);
181 void SetVoidArray(void* array, vtkIdType size, int save) override;
182 void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override;
184
191 void SetArrayFreeFunction(void (*callback)(void*)) override;
192
193 // Overridden for optimized implementations:
194 void SetTuple(vtkIdType tupleIdx, const float* tuple) override;
195 void SetTuple(vtkIdType tupleIdx, const double* tuple) override;
196 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
197 // using Superclass::SetTuple;
198 void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
199 {
200 this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source);
201 }
202 void InsertTuple(vtkIdType tupleIdx, const float* source) override;
203 void InsertTuple(vtkIdType tupleIdx, const double* source) override;
204 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
205 // using Superclass::InsertTuple;
206 void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
207 {
208 this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source);
209 }
210 void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
211 vtkIdType InsertNextTuple(const float* tuple) override;
212 vtkIdType InsertNextTuple(const double* tuple) override;
213 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
214 // using Superclass::InsertNextTuple;
216 {
217 return this->Superclass::InsertNextTuple(srcTupleIdx, source);
218 }
219 void GetTuple(vtkIdType tupleIdx, double* tuple) override;
220 double* GetTuple(vtkIdType tupleIdx) override;
221
233
238 typedef ValueType* Iterator;
239 Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
240 Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
241
243
252
255 bool HasStandardMemoryLayout() const override { return true; }
256 void ShallowCopy(vtkDataArray* other) override;
257
258 // Reimplemented for efficiency:
260 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
261 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
262 // using Superclass::InsertTuples;
263 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override
264 {
265 this->Superclass::InsertTuples(dstIds, srcIds, source);
266 }
268 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override
269 {
270 this->Superclass::InsertTuplesStartingAt(dstStart, srcIds, source);
271 }
272
273protected:
276
281 bool AllocateTuples(vtkIdType numTuples);
282
288
290
291private:
293 void operator=(const vtkAOSDataArrayTemplate&) = delete;
294
295 friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>;
296};
297
298// Declare vtkArrayDownCast implementations for AoS containers:
300
301// This macro is used by the subclasses to create dummy
302// declarations for these functions such that the wrapper
303// can see them. The wrappers ignore vtkAOSDataArrayTemplate.
304#define vtkCreateWrappedArrayInterface(T) \
305 int GetDataType() const override; \
306 void GetTypedTuple(vtkIdType i, T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
307 void SetTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
308 void InsertTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i); \
309 vtkIdType InsertNextTypedTuple(const T* tuple); \
310 T GetValue(vtkIdType id) const VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
311 void SetValue(vtkIdType id, T value) VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
312 bool SetNumberOfValues(vtkIdType number) override; \
313 void InsertValue(vtkIdType id, T f) VTK_EXPECTS(0 <= id); \
314 vtkIdType InsertNextValue(T f); \
315 T* GetValueRange(int comp) VTK_SIZEHINT(2); \
316 T* GetValueRange() VTK_SIZEHINT(2); \
317 T* WritePointer(vtkIdType id, vtkIdType number); \
318 T* GetPointer(vtkIdType id); \
319 void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
320 void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
321
322#endif // header guard
323
324// This portion must be OUTSIDE the include blockers. This is used to tell
325// libraries other than vtkCommonCore that instantiations of
326// vtkAOSDataArrayTemplate can be found externally. This prevents each library
327// from instantiating these on their own.
328#ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
329#define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
330 namespace vtkDataArrayPrivate \
331 { \
332 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<T>, double); \
333 } \
334 template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate<T>
335
336#elif defined(VTK_USE_EXTERN_TEMPLATE)
337#ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
338#define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
339#ifdef _MSC_VER
340#pragma warning(push)
341// The following is needed when the vtkAOSDataArrayTemplate is declared
342// dllexport and is used from another class in vtkCommonCore
343#pragma warning(disable : 4910) // extern and dllexport incompatible
344#endif
345vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
346#ifdef _MSC_VER
347#pragma warning(pop)
348#endif
349#endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
350
351// The following clause is only for MSVC
352#elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
353#pragma warning(push)
354
355// C4091: 'extern ' : ignored on left of 'int' when no variable is declared
356#pragma warning(disable : 4091)
357
358// Compiler-specific extension warning.
359#pragma warning(disable : 4231)
360
361// We need to disable warning 4910 and do an extern dllexport
362// anyway. When deriving vtkCharArray and other types from an
363// instantiation of this template the compiler does an explicit
364// instantiation of the base class. From outside the vtkCommon
365// library we block this using an extern dllimport instantiation.
366// For classes inside vtkCommon we should be able to just do an
367// extern instantiation, but VS complains about missing
368// definitions. We cannot do an extern dllimport inside vtkCommon
369// since the symbols are local to the dll. An extern dllexport
370// seems to be the only way to convince VS to do the right
371// thing, so we just disable the warning.
372#pragma warning(disable : 4910) // extern and dllexport incompatible
373
374// Use an "extern explicit instantiation" to give the class a DLL
375// interface. This is a compiler-specific extension.
376vtkInstantiateTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
377
378#pragma warning(pop)
379
380#endif
381
382// VTK-HeaderTest-Exclude: vtkAOSDataArrayTemplate.h
Array-Of-Structs implementation of vtkGenericDataArray.
static vtkAOSDataArrayTemplate< ValueType > * FastDownCast(vtkAbstractArray *source)
Perform a fast, safe cast from a vtkAbstractArray to a vtkAOSDataArrayTemplate.
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.
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 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.
ValueType * WritePointer(vtkIdType valueIdx, vtkIdType numValues)
Get the address of a particular data index.
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 FillValue(ValueType value) override
Set all the values in array to value.
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.
void * WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override
Get the address of a particular data index.
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...
vtkArrayIterator * NewIterator() override
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
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...
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,...
void * GetVoidPointer(vtkIdType valueIdx) override
Get the address of a particular data index.
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.
ValueType * GetPointer(vtkIdType valueIdx)
Get the address of a particular data index.
static vtkAOSDataArrayTemplate * New()
double * GetTuple(vtkIdType tupleIdx) override
Get the data tuple at tupleIdx.
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.
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 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 InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
vtkIdType GetNumberOfValues() const
Get the total number of values in the array.
virtual vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source)=0
Insert the tuple from srcTupleIdx in the source array at the end of this array.
Abstract superclass to iterate over elements in an vtkAbstractArray.
internal storage class used by vtkSOADataArrayTemplate, vtkAOSDataArrayTemplate, and others.
Definition vtkBuffer.h:35
abstract superclass for arrays of numeric data
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:31
void SetValue(vtkIdType valueIdx, ValueType value)
Set the value at valueIdx to value.
#define vtkArrayDownCast_TemplateFastCastMacro(ArrayT)
Same as vtkArrayDownCast_FastCastMacro, but treats ArrayT as a single-parameter template (the paramet...
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
#define vtkExternTemplateMacro(decl)
A macro to declare extern templates for all numerical types.
Definition vtkType.h:395
int vtkIdType
Definition vtkType.h:332
#define vtkInstantiateTemplateMacro(decl)
A macro to instantiate a template over all numerical types.
Definition vtkType.h:378
void save(Archiver &ar, const std::string &str, const unsigned int vtkNotUsed(version))
#define VTK_EXPECTS(x)
#define VTK_ZEROCOPY
#define VTK_NEWINSTANCE