vtkBitArray.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 vtkBitArray_h
#define vtkBitArray_h
 
#include "vtkBuffer.h"           // For vtkBuffer
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDataArray.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
#include <cassert> // for assert
#include <vector>  // for vector
 
VTK_ABI_NAMESPACE_BEGIN
class vtkBitArrayLookup;
 
class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkBitArray : public vtkDataArray
{
public:
  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
  };
  using ArrayTypeTag = std::integral_constant<int, vtkArrayTypes::VTK_BIT_ARRAY>;
  using DataTypeTag = std::integral_constant<int, VTK_BIT>;
  using ValueType = unsigned char;
 
  static vtkBitArray* New();
  vtkTypeMacro(vtkBitArray, vtkDataArray);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkBitArray* FastDownCast(vtkAbstractArray* source);

  vtkTypeBool ReserveTuples(vtkIdType numTuples) override;
 
  // satisfy vtkDataArray API
  int GetArrayType() const override { return vtkBitArray::ArrayTypeTag::value; }
  int GetDataType() const override { return vtkBitArray::DataTypeTag::value; }
  int GetDataTypeSize() const override { return 0; }

  bool SetNumberOfValues(vtkIdType number) override;

  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;

  void InsertTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;

  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;

  void InsertTuplesStartingAt(
    vtkIdType dstStart, vtkIdList* srcIds, vtkAbstractArray* source) override;

  void InsertTuples(
    vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;

  vtkIdType InsertNextTuple(vtkIdType j, vtkAbstractArray* source) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  double* GetTuple(vtkIdType i) override;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void GetTuple(vtkIdType i, double* tuple) override;


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetTuple(vtkIdType i, const float* tuple) override;
  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetTuple(vtkIdType i, const double* tuple) override;


  void InsertTuple(vtkIdType i, const float* tuple) override;
  void InsertTuple(vtkIdType i, const double* tuple) override;


  vtkIdType InsertNextTuple(const float* tuple) override;
  vtkIdType InsertNextTuple(const double* tuple) override;


  void RemoveTuple(vtkIdType id) override;


  double GetComponent(vtkIdType tupleIdx, int compIdx) override;
  void SetComponent(vtkIdType i, int j, double c) override;

  void Squeeze() override;

  ValueType GetTypedComponent(vtkIdType tupleIdx, int comp) const
    VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + comp < GetNumberOfValues())
      VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents());


  void SetTypedComponent(vtkIdType tupleIdx, int comp, ValueType value)
    VTK_EXPECTS(0 <= tupleIdx && GetNumberOfComponents() * tupleIdx + comp < GetNumberOfValues())
      VTK_EXPECTS(0 <= comp && comp < GetNumberOfComponents());


  void GetTypedTuple(vtkIdType tupleIdx, ValueType* tuple) const VTK_EXPECTS(
    0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) VTK_SIZEHINT(tuple, GetNumberOfComponents());


  void SetTypedTuple(vtkIdType tupleIdx, const ValueType* tuple) VTK_EXPECTS(
    0 <= tupleIdx && tupleIdx < GetNumberOfTuples()) VTK_SIZEHINT(tuple, GetNumberOfComponents());

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  int GetValue(vtkIdType id) const;

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetValue(vtkIdType id, int value);

  void InsertValue(vtkIdType id, int i);

  vtkVariant GetVariantValue(vtkIdType idx) override;

  void SetVariantValue(vtkIdType idx, vtkVariant value) override;

  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
 
  vtkIdType InsertNextValue(int i);

  void InsertComponent(vtkIdType i, int j, double c) override;

  VTK_ZEROCOPY ValueType* GetPointer(vtkIdType id) { return this->Buffer->GetBuffer() + id / 8; }

  VTK_ZEROCOPY ValueType* WritePointer(vtkIdType id, vtkIdType number);
 
  VTK_DEPRECATED_IN_9_7_0("Use vtkBitArray::WritePointer(valueIdx, numValues) or "
                          "vtkAbstractArray::SetNumberOf[Values/Tuples]() instead")
  void* WriteVoidPointer(vtkIdType id, vtkIdType number) override
  {
    return this->WritePointer(id, number);
  }
 
  void* GetVoidPointer(vtkIdType id) override { return static_cast<void*>(this->GetPointer(id)); }

#ifdef __VTK_WRAP__
  vtkAbstractBuffer* GetBuffer() { return this->Buffer; }
#else
  vtkBuffer<ValueType>* GetBuffer() { return this->Buffer; }
#endif // __VTK_WRAP__


  void DeepCopy(vtkDataArray* da) override;
  void DeepCopy(vtkAbstractArray* aa) override { this->Superclass::DeepCopy(aa); }

  void ShallowCopy(vtkDataArray* da) override;
  using vtkAbstractArray::ShallowCopy;


#ifndef __VTK_WRAP__
  void SetArray(
    ValueType* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
#else
  // the wrappers do not handle a default argument, so the overloads are spelled out for them.
  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save);
  void SetArray(VTK_ZEROCOPY ValueType* array, vtkIdType size, int save, int deleteMethod);
#endif
  void SetVoidArray(void* array, vtkIdType size, int save) override
  {
    this->SetArray(static_cast<ValueType*>(array), size, save);
  }
  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
  {
    this->SetArray(static_cast<ValueType*>(array), size, save, deleteMethod);
  }


  void SetArrayFreeFunction(void (*callback)(void*)) override;

  VTK_DEPRECATED_IN_9_7_0("Use vtk::DataArrayValueRange, or the array directly")
  VTK_NEWINSTANCE vtkArrayIterator* NewIterator() override;


  vtkIdType LookupValue(vtkVariant value) override;
  void LookupValue(vtkVariant value, vtkIdList* ids) override;
  vtkIdType LookupValue(int value);
  void LookupValue(int value, vtkIdList* ids);

  void DataChanged() override;

  void ClearLookup() override;
 
protected:
  vtkBitArray();
  ~vtkBitArray() override;

  virtual void InitializeUnusedBitsInLastByte();

  bool ReallocateTuples(vtkIdType numTuples);
 
  vtkBuffer<ValueType>* Buffer; // pointer to data
  std::vector<double> LegacyTuple;

  VTK_DEPRECATED_IN_9_7_0("Use ReserveTuples")
  ValueType* ResizeAndExtend(vtkIdType size)
  {
    if (!this->ReserveTuples(size / this->NumberOfComponents + 1))
    {
      return nullptr;
    }
    return this->Buffer->GetBuffer();
  }
 
private:
  // hide superclass' DeepCopy() from the user and the compiler
  void DeepCopy(vtkDataArray& da) { this->vtkDataArray::DeepCopy(&da); }
 
  vtkBitArray(const vtkBitArray&) = delete;
  void operator=(const vtkBitArray&) = delete;
 
  vtkBitArrayLookup* Lookup;
  void UpdateLookup();
};
 
// Declare vtkArrayDownCast implementations for vtkBitArray:
vtkArrayDownCast_FastCastMacro(vtkBitArray);
 
inline void vtkBitArray::SetValue(vtkIdType id, int value)
{
  const auto bitsetDiv = std::div(id, static_cast<vtkIdType>(8));
  const vtkIdType &bitsetId = bitsetDiv.quot, &bitId = bitsetDiv.rem;
  ValueType mask = 0x80 >> bitId; // NOLINT(clang-analyzer-core.BitwiseShift)
  this->Buffer->GetBuffer()[bitsetId] =
    static_cast<ValueType>((value != 0) ? (this->Buffer->GetBuffer()[bitsetId] | mask)
                                        : (this->Buffer->GetBuffer()[bitsetId] & (~mask)));
  this->DataChanged();
}
 
inline void vtkBitArray::InsertValue(vtkIdType valueIdx, int value)
{
  if (valueIdx >= this->Capacity)
  {
    if (!this->ReserveTuples((valueIdx + 1) / this->NumberOfComponents + 1))
    {
      return;
    }
  }
  this->SetValue(valueIdx, value);
  if (valueIdx > this->MaxId)
  {
    this->MaxId = valueIdx;
    this->InitializeUnusedBitsInLastByte();
  }
}
 
inline vtkVariant vtkBitArray::GetVariantValue(vtkIdType id)
{
  return vtkVariant(this->GetValue(id));
}
 
inline void vtkBitArray::SetVariantValue(vtkIdType id, vtkVariant value)
{
  this->SetValue(id, value.ToInt());
}
 
inline void vtkBitArray::InsertVariantValue(vtkIdType id, vtkVariant value)
{
  this->InsertValue(id, value.ToInt());
}
 
inline vtkIdType vtkBitArray::InsertNextValue(int i)
{
  this->InsertValue(this->MaxId + 1, i);
  return this->MaxId;
}
VTK_ABI_NAMESPACE_END
#endif