vtkAOSDataArrayTemplate.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkAOSDataArrayTemplate_h
#define vtkAOSDataArrayTemplate_h
 
#include "vtkBuffer.h"           // For storage buffer.
#include "vtkBuild.h"            // For VTK_BUILD_SHARED_LIBS
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkCompiler.h"         // for VTK_USE_EXTERN_TEMPLATE
#include "vtkDataArrayMeta.h"    // For vtkDataArrayMeta::ComponentType
#include "vtkGenericDataArray.h"
#include "vtkWrappingHints.h" // For VTK_NEWINSTANCE
 
namespace vtk
{
namespace detail
{
VTK_ABI_NAMESPACE_BEGIN
template <typename ArrayType, ComponentIdType TupleSize>
struct TupleRange;
template <typename ArrayType, ComponentIdType TupleSize,
  typename ForceValueTypeForVtkDataArray = double>
struct ValueRange;
VTK_ABI_NAMESPACE_END
} // namespace detail
} // namespace vtk
 
// The export macro below makes no sense, but is necessary for older compilers
// when we export instantiations of this class from vtkCommonCore.
VTK_ABI_NAMESPACE_BEGIN
template <class ValueTypeT>
class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate
#ifndef __VTK_WRAP__
  : public vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT,
      vtkArrayTypes::VTK_AOS_DATA_ARRAY>
{
  using GenericDataArrayType = vtkGenericDataArray<vtkAOSDataArrayTemplate<ValueTypeT>, ValueTypeT,
    vtkArrayTypes::VTK_AOS_DATA_ARRAY>;
#else // Fake the superclass for the wrappers.
  : public vtkDataArray
{
  using GenericDataArrayType = vtkDataArray;
#endif
 
  // Friendship required by vtkDataArray(Value/Tuple)Range so that it can access the memory buffer
  // which is required to avoid accessing raw pointers that might no longer be valid.
  template <typename ArrayType, vtk::ComponentIdType TupleSize>
  friend struct vtk::detail::TupleRange;
  template <typename ArrayType, vtk::ComponentIdType TupleSize,
    typename ForceValueTypeForVtkDataArray>
  friend struct vtk::detail::ValueRange;
 
public:
  using SelfType = vtkAOSDataArrayTemplate<ValueTypeT>;
  vtkTemplateTypeMacro(SelfType, GenericDataArrayType);
#ifndef __VTK_WRAP__
  using typename Superclass::ArrayTypeTag;
  using typename Superclass::DataTypeTag;
  using typename Superclass::ValueType;
#else
  using ValueType = ValueTypeT;
#endif
 
  enum DeleteMethod
  {
    VTK_DATA_ARRAY_FREE = vtkAbstractArray::VTK_DATA_ARRAY_FREE,
    VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
    VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
    VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
  };
 
  static vtkAOSDataArrayTemplate* New();

  ValueType GetValue(vtkIdType valueIdx) const
    VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
  {
    return this->Buffer->GetBuffer()[valueIdx];
  }

  void SetValue(vtkIdType valueIdx, ValueType value)
    VTK_EXPECTS(0 <= valueIdx && valueIdx < GetNumberOfValues())
  {
    this->Buffer->GetBuffer()[valueIdx] = value;
  }


  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
    std::copy(this->Buffer->GetBuffer() + valueIdx,
      this->Buffer->GetBuffer() + valueIdx + this->NumberOfComponents, tuple);
  }



  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple)
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples())
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
    std::copy(tuple, tuple + this->NumberOfComponents, this->Buffer->GetBuffer() + valueIdx);
  }

 
  void GetIntegerTuple(vtkIdType tupleIdx, vtkTypeInt64* tuple)
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) override
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
    for (vtkIdType ii = 0; ii < this->NumberOfComponents; ++ii)
    {
      tuple[ii] = static_cast<vtkTypeInt64>((this->Buffer->GetBuffer())[valueIdx + ii]);
    }
  }
 
  void SetIntegerTuple(vtkIdType tupleIdx, vtkTypeInt64* tuple)
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) override
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
    for (vtkIdType ii = 0; ii < this->NumberOfComponents; ++ii)
    {
      this->Buffer->GetBuffer()[valueIdx + ii] = static_cast<ValueType>(tuple[ii]);
    }
  }
 
  void GetUnsignedTuple(vtkIdType tupleIdx, vtkTypeUInt64* tuple)
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) override
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
    for (vtkIdType ii = 0; ii < this->NumberOfComponents; ++ii)
    {
      tuple[ii] = static_cast<vtkTypeUInt64>((this->Buffer->GetBuffer())[valueIdx + ii]);
    }
  }
 
  void SetUnsignedTuple(vtkIdType tupleIdx, vtkTypeUInt64* tuple)
    VTK_EXPECTS(0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) override
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents;
    for (vtkIdType ii = 0; ii < this->NumberOfComponents; ++ii)
    {
      this->Buffer->GetBuffer()[valueIdx + ii] = static_cast<ValueType>(tuple[ii]);
    }
  }

  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
    VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + comp < GetNumberOfValues())
      VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
  {
    return this->Buffer->GetBuffer()[this->NumberOfComponents * tupleIdx + comp];
  }


  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
    VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + comp < GetNumberOfValues())
      VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents())
  {
    const vtkIdType valueIdx = tupleIdx * this->NumberOfComponents + comp;
    this->SetValue(valueIdx, value);
  }



#ifdef __VTK_WRAP__
  // Defined in vtkGenericDataArray, not vtkDataArray
  virtual void FillTypedComponent(int compIdx, ValueType value);
#else
  void FillTypedComponent(int compIdx, ValueType value) override;
#endif


#ifdef __VTK_WRAP__
  // Defined in vtkGenericDataArray, not vtkDataArray
  virtual void FillValue(ValueType value);
#else
  void FillValue(ValueType value) override;
#endif
  void Fill(double value) override;


  ValueType* WritePointer(vtkIdType valueIdx, vtkIdType numValues);
  VTK_DEPRECATED_IN_9_7_0("Use SetNumberOfValues() and GetPointer() on AOS arrays")
  void* WriteVoidPointer(vtkIdType valueIdx, vtkIdType numValues) override;


  ValueType* GetPointer(vtkIdType valueIdx);
  void* GetVoidPointer(vtkIdType valueIdx) override;

  VTK_NEWINSTANCE
  vtkCollection* NewMemoryDescriptors() override;

#ifdef __VTK_WRAP__
  vtkAbstractBuffer* GetBuffer() { return this->Buffer; }
#else
  vtkBuffer<ValueTypeT>* GetBuffer() { return this->Buffer; }
#endif // __VTK_WRAP__
 
#ifndef __VTK_WRAP__
  void SetBuffer(vtkBuffer<ValueType>* buffer, bool updateMaxId = false);
#endif

  void SetBuffer(vtkAbstractBuffer* buffer, bool updateMaxId = false);


  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save, int deleteMethod);
  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save);
  void SetVoidArray(void* array, vtkIdType size, int save) override;
  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override;

  void SetArrayFreeFunction(void (*callback)(void*)) override;
 
  // Overridden for optimized implementations:
  void SetTuple(vtkIdType tupleIdx, const float* tuple) override;
  void SetTuple(vtkIdType tupleIdx, const double* tuple) override;
  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
  // using Superclass::SetTuple;
  void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
  {
    this->Superclass::SetTuple(dstTupleIdx, srcTupleIdx, source);
  }
  void InsertTuple(vtkIdType tupleIdx, const float* source) override;
  void InsertTuple(vtkIdType tupleIdx, const double* source) override;
  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
  // using Superclass::InsertTuple;
  void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray* source) override
  {
    this->Superclass::InsertTuple(dstTupleIdx, srcTupleIdx, source);
  }
  void InsertComponent(vtkIdType tupleIdx, int compIdx, double value) override;
  vtkIdType InsertNextTuple(const float* tuple) override;
  vtkIdType InsertNextTuple(const double* tuple) override;
  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
  // using Superclass::InsertNextTuple;
  vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray* source) override
  {
    return this->Superclass::InsertNextTuple(srcTupleIdx, source);
  }
  void GetTuple(vtkIdType tupleIdx, double* tuple) override;
  double* GetTuple(vtkIdType tupleIdx) override;

  VTK_DEPRECATED_IN_9_7_0("Use DataChanged() instead")
  void DataElementChanged(vtkIdType) { this->DataChanged(); }

  typedef ValueType* Iterator;
  Iterator Begin() { return Iterator(this->GetPointer(0)); }
  Iterator End() { return Iterator(this->GetPointer(this->MaxId + 1)); }
 
  VTK_DEPRECATED_IN_9_7_0("Use vtk::DataArrayValueRange, or the array directly")
  VTK_NEWINSTANCE vtkArrayIterator* NewIterator() override;
  bool HasStandardMemoryLayout() const override { return true; }
  void ShallowCopy(vtkDataArray* other) override;
  using vtkAbstractArray::ShallowCopy;
 
  // Reimplemented for efficiency:
  void InsertTuples(
    vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
  // MSVC doesn't like 'using' here (error C2487). Just forward instead:
  // using Superclass::InsertTuples;
  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override
  {
    this->Superclass::InsertTuples(dstIds, srcIds, source);
  }
  void InsertTuplesStartingAt(
    vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override
  {
    this->Superclass::InsertTuplesStartingAt(dstStart, srcIds, source);
  }
 
#ifdef __VTK_WRAP__
  // Add APIs inherited from vtkGenericDataArray, which is excluded from wrapping
  vtkCreateGenericWrappedArrayInterface(ValueType);
#endif
 
protected:
  vtkAOSDataArrayTemplate();
  ~vtkAOSDataArrayTemplate() override;

  VTK_DEPRECATED_IN_9_7_0("No longer needed")
  bool AllocateTuples(vtkIdType numTuples);

  bool ReallocateTuples(vtkIdType numTuples);
 
  vtkBuffer<ValueType>* Buffer;
 
private:
  vtkAOSDataArrayTemplate(const vtkAOSDataArrayTemplate&) = delete;
  void operator=(const vtkAOSDataArrayTemplate&) = delete;
 
  friend class vtkGenericDataArray<SelfType, ValueType, ArrayTypeTag::value>;
};
 
// Declare vtkArrayDownCast implementations for AoS containers:
vtkArrayDownCast_TemplateFastCastMacro(vtkAOSDataArrayTemplate);
 
VTK_ABI_NAMESPACE_END
 
// This macro is used by the subclasses to create dummy
// declarations for these functions such that the wrapper
// can see them.
//
// VTK_ZEROCOPY marks the pointers that a wrapper passes along as a bare address rather than
// copying what is behind them, since their length is not part of the signature. It reads in both
// directions: on SetArray the address is the caller's own memory, which the array borrows until
// it is handed something else; on GetPointer and WritePointer it is the array's memory, which the
// caller borrows until the array reallocates or goes away.
#define vtkCreateWrappedArrayInterface(T)                                                          \
  vtkCreateWrappedArrayReadInterface(T);                                                           \
  vtkCreateWrappedArrayWriteInterface(T);                                                          \
  VTK_ZEROCOPY T* WritePointer(vtkIdType id, vtkIdType number);                                    \
  VTK_ZEROCOPY T* GetPointer(vtkIdType id);                                                        \
  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save);                                  \
  void SetArray(VTK_ZEROCOPY T* array, vtkIdType size, int save, int deleteMethod);                \
  vtkAbstractBuffer* GetBuffer();                                                                  \
  void SetBuffer(vtkAbstractBuffer* buffer, bool updateMaxId = false)
 
#endif // header guard
 
// This portion must be OUTSIDE the include blockers. This is used to tell
// libraries other than vtkCommonCore that instantiations of
// vtkAOSDataArrayTemplate can be found externally. This prevents each library
// from instantiating these on their own.
#ifdef VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATING
#define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE(T)                                                 \
  namespace vtkDataArrayPrivate                                                                    \
  {                                                                                                \
  VTK_ABI_NAMESPACE_BEGIN                                                                          \
  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<T>, double);                        \
  VTK_ABI_NAMESPACE_END                                                                            \
  }                                                                                                \
  VTK_ABI_NAMESPACE_BEGIN                                                                          \
  template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate<T>;                                  \
  VTK_ABI_NAMESPACE_END
// We only provide these specializations for the 64-bit integer types, since
// other types can reuse the double-precision mechanism in
// vtkDataArray::GetRange without losing precision.
#define VTK_AOS_DATA_ARRAY_TEMPLATE_INSTANTIATE_VALUERANGE(T)                                      \
  namespace vtkDataArrayPrivate                                                                    \
  {                                                                                                \
  VTK_ABI_NAMESPACE_BEGIN                                                                          \
  VTK_INSTANTIATE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<T>, T);                             \
  VTK_ABI_NAMESPACE_END                                                                            \
  }
// MinGW GCC does not reliably export inline member functions (such as IsTypeOf
// defined by vtkTemplateTypeMacro above) when using template class __declspec(dllexport)
// with extern template. This guard is applied here rather than in other VTK places
// with #elif defined(VTK_USE_EXTERN_TEMPLATE) because only these three DataArrayTemplate
// classes combine extern template with vtkTemplateTypeMacro inline functions in the class
// body; other VTK template classes using this pattern (e.g. vtkConstantArray,
// vtkAffineArray) use vtkImplicitArrayTypeMacro instead and were not observed with this
// MinGW issue.
#elif defined(VTK_USE_EXTERN_TEMPLATE) && !defined(__MINGW32__)
#ifndef VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
#define VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
#ifdef _MSC_VER
#pragma warning(push)
// The following is needed when the vtkAOSDataArrayTemplate is declared
// dllexport and is used from another class in vtkCommonCore
#pragma warning(disable : 4910) // extern and dllexport incompatible
#endif
VTK_ABI_NAMESPACE_BEGIN
vtkExternTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
VTK_ABI_NAMESPACE_END
 
namespace vtkDataArrayPrivate
{
VTK_ABI_NAMESPACE_BEGIN
 
// These are instantiated in vtkGenericDataArrayValueRange${i}.cxx
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<long>, long)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned long>, unsigned long)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<long long>, long long)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned long long>, unsigned long long)
// These are instantiated in vtkFloatArray.cxx, vtkDoubleArray.cxx, etc
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<float>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<double>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<char>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<signed char>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned char>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<short>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned short>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<int>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned int>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<long>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned long>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<long long>, double)
VTK_DECLARE_VALUERANGE_ARRAYTYPE(vtkAOSDataArrayTemplate<unsigned long long>, double)
 
VTK_ABI_NAMESPACE_END
} // namespace vtkDataArrayPrivate
 
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#endif // VTK_AOS_DATA_ARRAY_TEMPLATE_EXTERN
 
// The following clause is only for MSVC
#elif defined(_MSC_VER) && !defined(VTK_BUILD_SHARED_LIBS)
#pragma warning(push)
 
// C4091: 'extern ' : ignored on left of 'int' when no variable is declared
#pragma warning(disable : 4091)
 
// Compiler-specific extension warning.
#pragma warning(disable : 4231)
 
// We need to disable warning 4910 and do an extern dllexport
// anyway.  When deriving vtkCharArray and other types from an
// instantiation of this template the compiler does an explicit
// instantiation of the base class.  From outside the vtkCommon
// library we block this using an extern dllimport instantiation.
// For classes inside vtkCommon we should be able to just do an
// extern instantiation, but VS complains about missing
// definitions.  We cannot do an extern dllimport inside vtkCommon
// since the symbols are local to the dll.  An extern dllexport
// seems to be the only way to convince VS to do the right
// thing, so we just disable the warning.
#pragma warning(disable : 4910) // extern and dllexport incompatible
 
// Use an "extern explicit instantiation" to give the class a DLL
// interface.  This is a compiler-specific extension.
VTK_ABI_NAMESPACE_BEGIN
vtkInstantiateTemplateMacro(extern template class VTKCOMMONCORE_EXPORT vtkAOSDataArrayTemplate);
VTK_ABI_NAMESPACE_END
 
#pragma warning(pop)
 
#endif
 
// VTK-HeaderTest-Exclude: vtkAOSDataArrayTemplate.h