casacore
Static Public Member Functions | Static Private Member Functions | List of all members
casacore::GenSortIndirect< T, INX > Class Template Reference

General indirect sort functions. More...

#include <GenSort.h>

Static Public Member Functions

static INX sort (Vector< INX > &indexVector, const T *data, INX nr, Sort::Order=Sort::Ascending, int options=Sort::QuickSort)
 Sort a C-array containing nr T-type objects. More...
 
static INX sort (Vector< INX > &indexVector, const Array< T > &data, Sort::Order=Sort::Ascending, int options=Sort::QuickSort)
 Sort a C-array containing nr T-type objects. More...
 
static INX sort (Vector< INX > &indexVector, const Block< T > &data, INX nr, Sort::Order=Sort::Ascending, int options=Sort::QuickSort)
 Sort a C-array containing nr T-type objects. More...
 
static INX kthLargest (T *data, INX nr, INX k)
 Find the index of the k-th largest value. More...
 
static INX quickSort (INX *inx, const T *data, INX nr, Sort::Order, int options)
 Sort container using quicksort. More...
 
static INX heapSort (INX *inx, const T *data, INX nr, Sort::Order, int options)
 Sort container using heapsort. More...
 
static INX insSort (INX *inx, const T *data, INX nr, Sort::Order, int options)
 Sort container using insertion sort. More...
 
static INX parSort (INX *inx, const T *data, INX nr, Sort::Order, int options, int nthreads=0)
 Sort container using parallel merge sort (using OpenMP). More...
 

Static Private Member Functions

static void swapInx (INX &index1, INX &index2)
 Swap 2 indices. More...
 
static INX * merge (const T *data, INX *inx, INX *tmp, INX nrrec, INX *index, INX nparts)
 Thedata buffer is divided in nparts parts. More...
 
static int isAscending (const T *data, INX index1, INX index2)
 Check if 2 values are in ascending order. More...
 
static void quickSortAsc (INX *inx, const T *, INX nr, Bool multiThread=False, Int rec_lim=128)
 Quicksort in ascending order. More...
 
static void heapSortAsc (INX *inx, const T *, INX nr)
 Heapsort in ascending order. More...
 
static void heapAscSiftDown (INX *inx, INX, INX, const T *)
 Helper function for ascending heapsort. More...
 
static INX insSortAsc (INX *inx, const T *, INX nr, int option)
 Insertion sort in ascending order. More...
 
static INX insSortAscDup (INX *inx, const T *, INX nr)
 Insertion sort in ascending order allowing duplicates. More...
 
static INX insSortAscNoDup (INX *inx, const T *, INX nr)
 Insertion sort in ascending order allowing no duplicates. More...
 

Detailed Description

template<class T, class INX = uInt>
class casacore::GenSortIndirect< T, INX >

General indirect sort functions.

Intended use:

Internal

Synopsis

This class is similar to GenSort. The only difference is that the functions in this class sort indirectly instead of in-place. They return the result of the sort as an sorted vector of indices This is slower, because an extra indirection is involved in each comparison. However, this sort allows to sort const data. Another advantage is that this sort is always stable (i.e. equal values are kept in their original order).

Definition at line 205 of file GenSort.h.

Member Function Documentation

◆ heapAscSiftDown()

template<class T , class INX = uInt>
static void casacore::GenSortIndirect< T, INX >::heapAscSiftDown ( INX *  inx,
INX  ,
INX  ,
const T *   
)
staticprivate

Helper function for ascending heapsort.

◆ heapSort()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::heapSort ( INX *  inx,
const T *  data,
INX  nr,
Sort::Order  ,
int  options 
)
static

Sort container using heapsort.

◆ heapSortAsc()

template<class T , class INX = uInt>
static void casacore::GenSortIndirect< T, INX >::heapSortAsc ( INX *  inx,
const T *  ,
INX  nr 
)
staticprivate

Heapsort in ascending order.

◆ insSort()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::insSort ( INX *  inx,
const T *  data,
INX  nr,
Sort::Order  ,
int  options 
)
static

Sort container using insertion sort.

◆ insSortAsc()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::insSortAsc ( INX *  inx,
const T *  ,
INX  nr,
int  option 
)
staticprivate

Insertion sort in ascending order.

◆ insSortAscDup()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::insSortAscDup ( INX *  inx,
const T *  ,
INX  nr 
)
staticprivate

Insertion sort in ascending order allowing duplicates.

This is also used by quicksort for its last steps.

◆ insSortAscNoDup()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::insSortAscNoDup ( INX *  inx,
const T *  ,
INX  nr 
)
staticprivate

Insertion sort in ascending order allowing no duplicates.

This is also used by the other sort algorithms to skip duplicates.

◆ isAscending()

template<class T , class INX >
int casacore::GenSortIndirect< T, INX >::isAscending ( const T *  data,
INX  index1,
INX  index2 
)
inlinestaticprivate

Check if 2 values are in ascending order.

When equal, the order is correct if index1<index2.

Definition at line 401 of file GenSort.h.

◆ kthLargest()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::kthLargest ( T *  data,
INX  nr,
INX  k 
)
static

Find the index of the k-th largest value.

◆ merge()

template<class T , class INX = uInt>
static INX* casacore::GenSortIndirect< T, INX >::merge ( const T *  data,
INX *  inx,
INX *  tmp,
INX  nrrec,
INX *  index,
INX  nparts 
)
staticprivate

Thedata buffer is divided in nparts parts.

In each part the values are in ascending order. The index tells the nr of elements in each part. Recursively each two subsequent parts are merged until only part is left (giving the sorted array). Alternately data and tmp are used for the merge result. The pointer containing the final result is returned.
If possible, merging the parts is done in parallel (using OpenMP).

◆ parSort()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::parSort ( INX *  inx,
const T *  data,
INX  nr,
Sort::Order  ,
int  options,
int  nthreads = 0 
)
static

Sort container using parallel merge sort (using OpenMP).

By default the maximum number of threads is used.

◆ quickSort()

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::quickSort ( INX *  inx,
const T *  data,
INX  nr,
Sort::Order  ,
int  options 
)
static

Sort container using quicksort.

The argument inx gives the index defining the order of the values in the data array. Its length must be at least nr and it must be filled with the index values of the data. Usually this is 0..nr, but it could contain a selection of the data.

◆ quickSortAsc()

template<class T , class INX = uInt>
static void casacore::GenSortIndirect< T, INX >::quickSortAsc ( INX *  inx,
const T *  ,
INX  nr,
Bool  multiThread = False,
Int  rec_lim = 128 
)
staticprivate

Quicksort in ascending order.

◆ sort() [1/3]

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::sort ( Vector< INX > &  indexVector,
const Array< T > &  data,
Sort::Order  = Sort::Ascending,
int  options = Sort::QuickSort 
)
static

Sort a C-array containing nr T-type objects.

The resulting index vector gives the sorted indices.

◆ sort() [2/3]

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::sort ( Vector< INX > &  indexVector,
const Block< T > &  data,
INX  nr,
Sort::Order  = Sort::Ascending,
int  options = Sort::QuickSort 
)
static

Sort a C-array containing nr T-type objects.

The resulting index vector gives the sorted indices.

◆ sort() [3/3]

template<class T , class INX = uInt>
static INX casacore::GenSortIndirect< T, INX >::sort ( Vector< INX > &  indexVector,
const T *  data,
INX  nr,
Sort::Order  = Sort::Ascending,
int  options = Sort::QuickSort 
)
static

Sort a C-array containing nr T-type objects.

The resulting index vector gives the sorted indices.

Referenced by casacore::genSort().

◆ swapInx()

template<class T , class INX >
void casacore::GenSortIndirect< T, INX >::swapInx ( INX &  index1,
INX &  index2 
)
inlinestaticprivate

Swap 2 indices.

Definition at line 394 of file GenSort.h.


The documentation for this class was generated from the following file: