VTK  9.2.20220629
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 
46 #ifndef vtkArraySort_h
47 #define vtkArraySort_h
48 
49 #include "vtkArrayCoordinates.h"
50 #include "vtkCommonCoreModule.h" // For export macro
51 #include "vtkSystemIncludes.h"
52 #include <vector>
53 
54 class VTKCOMMONCORE_EXPORT vtkArraySort
55 {
56 public:
58 
64 
68  explicit vtkArraySort(DimensionT i);
69 
74 
79 
84 
90  void SetDimensions(DimensionT dimensions);
91 
96 
101 
105  bool operator==(const vtkArraySort& rhs) const;
106 
110  bool operator!=(const vtkArraySort& rhs) const;
111 
115  VTKCOMMONCORE_EXPORT friend ostream& operator<<(ostream& stream, const vtkArraySort& rhs);
116 
117 private:
118  std::vector<DimensionT> Storage;
119 };
120 
121 #endif
122 
123 // VTK-HeaderTest-Exclude: vtkArraySort.h
Controls sorting of sparse array coordinates.
Definition: vtkArraySort.h:55
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:57
DimensionT & operator[](DimensionT i)
Returns the i-th dimension to be sorted.
vtkArraySort(DimensionT i)
Sorts an array along one dimension.