vtkSortDataArray.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-FileCopyrightText: Copyright 2003 Sandia Corporation
// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov

#ifndef vtkSortDataArray_h
#define vtkSortDataArray_h

#include "vtkCommonCoreModule.h" // For export macro
#include "vtkDeprecation.h"      // For VTK_DEPRECATED_IN_9_7_0
#include "vtkObject.h"

VTK_ABI_NAMESPACE_BEGIN
class vtkIdList;
class vtkAbstractArray;

class VTKCOMMONCORE_EXPORT vtkSortDataArray : public vtkObject
{
public:

  static vtkSortDataArray* New();
  vtkTypeMacro(vtkSortDataArray, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static void Sort(vtkIdList* keys) { vtkSortDataArray::Sort(keys, 0); }
  static void Sort(vtkAbstractArray* keys) { vtkSortDataArray::Sort(keys, 0); }


  static void Sort(vtkIdList* keys, int dir);
  static void Sort(vtkAbstractArray* keys, int dir);

  static void Sort(vtkAbstractArray* keys, vtkAbstractArray* values)
  {
    vtkSortDataArray::Sort(keys, values, 0);
  }
  static void Sort(vtkAbstractArray* keys, vtkIdList* values)
  {
    vtkSortDataArray::Sort(keys, values, 0);
  }


  static void Sort(vtkAbstractArray* keys, vtkAbstractArray* values, int dir);
  static void Sort(vtkAbstractArray* keys, vtkIdList* values, int dir);

  static void SortArrayByComponent(vtkAbstractArray* arr, int k)
  {
    vtkSortDataArray::SortArrayByComponent(arr, k, 0);
  }

  static void SortArrayByComponent(vtkAbstractArray* arr, int k, int dir);


  static vtkIdType* InitializeSortIndices(vtkIdType numKeys);
  static void GenerateSortIndices(vtkAbstractArray* arr, int k, vtkIdType* idx);
  VTK_DEPRECATED_IN_9_7_0("Use the overload that takes vtkAbstractArray*")
  static void GenerateSortIndices(
    int dataType, void* dataIn, vtkIdType numKeys, int numComp, int k, vtkIdType* idx);
  static void ShuffleArray(vtkAbstractArray* arr, vtkIdType* idx, int dir);
  VTK_DEPRECATED_IN_9_7_0("Use the overload that takes vtkAbstractArray*")
  static void ShuffleArray(vtkIdType* idx, int vtkNotUsed(dataType), vtkIdType vtkNotUsed(numKeys),
    int vtkNotUsed(numComp), vtkAbstractArray* arr, void* vtkNotUsed(dataIn), int dir)
  {
    vtkSortDataArray::ShuffleArray(arr, idx, dir);
  }
  static void ShuffleIdList(
    vtkIdType* idx, vtkIdType sze, vtkIdList* arrayIn, vtkIdType* dataIn, int dir);

protected:
  vtkSortDataArray();
  ~vtkSortDataArray() override;

  // A more efficient sort for single component arrays. This is delegated to
  // by the methods above (if appropriate).
  static void GenerateSort1Indices(vtkAbstractArray* arr, vtkIdType* idx);
  VTK_DEPRECATED_IN_9_7_0("Use the overload that takes vtkAbstractArray*")
  static void GenerateSort1Indices(int dataType, void* dataIn, vtkIdType numKeys, vtkIdType* idx);

  // A more efficient shuffle for single component arrays. This is delegated to
  // by the methods above (if appropriate).
  static void Shuffle1Array(vtkAbstractArray* arr, vtkIdType* idx, int dir);
  VTK_DEPRECATED_IN_9_7_0("Use the overload that does not take void*")
  static void Shuffle1Array(vtkIdType* idx, int vtkNotUsed(dataType), vtkIdType vtkNotUsed(numKeys),
    vtkAbstractArray* arr, void* vtkNotUsed(dataIn), int dir)
  {
    vtkSortDataArray::Shuffle1Array(arr, idx, dir);
  }

private:
  vtkSortDataArray(const vtkSortDataArray&) = delete;
  void operator=(const vtkSortDataArray&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif // vtkSortDataArray_h