VTK  9.0.20210308
vtkIdList.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkIdList.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
24 #ifndef vtkIdList_h
25 #define vtkIdList_h
26 
27 #include "vtkCommonCoreModule.h" // For export macro
28 #include "vtkObject.h"
29 
30 class VTKCOMMONCORE_EXPORT vtkIdList : public vtkObject
31 {
32 public:
34 
37  static vtkIdList* New();
38  vtkTypeMacro(vtkIdList, vtkObject);
39  void PrintSelf(ostream& os, vtkIndent indent) override;
41 
45  void Initialize();
46 
52  int Allocate(const vtkIdType sz, const int strategy = 0);
53 
57  vtkIdType GetNumberOfIds() { return this->NumberOfIds; }
58 
62  vtkIdType GetId(const vtkIdType i) VTK_EXPECTS(0 <= i && i < GetNumberOfIds())
63  {
64  return this->Ids[i];
65  }
66 
71  {
72  for (int i = 0; i < this->NumberOfIds; i++)
73  if (this->Ids[i] == id)
74  return i;
75  return -1;
76  }
77 
82  void SetNumberOfIds(const vtkIdType number);
83 
89  void SetId(const vtkIdType i, const vtkIdType vtkid) VTK_EXPECTS(0 <= i && i < GetNumberOfIds())
90  {
91  this->Ids[i] = vtkid;
92  }
93 
98  void InsertId(const vtkIdType i, const vtkIdType vtkid) VTK_EXPECTS(0 <= i);
99 
103  vtkIdType InsertNextId(const vtkIdType vtkid);
104 
110 
115  void Sort();
116 
120  vtkIdType* GetPointer(const vtkIdType i) { return this->Ids + i; }
121 
127  vtkIdType* WritePointer(const vtkIdType i, const vtkIdType number);
128 
135 
139  void Reset() { this->NumberOfIds = 0; }
140 
144  void Squeeze() { this->Resize(this->NumberOfIds); }
145 
149  void DeepCopy(vtkIdList* ids);
150 
154  void DeleteId(vtkIdType vtkid);
155 
160  vtkIdType IsId(vtkIdType vtkid);
161 
166  void IntersectWith(vtkIdList* otherIds);
167 
173 
177  void IntersectWith(vtkIdList& otherIds) { this->IntersectWith(&otherIds); }
178 
179 #ifndef __VTK_WRAP__
180 
187 #endif
188 
190 
193  vtkIdType* begin() { return this->Ids; }
194  vtkIdType* end() { return this->Ids + this->NumberOfIds; }
195  const vtkIdType* begin() const { return this->Ids; }
196  const vtkIdType* end() const { return this->Ids + this->NumberOfIds; }
198 protected:
200  ~vtkIdList() override;
201 
205 
206 private:
207  vtkIdList(const vtkIdList&) = delete;
208  void operator=(const vtkIdList&) = delete;
209 };
210 
211 // In-lined for performance
212 inline void vtkIdList::InsertId(const vtkIdType i, const vtkIdType vtkid)
213 {
214  if (i >= this->Size)
215  {
216  this->Resize(i + 1);
217  }
218  this->Ids[i] = vtkid;
219  if (i >= this->NumberOfIds)
220  {
221  this->NumberOfIds = i + 1;
222  }
223 }
224 
225 // In-lined for performance
227 {
228  if (this->NumberOfIds >= this->Size)
229  {
230  if (!this->Resize(2 * this->NumberOfIds + 1)) // grow by factor of 2
231  {
232  return this->NumberOfIds - 1;
233  }
234  }
235  this->Ids[this->NumberOfIds++] = vtkid;
236  return this->NumberOfIds - 1;
237 }
238 
240 {
241  vtkIdType *ptr, i;
242  for (ptr = this->Ids, i = 0; i < this->NumberOfIds; i++, ptr++)
243  {
244  if (vtkid == *ptr)
245  {
246  return i;
247  }
248  }
249  return (-1);
250 }
251 
252 #endif
vtkIdList::Allocate
int Allocate(const vtkIdType sz, const int strategy=0)
Allocate a capacity for sz ids in the list and set the number of stored ids in the list to 0.
vtkIdList::IntersectWith
void IntersectWith(vtkIdList *otherIds)
Intersect this list with another vtkIdList.
vtkIdList::DeepCopy
void DeepCopy(vtkIdList *ids)
Copy an id list by explicitly copying the internal array.
vtkIdList::InsertUniqueId
vtkIdType InsertUniqueId(const vtkIdType vtkid)
If id is not already in list, insert it and return location in list.
VTK_EXPECTS
#define VTK_EXPECTS(x)
Definition: vtkWrappingHints.h:44
vtkIdList::New
static vtkIdList * New()
Standard methods for instantiation, type information, and printing.
vtkIdType
int vtkIdType
Definition: vtkType.h:338
vtkIdList::InsertId
void InsertId(const vtkIdType i, const vtkIdType vtkid)
Set the id at location i.
Definition: vtkIdList.h:212
vtkIdList::begin
const vtkIdType * begin() const
Definition: vtkIdList.h:195
vtkIdList::end
vtkIdType * end()
Definition: vtkIdList.h:194
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:63
vtkIdList::Squeeze
void Squeeze()
Free any unused memory.
Definition: vtkIdList.h:144
vtkIdList::Sort
void Sort()
Sort the ids in the list in ascending id order.
vtkIdList::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkIdList::FindIdLocation
vtkIdType FindIdLocation(const vtkIdType id)
Find the location i of the provided id.
Definition: vtkIdList.h:70
vtkIdList::Resize
vtkIdType * Resize(const vtkIdType sz)
Adjust the size of the id list while maintaining its content (except when being truncated).
vtkIdList::~vtkIdList
~vtkIdList() override
vtkIdList::SetId
void SetId(const vtkIdType i, const vtkIdType vtkid)
Set the id at location i.
Definition: vtkIdList.h:89
vtkIdList::WritePointer
vtkIdType * WritePointer(const vtkIdType i, const vtkIdType number)
Get a pointer to a particular data index.
vtkIdList::InsertNextId
vtkIdType InsertNextId(const vtkIdType vtkid)
Add the id specified to the end of the list.
Definition: vtkIdList.h:226
vtkIdList::Initialize
void Initialize()
Release memory and restore to unallocated state.
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:34
vtkIdList::end
const vtkIdType * end() const
Definition: vtkIdList.h:196
vtkIdList::GetId
vtkIdType GetId(const vtkIdType i)
Return the id at location i.
Definition: vtkIdList.h:62
vtkIdList
list of point or cell ids
Definition: vtkIdList.h:31
vtkIdList::DeleteId
void DeleteId(vtkIdType vtkid)
Delete specified id from list.
vtkX3D::size
@ size
Definition: vtkX3D.h:259
vtkIdList::Ids
vtkIdType * Ids
Definition: vtkIdList.h:204
vtkObject.h
vtkIdList::vtkIdList
vtkIdList()
vtkIdList::Release
vtkIdType * Release()
This releases the ownership of the internal vtkIdType array and returns the pointer to it.
vtkIdList::begin
vtkIdType * begin()
To support range-based for loops.
Definition: vtkIdList.h:193
vtkIdList::SetArray
void SetArray(vtkIdType *array, vtkIdType size)
Specify an array of vtkIdType to use as the id list.
vtkIdList::GetPointer
vtkIdType * GetPointer(const vtkIdType i)
Get a pointer to a particular data index.
Definition: vtkIdList.h:120
vtkIdList::SetNumberOfIds
void SetNumberOfIds(const vtkIdType number)
Specify the number of ids for this object to hold.
vtkIdList::IntersectWith
void IntersectWith(vtkIdList &otherIds)
Intersect one id list with another.
Definition: vtkIdList.h:177
vtkIdList::IsId
vtkIdType IsId(vtkIdType vtkid)
Return -1 if id specified is not contained in the list; otherwise return the position in the list.
Definition: vtkIdList.h:239
vtkIdList::NumberOfIds
vtkIdType NumberOfIds
Definition: vtkIdList.h:202
vtkIdList::Size
vtkIdType Size
Definition: vtkIdList.h:203
vtkIdList::GetNumberOfIds
vtkIdType GetNumberOfIds()
Return the number of id's in the list.
Definition: vtkIdList.h:57
vtkIdList::Reset
void Reset()
Reset to an empty state but retain previously allocated memory.
Definition: vtkIdList.h:139