vtkSortDataArray.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkSortDataArray.h
 
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.
 
=========================================================================*/
 
/*
 * Copyright 2003 Sandia Corporation.
 * Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
 * license for use of this work by or on behalf of the
 * U.S. Government. Redistribution and use in source and binary forms, with
 * or without modification, are permitted provided that this Notice and any
 * statement of authorship are reproduced on all copies.
 */
 
#ifndef vtkSortDataArray_h
#define vtkSortDataArray_h
 
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
 
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(
    int dataType, void* dataIn, vtkIdType numKeys, int numComp, int k, vtkIdType* idx);
  static void ShuffleArray(vtkIdType* idx, int dataType, vtkIdType numKeys, int numComp,
    vtkAbstractArray* arr, void* dataIn, int 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(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(
    vtkIdType* idx, int dataType, vtkIdType numKeys, vtkAbstractArray* arr, void* dataIn, int dir);
 
private:
  vtkSortDataArray(const vtkSortDataArray&) = delete;
  void operator=(const vtkSortDataArray&) = delete;
};
 
#endif // vtkSortDataArray_h