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=========================================================================*/
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.
45template <class ValueTypeT>
46class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate
47 : public vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>
48{
50
51public:
54 typedef typename Superclass::ValueType ValueType;
55
57 {
60 VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
61 VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
62 };
63
65
70 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
71 {
72 return this->Buffer->GetBuffer()[valueIdx];
73 }
74
78 void SetValue(vtkIdType valueIdx, ValueType value)
79 VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
80 {
81 this->Buffer->GetBuffer()[valueIdx] = value;
82 }
83
85
88 void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
89 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
90 {
91 const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
92 std::copy(this->Buffer->GetBuffer() + valueIdx,
93 this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents, tuple);
94 }
96
98
101 void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
102 VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
103 {
104 const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
105 std::copy(tuple, tuple + this->NumberOfComponents, this->Buffer->GetBuffer() + valueIdx);
106 }
108
112 ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const VTK_EXPECTS(0 <= tupleIdx &&
113 tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
114 {
115 return this->Buffer->GetBuffer()[this->NumberOfComponents * tupleIdx + comp];
116 }
117
119
122 void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value) VTK_EXPECTS(0 <= tupleIdx &&
123 tupleIdx < GetNumberOfTuples()) VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
124 {
125 const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
126 this->SetValue(valueIdx, value);
127 }
129
131
134 void FillTypedComponent(int compIdx, ValueType value) override;
136
138
141 void FillValue(ValueType value) override;
142 void Fill(double value) override;
144
146
152 void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;
154
156
164 void* GetVoidPointer(vtkIdType valueIdx) override;
166
168
182 void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save, int deleteMethod);
184 void SetVoidArray(void* array, vtkIdType size, int save) override;
185 void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override;
187
194 void SetArrayFreeFunction(void (*callback)(void*)) override;
195
196 // Overridden for optimized implementations:
197 void SetTuple(vtkIdType tupleIdx, const float* tuple) override;
198 void SetTuple(vtkIdType tupleIdx, const double* tuple) override;
199 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
200 // using Superclass::SetTuple;
201 void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
202 {
203 this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source);
204 }
205 void InsertTuple(vtkIdType tupleIdx, const float* source) override;
206 void InsertTuple(vtkIdType tupleIdx, const double* source) override;
207 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
208 // using Superclass::InsertTuple;
209 void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
210 {
211 this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source);
212 }
213 void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
214 vtkIdType InsertNextTuple(const float* tuple) override;
215 vtkIdType InsertNextTuple(const double* tuple) override;
216 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
217 // using Superclass::InsertNextTuple;
219 {
220 return this->Superclass::InsertNextTuple(srcTupleIdx, source);
221 }
222 void GetTuple(vtkIdType tupleIdx, double* tuple) override;
223 double* GetTuple(vtkIdType tupleIdx) override;
224
236
241 typedef ValueType* Iterator;
242 Iterator Begin() { return Iterator(this->GetVoidPointer(0)); }
243 Iterator End() { return Iterator(this->GetVoidPointer(this->MaxId + 1)); }
244
246
255
258 bool HasStandardMemoryLayout() const override { return true; }
259 void ShallowCopy(vtkDataArray* other) override;
260
261 // Reimplemented for efficiency:
263 vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
264 // MSVC doesn't like 'using' here (error C2487). Just forward instead:
265 // using Superclass::InsertTuples;
266 void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override
267 {
268 this->Superclass::InsertTuples(dstIds, srcIds, source);
269 }
271 vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override
272 {
273 this->Superclass::InsertTuplesStartingAt(dstStart, srcIds, source);
274 }
275
276protected:
279
284 bool AllocateTuples(vtkIdType numTuples);
285
291
293
294private:
296 void operator=(const vtkAOSDataArrayTemplate&) = delete;
297
298 friend class vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT>;
299};
300
301// Declare vtkArrayDownCast implementations for AoS containers:
303
304// This macro is used by the subclasses to create dummy
305// declarations for these functions such that the wrapper
306// can see them. The wrappers ignore vtkAOSDataArrayTemplate.
307#define vtkCreateWrappedArrayInterface(T) \
308 int GetDataType() const override; \
309 void GetTypedTuple(vtkIdType i, T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
310 void SetTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i && i < GetNumberOfTuples()); \
311 void InsertTypedTuple(vtkIdType i, const T* tuple) VTK_EXPECTS(0 <= i); \
312 vtkIdType InsertNextTypedTuple(const T* tuple); \
313 T GetValue(vtkIdType id) const VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
314 void SetValue(vtkIdType id, T value) VTK_EXPECTS(0 <= id && id < GetNumberOfValues()); \
315 bool SetNumberOfValues(vtkIdType number) override; \
316 void InsertValue(vtkIdType id, T f) VTK_EXPECTS(0 <= id); \
317 vtkIdType InsertNextValue(T f); \
318 T* GetValueRange(int comp) VTK_SIZEHINT(2); \
319 T* GetValueRange() VTK_SIZEHINT(2); \
320 T* WritePointer(vtkIdType id, vtkIdType number); \
321 T* GetPointer(vtkIdType id); \
322 void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save); \
323 void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod)
324
325#endif // header guard
326
327// This portion must be OUTSIDE the include blockers. This is used to tell
328// libraries other than vtkCommonCore that instantiations of
329// vtkAOSDataArrayTemplate can be found externally. This prevents each library
330// from instantiating these on their own.
331#ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
332#define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T) \
333 namespace vtkDataArrayPrivate \
334 { \
335 VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<T>, double); \
336 } \
337 template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate<T>
338
339#elif defined(VTK_USE_EXTERN_TEMPLATE)
340#ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
341#define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
342#ifdef _MSC_VER
343#pragma warning(push)
344// The following is needed when the vtkAOSDataArrayTemplate is declared
345// dllexport and is used from another class in vtkCommonCore
346#pragma warning(disable : 4910) // extern and dllexport incompatible
347#endif
348vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
349#ifdef _MSC_VER
350#pragma warning(pop)
351#endif
352#endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
353
354// The following clause is only for MSVC
355#elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
356#pragma warning(push)
357
358// C4091: 'extern ' : ignored on left of 'int' when no variable is declared
359#pragma warning(disable : 4091)
360
361// Compiler-specific extension warning.
362#pragma warning(disable : 4231)
363
364// We need to disable warning 4910 and do an extern dllexport
365// anyway. When deriving vtkCharArray and other types from an
366// instantiation of this template the compiler does an explicit
367// instantiation of the base class. From outside the vtkCommon
368// library we block this using an extern dllimport instantiation.
369// For classes inside vtkCommon we should be able to just do an
370// extern instantiation, but VS complains about missing
371// definitions. We cannot do an extern dllimport inside vtkCommon
372// since the symbols are local to the dll. An extern dllexport
373// seems to be the only way to convince VS to do the right
374// thing, so we just disable the warning.
375#pragma warning(disable : 4910) // extern and dllexport incompatible
376
377// Use an "extern explicit instantiation" to give the class a DLL
378// interface. This is a compiler-specific extension.
379vtkInstantiateTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
380
381#pragma warning(pop)
382
383#endif
384
385// 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.
ValueType * Iterator
Legacy support for array-of-structs value iteration.
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.
Superclass::ValueType ValueType
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...
vtkAOSDataArrayTemplate< ValueTypeT > SelfType
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.
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...
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:34
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