VTK  9.3.0
vtkSparseArray.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3 // SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
4 
61 #ifndef vtkSparseArray_h
62 #define vtkSparseArray_h
63 
64 #include "vtkArrayCoordinates.h"
65 #include "vtkArraySort.h"
66 #include "vtkObjectFactory.h"
67 #include "vtkTypedArray.h"
68 
69 VTK_ABI_NAMESPACE_BEGIN
70 template <typename T>
71 class vtkSparseArray : public vtkTypedArray<T>
72 {
73 public:
76  void PrintSelf(ostream& os, vtkIndent indent) override;
77 
79  typedef typename vtkArray::DimensionT DimensionT;
80  typedef typename vtkArray::SizeT SizeT;
81 
82  // vtkArray API
83  bool IsDense() override;
84  const vtkArrayExtents& GetExtents() override;
85  SizeT GetNonNullSize() override;
86  void GetCoordinatesN(SizeT n, vtkArrayCoordinates& coordinates) override;
87  vtkArray* DeepCopy() override;
88 
89  // vtkTypedArray API
90  const T& GetValue(CoordinateT i) override;
91  const T& GetValue(CoordinateT i, CoordinateT j) override;
92  const T& GetValue(CoordinateT i, CoordinateT j, CoordinateT k) override;
93  const T& GetValue(const vtkArrayCoordinates& coordinates) override;
94  const T& GetValueN(SizeT n) override;
95  void SetValue(CoordinateT i, const T& value) override;
96  void SetValue(CoordinateT i, CoordinateT j, const T& value) override;
97  void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value) override;
98  void SetValue(const vtkArrayCoordinates& coordinates, const T& value) override;
99  void SetValueN(SizeT n, const T& value) override;
100 
101  // vtkSparseArray API
102 
106  void SetNullValue(const T& value);
107 
111  const T& GetNullValue();
112 
117  void Clear();
118 
125  void Sort(const vtkArraySort& sort);
126 
130  std::vector<CoordinateT> GetUniqueCoordinates(DimensionT dimension);
131 
138  const CoordinateT* GetCoordinateStorage(DimensionT dimension) const;
139 
147 
153  const T* GetValueStorage() const;
154 
161 
170  void ReserveStorage(SizeT value_count);
171 
183  void SetExtents(const vtkArrayExtents& extents);
184 
186 
192  inline void AddValue(CoordinateT i, const T& value);
193  inline void AddValue(CoordinateT i, CoordinateT j, const T& value);
194  inline void AddValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value);
195  void AddValue(const vtkArrayCoordinates& coordinates, const T& value);
197 
207  bool Validate();
208 
209 protected:
211  ~vtkSparseArray() override;
212 
213 private:
214  vtkSparseArray(const vtkSparseArray&) = delete;
215  void operator=(const vtkSparseArray&) = delete;
216 
217  void InternalResize(const vtkArrayExtents& extents) override;
218  void InternalSetDimensionLabel(DimensionT i, const vtkStdString& label) override;
219  vtkStdString InternalGetDimensionLabel(DimensionT i) override;
220 
221  typedef vtkSparseArray<T> ThisT;
222 
226  vtkArrayExtents Extents;
227 
231  std::vector<std::string> DimensionLabels;
232 
237  std::vector<std::vector<CoordinateT>> Coordinates;
238 
242  std::vector<T> Values;
243 
245 
249  T NullValue;
251 };
252 
253 VTK_ABI_NAMESPACE_END
254 #include "vtkSparseArray.txx"
255 
256 #endif
257 // VTK-HeaderTest-Exclude: vtkSparseArray.h
Stores coordinate into an N-way array.
Stores the number of dimensions and valid coordinate ranges along each dimension for vtkArray.
Controls sorting of sparse array coordinates.
Definition: vtkArraySort.h:39
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:52
vtkArrayExtents::SizeT SizeT
Definition: vtkArray.h:59
vtkArrayExtents::DimensionT DimensionT
Definition: vtkArray.h:58
vtkArrayExtents::CoordinateT CoordinateT
Definition: vtkArray.h:57
a simple class to control print indentation
Definition: vtkIndent.h:38
Sparse, independent coordinate storage for N-way arrays.
void SetExtents(const vtkArrayExtents &extents)
Specify arbitrary array extents, without altering the contents of the array.
const T & GetValueN(SizeT n) override
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
void ReserveStorage(SizeT value_count)
Reserve storage for a specific number of values.
void SetValue(CoordinateT i, const T &value) override
Overwrites the value stored in the array at the given coordinates.
void AddValue(CoordinateT i, const T &value)
Adds a new non-null element to the array.
bool Validate()
Validate the contents of the array, returning false if there are any problems.
void Sort(const vtkArraySort &sort)
Sorts array values so that their coordinates appear in some well-defined order.
vtkArray::SizeT SizeT
void SetNullValue(const T &value)
Set the value that will be returned by GetValue() for nullptr areas of the array.
vtkArray * DeepCopy() override
Returns a new array that is a deep copy of this array.
const T & GetNullValue()
Returns the value that will be returned by GetValue() for nullptr areas of the array.
void SetExtentsFromContents()
Update the array extents to match its contents, so that the extent along each dimension matches the m...
void AddValue(CoordinateT i, CoordinateT j, const T &value)
Adds a new non-null element to the array.
void SetValue(const vtkArrayCoordinates &coordinates, const T &value) override
Overwrites the value stored in the array at the given coordinates.
const T & GetValue(CoordinateT i, CoordinateT j) override
Returns the value stored in the array at the given coordinates.
void SetValue(CoordinateT i, CoordinateT j, const T &value) override
Overwrites the value stored in the array at the given coordinates.
void GetCoordinatesN(SizeT n, vtkArrayCoordinates &coordinates) override
Returns the coordinates of the n-th value in the array, where n is in the range [0,...
static vtkSparseArray< T > * New()
~vtkSparseArray() override
vtkArray::DimensionT DimensionT
const CoordinateT * GetCoordinateStorage(DimensionT dimension) const
Return a read-only reference to the underlying coordinate storage.
SizeT GetNonNullSize() override
Returns the number of non-null values stored in the array.
void AddValue(CoordinateT i, CoordinateT j, CoordinateT k, const T &value)
Adds a new non-null element to the array.
const T * GetValueStorage() const
Return a read-only reference to the underlying value storage.
void AddValue(const vtkArrayCoordinates &coordinates, const T &value)
Adds a new non-null element to the array.
void Clear()
Remove all non-null elements from the array, leaving the number of dimensions, the extent of each dim...
T * GetValueStorage()
Return a mutable reference to the underlying value storage.
vtkTemplateTypeMacro(vtkSparseArray< T >, vtkTypedArray< T >)
const T & GetValue(const vtkArrayCoordinates &coordinates) override
Returns the value stored in the array at the given coordinates.
void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T &value) override
Overwrites the value stored in the array at the given coordinates.
CoordinateT * GetCoordinateStorage(DimensionT dimension)
Return a mutable reference to the underlying coordinate storage.
const vtkArrayExtents & GetExtents() override
Returns the extents (the number of dimensions and size along each dimension) of the array.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetValueN(SizeT n, const T &value) override
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
const T & GetValue(CoordinateT i, CoordinateT j, CoordinateT k) override
Returns the value stored in the array at the given coordinates.
const T & GetValue(CoordinateT i) override
Returns the value stored in the array at the given coordinates.
vtkArray::CoordinateT CoordinateT
std::vector< CoordinateT > GetUniqueCoordinates(DimensionT dimension)
Returns the set of unique coordinates along the given dimension.
bool IsDense() override
Returns true iff the underlying array storage is "dense", i.e.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:38
Provides a type-specific interface to N-way arrays.
Definition: vtkTypedArray.h:43
@ value
Definition: vtkX3D.h:220