1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
/**
* @class vtkArraySort
* @brief Controls sorting of sparse array coordinates.
*
*
* vtkArraySort stores an ordered set of dimensions along which the
* values stored in a sparse array should be sorted.
*
* Convenience constructors are provided for specifying one, two, and
* three dimensions. To sort along more than three dimensions, use the
* default constructor, SetDimensions(), and operator[] to assign each
* dimension to be sorted.
*
* @sa
* vtkSparseArray
*
* @par Thanks:
* Developed by Timothy M. Shead (tshead@sandia.gov) at Sandia National
* Laboratories.
*/
#ifndef vtkArraySort_h
#define vtkArraySort_h
#include "vtkArrayCoordinates.h"
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkSystemIncludes.h"
#include <vector>
VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONCORE_EXPORT vtkArraySort
{
public:
typedef vtkArrayCoordinates::DimensionT DimensionT;
/**
* Create an empty set of dimensions. Use SetDimensions() and
* operator[] to populate them.
*/
vtkArraySort();
/**
* Sorts an array along one dimension.
*/
explicit vtkArraySort(DimensionT i);
/**
* Sorts an array along two dimensions.
*/
vtkArraySort(DimensionT i, DimensionT j);
/**
* Sorts an array along three dimensions.
*/
vtkArraySort(DimensionT i, DimensionT j, DimensionT k);
/**
* Return the number of dimensions for sorting.
*/
DimensionT GetDimensions() const;
/**
* Set the number of dimensions to be sorted. Note that this method
* resets every dimension to zero, so you must set every dimension
* explicitly using operator[] after calling SetDimensions().
*/
void SetDimensions(DimensionT dimensions);
/**
* Returns the i-th dimension to be sorted.
*/
DimensionT& operator[](DimensionT i);
/**
* Returns the i-th dimension to be sorted.
*/
const DimensionT& operator[](DimensionT i) const;
/**
* Equality comparison
*/
bool operator==(const vtkArraySort& rhs) const;
/**
* Inequality comparison
*/
bool operator!=(const vtkArraySort& rhs) const;
/**
* Serialization
*/
VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArraySort& rhs);
private:
std::vector<DimensionT> Storage;
};
VTK_ABI_NAMESPACE_END
#endif
// VTK-HeaderTest-Exclude: vtkArraySort.h
|
