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 "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:

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

  void Initialize();

  int Allocate(vtkIdType sz, int strategy = 0);

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

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

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

  void SetNumberOfIds(vtkIdType number);

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

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

  vtkIdType InsertNextId(vtkIdType vtkid);

  vtkIdType InsertUniqueId(vtkIdType vtkid);

  void Sort();

  void Fill(vtkIdType value);

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

  vtkIdType* WritePointer(vtkIdType i, vtkIdType number);

  void SetArray(vtkIdType* array, vtkIdType size, bool save = true);

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

  void Squeeze() { this->Resize(this->NumberOfIds); }

  void DeepCopy(vtkIdList* ids);

  void DeleteId(vtkIdType vtkid);

  vtkIdType IsId(vtkIdType vtkid) VTK_FUTURE_CONST;

  void IntersectWith(vtkIdList* otherIds);

  vtkIdType* Resize(vtkIdType sz);
 
#ifndef __VTK_WRAP__
  vtkIdType* Release();
#endif


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

  bool AllocateInternal(vtkIdType sz, vtkIdType numberOfIds);
  void InitializeMemory();
 
  vtkIdType NumberOfIds;
  vtkIdType Size;
  vtkIdType* Ids;
  bool ManageMemory;
 
private:
  vtkIdList(const vtkIdList&) = delete;
  void operator=(const vtkIdList&) = delete;
};
 
// In-lined for performance
inline void vtkIdList::InsertId(const vtkIdType i, const vtkIdType vtkid)
{
  if (i >= this->Size)
  {
    this->Resize(i + 1);
  }
  this->Ids[i] = vtkid;
  if (i >= this->NumberOfIds)
  {
    this->NumberOfIds = i + 1;
  }
}
 
// In-lined for performance
inline vtkIdType vtkIdList::InsertNextId(const vtkIdType vtkid)
{
  if (this->NumberOfIds >= this->Size)
  {
    if (!this->Resize(2 * this->NumberOfIds + 1)) // grow by factor of 2
    {
      return this->NumberOfIds - 1;
    }
  }
  this->Ids[this->NumberOfIds++] = vtkid;
  return this->NumberOfIds - 1;
}
 
inline vtkIdType vtkIdList::IsId(vtkIdType vtkid) VTK_FUTURE_CONST
{
  vtkIdType *ptr, i;
  for (ptr = this->Ids, i = 0; i < this->NumberOfIds; i++, ptr++)
  {
    if (vtkid == *ptr)
    {
      return i;
    }
  }
  return (-1);
}
 
VTK_ABI_NAMESPACE_END
#endif