VTK  9.1.20211230
vtkArraySort.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkArraySort.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 
43 #ifndef vtkArraySort_h
44 #define vtkArraySort_h
45 
46 #include "vtkArrayCoordinates.h"
47 #include "vtkCommonCoreModule.h" // For export macro
48 #include "vtkSystemIncludes.h"
49 #include <vector>
50 
51 class VTKCOMMONCORE_EXPORT vtkArraySort
52 {
53 public:
55 
61 
65  explicit vtkArraySort(DimensionT i);
66 
71 
76 
81 
87  void SetDimensions(DimensionT dimensions);
88 
93 
97  const DimensionT& operator[](DimensionT i) const;
98 
102  bool operator==(const vtkArraySort& rhs) const;
103 
107  bool operator!=(const vtkArraySort& rhs) const;
108 
112  VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArraySort& rhs);
113 
114 private:
115  std::vector<DimensionT> Storage;
116 };
117 
118 #endif
119 
120 // VTK-HeaderTest-Exclude: vtkArraySort.h
Controls sorting of sparse array coordinates.
Definition: vtkArraySort.h:52
bool operator==(const vtkArraySort &rhs) const
Equality comparison.
VTKCOMMONCORE_EXPORT friend ostream & operator<<(ostream &stream, const vtkArraySort &rhs)
Serialization.
DimensionT GetDimensions() const
Return the number of dimensions for sorting.
vtkArraySort(DimensionT i, DimensionT j)
Sorts an array along two dimensions.
vtkArraySort(DimensionT i, DimensionT j, DimensionT k)
Sorts an array along three dimensions.
vtkArraySort()
Create an empty set of dimensions.
void SetDimensions(DimensionT dimensions)
Set the number of dimensions to be sorted.
const DimensionT & operator[](DimensionT i) const
Returns the i-th dimension to be sorted.
bool operator!=(const vtkArraySort &rhs) const
Inequality comparison.
vtkArrayCoordinates::DimensionT DimensionT
Definition: vtkArraySort.h:54
DimensionT & operator[](DimensionT i)
Returns the i-th dimension to be sorted.
vtkArraySort(DimensionT i)
Sorts an array along one dimension.