VTK  9.0.1
vtkBitArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBitArray.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 =========================================================================*/
25 #ifndef vtkBitArray_h
26 #define vtkBitArray_h
27 
28 #include "vtkCommonCoreModule.h" // For export macro
29 #include "vtkDataArray.h"
30 
31 class vtkBitArrayLookup;
32 
33 class VTKCOMMONCORE_EXPORT vtkBitArray : public vtkDataArray
34 {
35 public:
37  {
39  VTK_DATA_ARRAY_DELETE = vtkAbstractArray::VTK_DATA_ARRAY_DELETE,
40  VTK_DATA_ARRAY_ALIGNED_FREE = vtkAbstractArray::VTK_DATA_ARRAY_ALIGNED_FREE,
41  VTK_DATA_ARRAY_USER_DEFINED = vtkAbstractArray::VTK_DATA_ARRAY_USER_DEFINED
42  };
43 
44  static vtkBitArray* New();
45  vtkTypeMacro(vtkBitArray, vtkDataArray);
46  void PrintSelf(ostream& os, vtkIndent indent) override;
47 
52  vtkTypeBool Allocate(vtkIdType sz, vtkIdType ext = 1000) override;
53 
57  void Initialize() override;
58 
59  // satisfy vtkDataArray API
60  int GetDataType() const override { return VTK_BIT; }
61  int GetDataTypeSize() const override { return 0; }
62 
66  void SetNumberOfTuples(vtkIdType number) override;
67 
74  void SetTuple(vtkIdType i, vtkIdType j, vtkAbstractArray* source) override;
75 
81 
87  void InsertTuples(vtkIdList* dstIds, vtkIdList* srcIds, vtkAbstractArray* source) override;
88 
94  void InsertTuples(
95  vtkIdType dstStart, vtkIdType n, vtkIdType srcStart, vtkAbstractArray* source) override;
96 
103 
108  double* GetTuple(vtkIdType i) override;
109 
113  void GetTuple(vtkIdType i, double* tuple) override;
114 
116 
119  void SetTuple(vtkIdType i, const float* tuple) override;
120  void SetTuple(vtkIdType i, const double* tuple) override;
122 
124 
128  void InsertTuple(vtkIdType i, const float* tuple) override;
129  void InsertTuple(vtkIdType i, const double* tuple) override;
131 
133 
136  vtkIdType InsertNextTuple(const float* tuple) override;
137  vtkIdType InsertNextTuple(const double* tuple) override;
139 
141 
146  void RemoveTuple(vtkIdType id) override;
147  void RemoveFirstTuple() override;
148  void RemoveLastTuple() override;
150 
157  void SetComponent(vtkIdType i, int j, double c) override;
158 
162  void Squeeze() override;
163 
167  vtkTypeBool Resize(vtkIdType numTuples) override;
168 
172  int GetValue(vtkIdType id) const;
173 
178  void SetValue(vtkIdType id, int value);
179 
183  void InsertValue(vtkIdType id, int i);
184 
188  void SetVariantValue(vtkIdType idx, vtkVariant value) override;
189 
193  void InsertVariantValue(vtkIdType idx, vtkVariant value) override;
194 
195  vtkIdType InsertNextValue(int i);
196 
201  void InsertComponent(vtkIdType i, int j, double c) override;
202 
206  unsigned char* GetPointer(vtkIdType id) { return this->Array + id / 8; }
207 
213  unsigned char* WritePointer(vtkIdType id, vtkIdType number);
214 
215  void* WriteVoidPointer(vtkIdType id, vtkIdType number) override
216  {
217  return this->WritePointer(id, number);
218  }
219 
220  void* GetVoidPointer(vtkIdType id) override { return static_cast<void*>(this->GetPointer(id)); }
221 
225  void DeepCopy(vtkDataArray* da) override;
226  void DeepCopy(vtkAbstractArray* aa) override { this->Superclass::DeepCopy(aa); }
227 
229 
240 #ifndef __VTK_WRAP__
241  void SetArray(
242  unsigned char* array, vtkIdType size, int save, int deleteMethod = VTK_DATA_ARRAY_DELETE);
243 #endif
244  void SetVoidArray(void* array, vtkIdType size, int save) override
245  {
246  this->SetArray(static_cast<unsigned char*>(array), size, save);
247  }
248  void SetVoidArray(void* array, vtkIdType size, int save, int deleteMethod) override
249  {
250  this->SetArray(static_cast<unsigned char*>(array), size, save, deleteMethod);
251  }
253 
260  void SetArrayFreeFunction(void (*callback)(void*)) override;
261 
266 
268 
272  void LookupValue(vtkVariant value, vtkIdList* ids) override;
274  void LookupValue(int value, vtkIdList* ids);
276 
285  void DataChanged() override;
286 
292  void ClearLookup() override;
293 
294 protected:
295  vtkBitArray();
296  ~vtkBitArray() override;
297 
298  unsigned char* Array; // pointer to data
299  unsigned char* ResizeAndExtend(vtkIdType sz);
300  // function to resize data
301 
302  int TupleSize; // used for data conversion
303  double* Tuple;
304 
305  void (*DeleteFunction)(void*);
306 
307 private:
308  // hide superclass' DeepCopy() from the user and the compiler
309  void DeepCopy(vtkDataArray& da) { this->vtkDataArray::DeepCopy(&da); }
310 
311 private:
312  vtkBitArray(const vtkBitArray&) = delete;
313  void operator=(const vtkBitArray&) = delete;
314 
315  vtkBitArrayLookup* Lookup;
316  void UpdateLookup();
317 };
318 
320 {
321  if (value)
322  {
323  this->Array[id / 8] = static_cast<unsigned char>(this->Array[id / 8] | (0x80 >> id % 8));
324  }
325  else
326  {
327  this->Array[id / 8] = static_cast<unsigned char>(this->Array[id / 8] & (~(0x80 >> id % 8)));
328  }
329  this->DataChanged();
330 }
331 
332 inline void vtkBitArray::InsertValue(vtkIdType id, int i)
333 {
334  if (id >= this->Size)
335  {
336  if (!this->ResizeAndExtend(id + 1))
337  {
338  return;
339  }
340  }
341  if (i)
342  {
343  this->Array[id / 8] = static_cast<unsigned char>(this->Array[id / 8] | (0x80 >> id % 8));
344  }
345  else
346  {
347  this->Array[id / 8] = static_cast<unsigned char>(this->Array[id / 8] & (~(0x80 >> id % 8)));
348  }
349  if (id > this->MaxId)
350  {
351  this->MaxId = id;
352  }
353  this->DataChanged();
354 }
355 
357 {
358  this->SetValue(id, value.ToInt());
359 }
360 
362 {
363  this->InsertValue(id, value.ToInt());
364 }
365 
367 {
368  this->InsertValue(++this->MaxId, i);
369  this->DataChanged();
370  return this->MaxId;
371 }
372 
373 inline void vtkBitArray::Squeeze()
374 {
375  this->ResizeAndExtend(this->MaxId + 1);
376 }
377 
378 #endif
void Squeeze() override
Free any unneeded memory.
Definition: vtkBitArray.h:373
virtual void DataChanged()=0
Tell the array explicitly that the data has changed.
virtual void DeepCopy(vtkAbstractArray *da)
Deep copy of data.
void SetVariantValue(vtkIdType idx, vtkVariant value) override
Set a value in the array from a variant.
Definition: vtkBitArray.h:356
Abstract superclass for all arrays.
virtual vtkIdType LookupValue(vtkVariant value)=0
Return the value indices where a specific value appears.
virtual double * GetTuple(vtkIdType tupleIdx)=0
Get the data tuple at tupleIdx.
int GetDataTypeSize() const override
Return the size of the underlying data type.
Definition: vtkBitArray.h:61
void SetTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Set the tuple at dstTupleIdx in this array to the tuple at srcTupleIdx in the source array...
void InsertTuple(vtkIdType dstTupleIdx, vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple at srcTupleIdx in the source array into this array at dstTupleIdx.
int ToInt(bool *valid) const
Convert the variant to a numeric type: If it holds a numeric, cast to the appropriate type...
int vtkIdType
Definition: vtkType.h:338
int GetDataType() const override
Return the underlying data type.
Definition: vtkBitArray.h:60
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph *>::edge_descriptor e, vtkGraph *)
void DeepCopy(vtkAbstractArray *aa) override
Deep copy of data.
void InsertValue(vtkIdType id, int i)
Inserts values and checks to make sure there is enough memory.
Definition: vtkBitArray.h:332
virtual void Initialize()=0
Release storage and reset array to initial state.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void RemoveLastTuple()
These methods remove tuples from the data array.
A atomic type representing the union of many types.
Definition: vtkVariant.h:65
void SetValue(vtkIdType id, int value)
Set the data at a particular index.
Definition: vtkBitArray.h:319
int vtkTypeBool
Definition: vtkABI.h:69
void * GetVoidPointer(vtkIdType id) override
Return a void pointer.
Definition: vtkBitArray.h:220
virtual void SetComponent(vtkIdType tupleIdx, int compIdx, double value)
Set the data component at the location specified by tupleIdx and compIdx to value.
unsigned char * GetPointer(vtkIdType id)
Direct manipulation of the underlying data.
Definition: vtkBitArray.h:206
double * Tuple
Definition: vtkBitArray.h:303
unsigned char * Array
Definition: vtkBitArray.h:298
virtual void ClearLookup()=0
Delete the associated fast lookup data structure on this array, if it exists.
a simple class to control print indentation
Definition: vtkIndent.h:33
list of point or cell ids
Definition: vtkIdList.h:30
void InsertVariantValue(vtkIdType idx, vtkVariant value) override
Inserts values from a variant and checks to ensure there is enough memory.
Definition: vtkBitArray.h:361
abstract superclass for arrays of numeric data
Definition: vtkDataArray.h:49
virtual vtkArrayIterator * NewIterator()=0
Subclasses must override this method and provide the right kind of templated vtkArrayIteratorTemplate...
void DataChanged() override
Tell the array explicitly that the data has changed.
void SetVoidArray(void *array, vtkIdType size, int save, int deleteMethod) override
This method lets the user specify data to be held by the array.
Definition: vtkBitArray.h:248
virtual void InsertVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Insert a value into the array from a variant.
Abstract superclass to iterate over elements in an vtkAbstractArray.
virtual void InsertComponent(vtkIdType tupleIdx, int compIdx, double value)
Insert value at the location specified by tupleIdx and compIdx.
vtkIdType InsertNextTuple(vtkIdType srcTupleIdx, vtkAbstractArray *source) override
Insert the tuple from srcTupleIdx in the source array at the end of this array.
#define VTK_NEWINSTANCE
void save(Archiver &ar, const vtkUnicodeString &str, const unsigned int vtkNotUsed(version))
unsigned char * ResizeAndExtend(vtkIdType sz)
virtual vtkTypeBool Allocate(vtkIdType numValues, vtkIdType ext=1000)=0
Allocate memory for this array.
void DeepCopy(vtkAbstractArray *aa) override
Deep copy of data.
Definition: vtkBitArray.h:226
virtual vtkTypeBool Resize(vtkIdType numTuples)=0
Resize the array to the requested number of tuples and preserve data.
dynamic, self-adjusting array of bits
Definition: vtkBitArray.h:33
virtual void SetArrayFreeFunction(void(*callback)(void *))=0
This method allows the user to specify a custom free function to be called when the array is dealloca...
void * WriteVoidPointer(vtkIdType id, vtkIdType number) override
Get the address of a particular data index.
Definition: vtkBitArray.h:215
vtkIdType InsertNextValue(int i)
Definition: vtkBitArray.h:366
#define VTK_BIT
Definition: vtkType.h:42
virtual void RemoveTuple(vtkIdType tupleIdx)=0
These methods remove tuples from the data array.
void InsertTuples(vtkIdList *dstIds, vtkIdList *srcIds, vtkAbstractArray *source) override
Copy the tuples indexed in srcIds from the source array to the tuple locations indexed by dstIds in t...
virtual void SetNumberOfTuples(vtkIdType numTuples)=0
Set the number of tuples (a component group) in the array.
virtual void Squeeze()=0
Free any unnecessary memory.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
virtual void SetVariantValue(vtkIdType valueIdx, vtkVariant value)=0
Set a value in the array from a variant.
void SetVoidArray(void *array, vtkIdType size, int save) override
This method lets the user specify data to be held by the array.
Definition: vtkBitArray.h:244
virtual void RemoveFirstTuple()
These methods remove tuples from the data array.
Definition: vtkDataArray.h:222