VTK  9.2.5
vtkSortDataArray.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkSortDataArray.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 
16 /*
17  * Copyright 2003 Sandia Corporation.
18  * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
19  * license for use of this work by or on behalf of the
20  * U.S. Government. Redistribution and use in source and binary forms, with
21  * or without modification, are permitted provided that this Notice and any
22  * statement of authorship are reproduced on all copies.
23  */
24 
88 #ifndef vtkSortDataArray_h
89 #define vtkSortDataArray_h
90 
91 #include "vtkCommonCoreModule.h" // For export macro
92 #include "vtkObject.h"
93 
94 class vtkIdList;
95 class vtkAbstractArray;
96 
97 class VTKCOMMONCORE_EXPORT vtkSortDataArray : public vtkObject
98 {
99 public:
101 
106  vtkTypeMacro(vtkSortDataArray, vtkObject);
107  void PrintSelf(ostream& os, vtkIndent indent) override;
109 
114  static void Sort(vtkIdList* keys) { vtkSortDataArray::Sort(keys, 0); }
115  static void Sort(vtkAbstractArray* keys) { vtkSortDataArray::Sort(keys, 0); }
116 
118 
122  static void Sort(vtkIdList* keys, int dir);
123  static void Sort(vtkAbstractArray* keys, int dir);
125 
132  static void Sort(vtkAbstractArray* keys, vtkAbstractArray* values)
133  {
134  vtkSortDataArray::Sort(keys, values, 0);
135  }
136  static void Sort(vtkAbstractArray* keys, vtkIdList* values)
137  {
138  vtkSortDataArray::Sort(keys, values, 0);
139  }
140 
142 
148  static void Sort(vtkAbstractArray* keys, vtkAbstractArray* values, int dir);
149  static void Sort(vtkAbstractArray* keys, vtkIdList* values, int dir);
151 
159  static void SortArrayByComponent(vtkAbstractArray* arr, int k)
160  {
162  }
163 
171  static void SortArrayByComponent(vtkAbstractArray* arr, int k, int dir);
172 
174 
197  static void GenerateSortIndices(
198  int dataType, void* dataIn, vtkIdType numKeys, int numComp, int k, vtkIdType* idx);
199  static void ShuffleArray(vtkIdType* idx, int dataType, vtkIdType numKeys, int numComp,
200  vtkAbstractArray* arr, void* dataIn, int dir);
201  static void ShuffleIdList(
202  vtkIdType* idx, vtkIdType sze, vtkIdList* arrayIn, vtkIdType* dataIn, int dir);
204 
205 protected:
207  ~vtkSortDataArray() override;
208 
209  // A more efficient sort for single component arrays. This is delegated to
210  // by the methods above (if appropriate).
211  static void GenerateSort1Indices(int dataType, void* dataIn, vtkIdType numKeys, vtkIdType* idx);
212 
213  // A more efficient shuffle for single component arrays. This is delegated to
214  // by the methods above (if appropriate).
215  static void Shuffle1Array(
216  vtkIdType* idx, int dataType, vtkIdType numKeys, vtkAbstractArray* arr, void* dataIn, int dir);
217 
218 private:
219  vtkSortDataArray(const vtkSortDataArray&) = delete;
220  void operator=(const vtkSortDataArray&) = delete;
221 };
222 
223 #endif // vtkSortDataArray_h
Abstract superclass for all arrays.
list of point or cell ids
Definition: vtkIdList.h:143
a simple class to control print indentation
Definition: vtkIndent.h:119
abstract base class for most VTK objects
Definition: vtkObject.h:82
provides several methods for sorting VTK arrays.
static vtkSortDataArray * New()
Standard VTK methods for instantiating, managing type, and printing information about this class.
static void Shuffle1Array(vtkIdType *idx, int dataType, vtkIdType numKeys, vtkAbstractArray *arr, void *dataIn, int dir)
static void Sort(vtkIdList *keys)
Sorts the given array in ascending order.
static void Sort(vtkAbstractArray *keys, vtkIdList *values, int dir)
Sorts the given key/value pairs based on the keys (the keys are expected to be 1-tuples,...
static void ShuffleIdList(vtkIdType *idx, vtkIdType sze, vtkIdList *arrayIn, vtkIdType *dataIn, int dir)
The following are general functions which can be used to produce an ordering, and/or sort various typ...
static void Sort(vtkAbstractArray *keys, vtkAbstractArray *values)
Sorts the given key/value pairs based on the keys (the keys are expected to be 1-tuples,...
static void GenerateSortIndices(int dataType, void *dataIn, vtkIdType numKeys, int numComp, int k, vtkIdType *idx)
The following are general functions which can be used to produce an ordering, and/or sort various typ...
static void SortArrayByComponent(vtkAbstractArray *arr, int k)
Sorts the given data array using the specified component as a key.
static void Sort(vtkIdList *keys, int dir)
Sorts the given array in either ascending (dir=0) or descending (dir!=0) order.
static void SortArrayByComponent(vtkAbstractArray *arr, int k, int dir)
Sorts the given data array using the specified component as a key.
static void Sort(vtkAbstractArray *keys, int dir)
Sorts the given array in either ascending (dir=0) or descending (dir!=0) order.
~vtkSortDataArray() override
static void Sort(vtkAbstractArray *keys, vtkAbstractArray *values, int dir)
Sorts the given key/value pairs based on the keys (the keys are expected to be 1-tuples,...
static void ShuffleArray(vtkIdType *idx, int dataType, vtkIdType numKeys, int numComp, vtkAbstractArray *arr, void *dataIn, int dir)
The following are general functions which can be used to produce an ordering, and/or sort various typ...
static void Sort(vtkAbstractArray *keys)
static vtkIdType * InitializeSortIndices(vtkIdType numKeys)
The following are general functions which can be used to produce an ordering, and/or sort various typ...
void PrintSelf(ostream &os, vtkIndent indent) override
Standard VTK methods for instantiating, managing type, and printing information about this class.
static void Sort(vtkAbstractArray *keys, vtkIdList *values)
static void GenerateSort1Indices(int dataType, void *dataIn, vtkIdType numKeys, vtkIdType *idx)
@ dir
Definition: vtkX3D.h:330
int vtkIdType
Definition: vtkType.h:332