VTK  9.0.1
vtkSparseArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSparseArray.h
5 
6 -------------------------------------------------------------------------
7  Copyright 2008 Sandia Corporation.
8  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9  the U.S. Government retains certain rights in this software.
10 -------------------------------------------------------------------------
11 
12  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
13  All rights reserved.
14  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
15 
16  This software is distributed WITHOUT ANY WARRANTY; without even
17  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
18  PURPOSE. See the above copyright notice for more information.
19 
20 =========================================================================*/
21 
66 #ifndef vtkSparseArray_h
67 #define vtkSparseArray_h
68 
69 #include "vtkArrayCoordinates.h"
70 #include "vtkArraySort.h"
71 #include "vtkObjectFactory.h"
72 #include "vtkTypedArray.h"
73 
74 template <typename T>
75 class vtkSparseArray : public vtkTypedArray<T>
76 {
77 public:
79  static vtkSparseArray<T>* New();
80  void PrintSelf(ostream& os, vtkIndent indent) override;
81 
83  typedef typename vtkArray::DimensionT DimensionT;
84  typedef typename vtkArray::SizeT SizeT;
85 
86  // vtkArray API
87  bool IsDense() override;
88  const vtkArrayExtents& GetExtents() override;
89  SizeT GetNonNullSize() override;
90  void GetCoordinatesN(const SizeT n, vtkArrayCoordinates& coordinates) override;
91  vtkArray* DeepCopy() override;
92 
93  // vtkTypedArray API
94  const T& GetValue(CoordinateT i) override;
95  const T& GetValue(CoordinateT i, CoordinateT j) override;
96  const T& GetValue(CoordinateT i, CoordinateT j, CoordinateT k) override;
97  const T& GetValue(const vtkArrayCoordinates& coordinates) override;
98  const T& GetValueN(const SizeT n) override;
99  void SetValue(CoordinateT i, const T& value) override;
100  void SetValue(CoordinateT i, CoordinateT j, const T& value) override;
101  void SetValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value) override;
102  void SetValue(const vtkArrayCoordinates& coordinates, const T& value) override;
103  void SetValueN(const SizeT n, const T& value) override;
104 
105  // vtkSparseArray API
106 
110  void SetNullValue(const T& value);
111 
115  const T& GetNullValue();
116 
121  void Clear();
122 
129  void Sort(const vtkArraySort& sort);
130 
134  std::vector<CoordinateT> GetUniqueCoordinates(DimensionT dimension);
135 
142  const CoordinateT* GetCoordinateStorage(DimensionT dimension) const;
143 
151 
157  const T* GetValueStorage() const;
158 
164  T* GetValueStorage();
165 
174  void ReserveStorage(const SizeT value_count);
175 
180  void SetExtentsFromContents();
187  void SetExtents(const vtkArrayExtents& extents);
188 
190 
196  inline void AddValue(CoordinateT i, const T& value);
197  inline void AddValue(CoordinateT i, CoordinateT j, const T& value);
198  inline void AddValue(CoordinateT i, CoordinateT j, CoordinateT k, const T& value);
199  void AddValue(const vtkArrayCoordinates& coordinates, const T& value);
201 
211  bool Validate();
212 
213 protected:
214  vtkSparseArray();
215  ~vtkSparseArray() override;
216 
217 private:
218  vtkSparseArray(const vtkSparseArray&) = delete;
219  void operator=(const vtkSparseArray&) = delete;
220 
221  void InternalResize(const vtkArrayExtents& extents) override;
222  void InternalSetDimensionLabel(DimensionT i, const vtkStdString& label) override;
223  vtkStdString InternalGetDimensionLabel(DimensionT i) override;
224 
225  typedef vtkSparseArray<T> ThisT;
226 
230  vtkArrayExtents Extents;
231 
235  std::vector<vtkStdString> DimensionLabels;
236 
241  std::vector<std::vector<CoordinateT> > Coordinates;
242 
246  std::vector<T> Values;
247 
249 
253  T NullValue;
255 };
256 
257 #include "vtkSparseArray.txx"
258 
259 #endif
260 // VTK-HeaderTest-Exclude: vtkSparseArray.h
vtkSparseArray::Sort
void Sort(const vtkArraySort &sort)
Sorts array values so that their coordinates appear in some well-defined order.
vtkSparseArray::SetExtents
void SetExtents(const vtkArrayExtents &extents)
Specify arbitrary array extents, without altering the contents of the array.
vtkArray::SizeT
vtkArrayExtents::SizeT SizeT
Definition: vtkArray.h:72
vtkSparseArray::Clear
void Clear()
Remove all non-null elements from the array, leaving the number of dimensions, the extent of each dim...
vtkSparseArray::IsDense
bool IsDense() override
Returns true iff the underlying array storage is "dense", i.e.
vtkX3D::value
@ value
Definition: vtkX3D.h:226
vtkArraySort
Controls sorting of sparse array coordinates.
Definition: vtkArraySort.h:51
vtkSparseArray::GetValueStorage
const T * GetValueStorage() const
Return a read-only reference to the underlying value storage.
vtkSparseArray::New
static vtkSparseArray< T > * New()
vtkTypedArray.h
vtkObjectFactory.h
vtkSparseArray::GetNullValue
const T & GetNullValue()
Returns the value that will be returned by GetValue() for nullptr areas of the array.
vtkSparseArray::GetCoordinateStorage
const CoordinateT * GetCoordinateStorage(DimensionT dimension) const
Return a read-only reference to the underlying coordinate storage.
vtkSparseArray::DimensionT
vtkArray::DimensionT DimensionT
Definition: vtkSparseArray.h:83
vtkSparseArray::vtkTemplateTypeMacro
vtkTemplateTypeMacro(vtkSparseArray< T >, vtkTypedArray< T >)
vtkSparseArray::GetCoordinatesN
void GetCoordinatesN(const SizeT n, vtkArrayCoordinates &coordinates) override
Returns the coordinates of the n-th value in the array, where n is in the range [0,...
vtkSparseArray::GetExtents
const vtkArrayExtents & GetExtents() override
Returns the extents (the number of dimensions and size along each dimension) of the array.
vtkArrayCoordinates.h
vtkSparseArray::GetUniqueCoordinates
std::vector< CoordinateT > GetUniqueCoordinates(DimensionT dimension)
Returns the set of unique coordinates along the given dimension.
vtkSparseArray::DeepCopy
vtkArray * DeepCopy() override
Returns a new array that is a deep copy of this array.
vtkSparseArray::AddValue
void AddValue(CoordinateT i, const T &value)
Adds a new non-null element to the array.
vtkTypedArray
Provides a type-specific interface to N-way arrays.
Definition: vtkTypedArray.h:55
vtkSparseArray::~vtkSparseArray
~vtkSparseArray() override
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkSparseArray::SetValue
void SetValue(CoordinateT i, const T &value) override
Overwrites the value stored in the array at the given coordinates.
vtkSparseArray::vtkSparseArray
vtkSparseArray()
vtkSparseArray::SetNullValue
void SetNullValue(const T &value)
Set the value that will be returned by GetValue() for nullptr areas of the array.
vtkArray
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:64
vtkSparseArray
Sparse, independent coordinate storage for N-way arrays.
Definition: vtkSparseArray.h:75
vtkSparseArray::ReserveStorage
void ReserveStorage(const SizeT value_count)
Reserve storage for a specific number of values.
vtkSparseArray::GetValueN
const T & GetValueN(const SizeT n) override
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
vtkSparseArray::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSparseArray::CoordinateT
vtkArray::CoordinateT CoordinateT
Definition: vtkSparseArray.h:82
vtkSparseArray::SizeT
vtkArray::SizeT SizeT
Definition: vtkSparseArray.h:84
vtkSparseArray::Validate
bool Validate()
Validate the contents of the array, returning false if there are any problems.
vtkSparseArray::SetExtentsFromContents
void SetExtentsFromContents()
Update the array extents to match its contents, so that the extent along each dimension matches the m...
vtkSparseArray::SetValueN
void SetValueN(const SizeT n, const T &value) override
Overwrites the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
vtkArraySort.h
vtkStdString
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
vtkArray::CoordinateT
vtkArrayExtents::CoordinateT CoordinateT
Definition: vtkArray.h:70
vtkSparseArray::GetNonNullSize
SizeT GetNonNullSize() override
Returns the number of non-null values stored in the array.
vtkSparseArray::GetValue
const T & GetValue(CoordinateT i) override
Returns the value stored in the array at the given coordinates.
vtkArrayExtents
Stores the number of dimensions and valid coordinate ranges along each dimension for vtkArray.
Definition: vtkArrayExtents.h:68
vtkArrayCoordinates
Stores coordinate into an N-way array.
Definition: vtkArrayCoordinates.h:51
vtkArray::DimensionT
vtkArrayExtents::DimensionT DimensionT
Definition: vtkArray.h:71