VTK
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;
254 };
256 
257 #include "vtkSparseArray.txx"
258 
259 #endif
260 // VTK-HeaderTest-Exclude: vtkSparseArray.h
Controls sorting of sparse array coordinates.
Definition: vtkArraySort.h:51
Stores coordinate into an N-way array.
Wrapper around std::string to keep symbols short.
Definition: vtkStdString.h:34
Stores the number of dimensions and valid coordinate ranges along each dimension for vtkArray...
Sparse, independent coordinate storage for N-way arrays.
Abstract interface for N-dimensional arrays.
Definition: vtkArray.h:64
void SetExtents(const vtkArrayExtents &extents)
Specify arbitrary array extents, without altering the contents of the array.
vtkArray::DimensionT DimensionT
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetNullValue(const T &value)
Set the value that will be returned by GetValue() for nullptr areas of the array. ...
const T * GetValueStorage() const
Return a read-only reference to the underlying value storage.
void Sort(const vtkArraySort &sort)
Sorts array values so that their coordinates appear in some well-defined order.
const T & GetValueN(const SizeT n) override
Returns the n-th value stored in the array, where n is in the range [0, GetNonNullSize()).
const CoordinateT * GetCoordinateStorage(DimensionT dimension) const
Return a read-only reference to the underlying coordinate storage.
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()).
const T & GetNullValue()
Returns the value that will be returned by GetValue() for nullptr areas of the array.
vtkArrayExtents::DimensionT DimensionT
Definition: vtkArray.h:71
vtkTemplateTypeMacro(vtkSparseArray< T >, vtkTypedArray< T >) static vtkSparseArray< T > *New()
a simple class to control print indentation
Definition: vtkIndent.h:33
~vtkSparseArray() override
bool IsDense() override
Returns true iff the underlying array storage is "dense", i.e.
vtkArray::SizeT SizeT
vtkArrayExtents::SizeT SizeT
Definition: vtkArray.h:72
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, GetNonNullSize()).
std::vector< CoordinateT > GetUniqueCoordinates(DimensionT dimension)
Returns the set of unique coordinates along the given dimension.
void Clear()
Remove all non-null elements from the array, leaving the number of dimensions, the extent of each dim...
void SetExtentsFromContents()
Update the array extents to match its contents, so that the extent along each dimension matches the m...
vtkArray::CoordinateT CoordinateT
const vtkArrayExtents & GetExtents() override
Returns the extents (the number of dimensions and size along each dimension) of the array...
void AddValue(CoordinateT i, const T &value)
Adds a new non-null element to the array.
Provides a type-specific interface to N-way arrays.
Definition: vtkTypedArray.h:55
SizeT GetNonNullSize() override
Returns the number of non-null values stored in the array.
void ReserveStorage(const SizeT value_count)
Reserve storage for a specific number of values.
vtkArray * DeepCopy() override
Returns a new array that is a deep copy of this array.
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
bool Validate()
Validate the contents of the array, returning false if there are any problems.
vtkArrayExtents::CoordinateT CoordinateT
Definition: vtkArray.h:70
void SetValue(CoordinateT i, const T &value) override
Overwrites 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.