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 "vtkCommonCoreModule.h" // For export macro
#include "vtkDataArray.h"
 
#include <cassert> // for assert
 
VTK_ABI_NAMESPACE_BEGIN
class vtkBitArrayLookup;
 
class VTKCOMMONCORE_EXPORT 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::BitArray>;
  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 Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
 
  void Initialize() 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; }
 
  void SetNumberOfTuples(vtkIdType number) override;
 
  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;
 
  double* GetTuple(vtkIdType i) override;
 
  void GetTuple(vtkIdType i, double* tuple) override;
 
 
  void SetTuple(vtkIdType i, const float* tuple) override;
  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;
  void RemoveFirstTuple() override;
  void RemoveLastTuple() override;
 
  void SetComponent(vtkIdType i, int j, double c) override;
 
  void Squeeze() override;
 
  vtkTypeBool Resize(vtkIdType numTuples) override;
 
  int GetValue(vtkIdType id) const;
 
  void SetValue(vtkIdType id, int value);
 
  void InsertValue(vtkIdType id, int i);
 
  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;
 
  ValueType* GetPointer(vtkIdType id) { return this->Array + id / 8; }
 
  ValueType* WritePointer(vtkIdType id, vtkIdType number);
 
  void* WriteVoidPointer(vtkIdType id, vtkIdType number) override
  {
    return this->WritePointer(id, number);
  }
 
  void* GetVoidPointer(vtkIdType id) override { return static_cast<void*>(this->GetPointer(id)); }
 
  void DeepCopy(vtkDataArray* da) override;
  void DeepCopy(vtkAbstractArray* aa) override { this->Superclass::DeepCopy(aa); }
 
 
#ifndef __VTK_WRAP__
  void SetArray(
    ValueType* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
#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_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();
 
  ValueType* Array; // pointer to data
  ValueType* ResizeAndExtend(vtkIdType sz);
  // function to resize data
 
  int TupleSize; // used for data conversion
  double* Tuple;
 
  void (*DeleteFunction)(void*);
 
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->Array[bitsetId] = static_cast<ValueType>(
    (value != 0) ? (this->Array[bitsetId] | mask) : (this->Array[bitsetId] & (~mask)));
  this->DataChanged();
}
 
inline void vtkBitArray::InsertValue(vtkIdType id, int value)
{
  if (id >= this->Size)
  {
    if (!this->ResizeAndExtend(id + 1))
    {
      return;
    }
  }
  this->SetValue(id, value);
  if (id > this->MaxId)
  {
    this->MaxId = id;
    this->InitializeUnusedBitsInLastByte();
  }
  this->DataChanged();
}
 
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);
  this->DataChanged();
  return this->MaxId;
}
 
inline void vtkBitArray::Squeeze()
{
  this->ResizeAndExtend(this->MaxId + 1);
}
VTK_ABI_NAMESPACE_END
#endif