vtkIdList.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 vtkIdList_h
#define vtkIdList_h

#include "vtkAbstractArray.h"    // For vtkAbstractArray::DeleteMethod
#include "vtkBuffer.h"           // For vtkBuffer
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT VTK_MARSHALAUTO vtkIdList : public vtkObject
{
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
  };


  static vtkIdList* New();
  vtkTypeMacro(vtkIdList, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize();

  VTK_DEPRECATED_IN_9_7_0("Use Reserve() to allocate or Initialize() to deallocate.")
  vtkTypeBool Allocate(vtkIdType size, int strategy = 0);

  vtkTypeBool Reserve(vtkIdType size);

  vtkIdType GetNumberOfIds() const noexcept { return this->NumberOfIds; }

  vtkIdType GetId(vtkIdType i) VTK_EXPECTS(0 <= i && i < GetNumberOfIds())
  {
    return this->Buffer->GetBuffer()[i];
  }

  vtkIdType FindIdLocation(const vtkIdType id)
  {
    for (int i = 0; i < this->NumberOfIds; i++)
    {
      if (this->Buffer->GetBuffer()[i] == id)
      {
        return i;
      }
    }
    return -1;
  }

  void SetNumberOfIds(vtkIdType number);

  void SetId(vtkIdType i, vtkIdType id) VTK_EXPECTS(0 <= i && i < GetNumberOfIds())
  {
    this->Buffer->GetBuffer()[i] = id;
  }

  void InsertId(vtkIdType i, vtkIdType id) VTK_EXPECTS(0 <= i);

  vtkIdType InsertNextId(vtkIdType id);

  vtkIdType InsertUniqueId(vtkIdType id);

  void Sort();

  void Fill(vtkIdType value);

  vtkIdType* GetPointer(vtkIdType i) { return this->Buffer->GetBuffer() + i; }

  vtkIdType* WritePointer(vtkIdType i, vtkIdType number);

  void SetList(
    vtkIdType* array, vtkIdType size, bool save, int deleteMethod = VTK_DATA_ARRAY_DELETE);

  VTK_DEPRECATED_IN_9_7_0("Use SetList instead")
  void SetArray(vtkIdType* array, vtkIdType size, bool manageMemory = true);

  void Reset() { this->NumberOfIds = 0; }

  void Squeeze();

  void ShallowCopy(vtkIdList* list);

  void DeepCopy(vtkIdList* ids);

  void DeleteId(vtkIdType id);

  vtkIdType IsId(vtkIdType id) VTK_FUTURE_CONST;

  void IntersectWith(vtkIdList* otherIds);

  VTK_DEPRECATED_IN_9_7_0("Use Reserve, Squeeze or Initialize")
  vtkIdType* Resize(vtkIdType sz);

#ifndef __VTK_WRAP__

  vtkIdType* Release();
#endif

  vtkIdType GetCapacity() const { return this->Buffer->GetNumberOfElements(); }


  vtkIdType* begin() { return this->Buffer->GetBuffer(); }
  vtkIdType* end() { return this->Buffer->GetBuffer() + this->NumberOfIds; }
  const vtkIdType* begin() const { return this->Buffer->GetBuffer(); }
  const vtkIdType* end() const { return this->Buffer->GetBuffer() + this->NumberOfIds; }
protected:
  vtkIdList();
  ~vtkIdList() override;

  VTK_DEPRECATED_IN_9_7_0("Use Allocate and SetNumberOfIds instead")
  bool AllocateInternal(vtkIdType sz, vtkIdType numberOfIds);
  VTK_DEPRECATED_IN_9_7_0("Use Allocate(0) instead")
  void InitializeMemory();

  vtkIdType NumberOfIds;
  vtkBuffer<vtkIdType>* Buffer;
  vtkIdType Size VTK_DEPRECATED_IN_9_7_0("Use GetCapacity() instead");

private:
  vtkIdList(const vtkIdList&) = delete;
  void operator=(const vtkIdList&) = delete;
};

// In-lined for performance
inline void vtkIdList::InsertId(const vtkIdType i, const vtkIdType id)
{
  if (i >= this->GetCapacity())
  {
    this->Reserve(i + 1);
  }
  this->Buffer->GetBuffer()[i] = id;
  if (i >= this->NumberOfIds)
  {
    this->NumberOfIds = i + 1;
  }
}

// In-lined for performance
inline vtkIdType vtkIdList::InsertNextId(const vtkIdType id)
{
  if (this->NumberOfIds >= this->GetCapacity())
  {
    if (!this->Reserve(this->NumberOfIds + 1))
    {
      return this->NumberOfIds - 1;
    }
  }
  this->Buffer->GetBuffer()[this->NumberOfIds++] = id;
  return this->NumberOfIds - 1;
}

inline vtkIdType vtkIdList::IsId(vtkIdType id) VTK_FUTURE_CONST
{
  for (vtkIdType i = 0; i < this->NumberOfIds; ++i)
  {
    if (this->Buffer->GetBuffer()[i] == id)
    {
      return i;
    }
  }
  return -1;
}

VTK_ABI_NAMESPACE_END
#endif