godot/core/sort.h

331 lines
9.2 KiB
C++
Raw Normal View History

2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* sort.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
2014-02-10 01:10:30 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
2014-02-10 01:10:30 +00:00
#ifndef SORT_H
#define SORT_H
#include "core/typedefs.h"
2014-02-10 01:10:30 +00:00
#define ERR_BAD_COMPARE(cond) \
if (unlikely(cond)) { \
ERR_PRINT("bad comparison function; sorting will be broken"); \
break; \
}
template <class T>
2014-02-10 01:10:30 +00:00
struct _DefaultComparator {
_FORCE_INLINE_ bool operator()(const T &a, const T &b) const { return (a < b); }
2014-02-10 01:10:30 +00:00
};
#ifdef DEBUG_ENABLED
#define SORT_ARRAY_VALIDATE_ENABLED true
#else
#define SORT_ARRAY_VALIDATE_ENABLED false
#endif
template <class T, class Comparator = _DefaultComparator<T>, bool Validate = SORT_ARRAY_VALIDATE_ENABLED>
2014-02-10 01:10:30 +00:00
class SortArray {
enum {
2016-03-08 23:00:52 +00:00
2017-07-08 15:12:18 +00:00
INTROSORT_THRESHOLD = 16
2014-02-10 01:10:30 +00:00
};
public:
Comparator compare;
inline const T &median_of_3(const T &a, const T &b, const T &c) const {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
if (compare(a, b))
if (compare(b, c))
return b;
else if (compare(a, c))
return c;
else
return a;
else if (compare(a, c))
return a;
else if (compare(b, c))
return c;
else
return b;
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
inline int bitlog(int n) const {
int k;
2016-03-08 23:00:52 +00:00
for (k = 0; n != 1; n >>= 1)
2014-02-10 01:10:30 +00:00
++k;
return k;
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
/* Heap / Heapsort functions */
2016-03-08 23:00:52 +00:00
inline void push_heap(int p_first, int p_hole_idx, int p_top_index, T p_value, T *p_array) const {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
int parent = (p_hole_idx - 1) / 2;
while (p_hole_idx > p_top_index && compare(p_array[p_first + parent], p_value)) {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
p_array[p_first + p_hole_idx] = p_array[p_first + parent];
p_hole_idx = parent;
parent = (p_hole_idx - 1) / 2;
}
2016-03-08 23:00:52 +00:00
p_array[p_first + p_hole_idx] = p_value;
}
inline void pop_heap(int p_first, int p_last, int p_result, T p_value, T *p_array) const {
2016-03-08 23:00:52 +00:00
p_array[p_result] = p_array[p_first];
adjust_heap(p_first, 0, p_last - p_first, p_value, p_array);
2014-02-10 01:10:30 +00:00
}
inline void pop_heap(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
pop_heap(p_first, p_last - 1, p_last - 1, p_array[p_last - 1], p_array);
2014-02-10 01:10:30 +00:00
}
2016-03-08 23:00:52 +00:00
inline void adjust_heap(int p_first, int p_hole_idx, int p_len, T p_value, T *p_array) const {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
int top_index = p_hole_idx;
int second_child = 2 * p_hole_idx + 2;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
while (second_child < p_len) {
2016-03-08 23:00:52 +00:00
if (compare(p_array[p_first + second_child], p_array[p_first + (second_child - 1)]))
2014-02-10 01:10:30 +00:00
second_child--;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
p_array[p_first + p_hole_idx] = p_array[p_first + second_child];
p_hole_idx = second_child;
second_child = 2 * (second_child + 1);
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
if (second_child == p_len) {
p_array[p_first + p_hole_idx] = p_array[p_first + (second_child - 1)];
p_hole_idx = second_child - 1;
}
push_heap(p_first, p_hole_idx, top_index, p_value, p_array);
2014-02-10 01:10:30 +00:00
}
2016-03-08 23:00:52 +00:00
inline void sort_heap(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
while (p_last - p_first > 1) {
2016-03-08 23:00:52 +00:00
pop_heap(p_first, p_last--, p_array);
2014-02-10 01:10:30 +00:00
}
}
2016-03-08 23:00:52 +00:00
inline void make_heap(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
if (p_last - p_first < 2)
2014-02-10 01:10:30 +00:00
return;
int len = p_last - p_first;
int parent = (len - 2) / 2;
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
while (true) {
adjust_heap(p_first, parent, len, p_array[p_first + parent], p_array);
2016-03-08 23:00:52 +00:00
if (parent == 0)
2014-02-10 01:10:30 +00:00
return;
parent--;
}
}
2016-03-08 23:00:52 +00:00
inline void partial_sort(int p_first, int p_last, int p_middle, T *p_array) const {
2016-03-08 23:00:52 +00:00
make_heap(p_first, p_middle, p_array);
for (int i = p_middle; i < p_last; i++)
if (compare(p_array[i], p_array[p_first]))
pop_heap(p_first, p_middle, i, p_array[i], p_array);
sort_heap(p_first, p_middle, p_array);
2014-02-10 01:10:30 +00:00
}
inline void partial_select(int p_first, int p_last, int p_middle, T *p_array) const {
2014-02-10 01:10:30 +00:00
make_heap(p_first, p_middle, p_array);
for (int i = p_middle; i < p_last; i++)
if (compare(p_array[i], p_array[p_first]))
pop_heap(p_first, p_middle, i, p_array[i], p_array);
2014-02-10 01:10:30 +00:00
}
inline int partitioner(int p_first, int p_last, T p_pivot, T *p_array) const {
2016-03-08 23:00:52 +00:00
const int unmodified_first = p_first;
const int unmodified_last = p_last;
2014-02-10 01:10:30 +00:00
while (true) {
while (compare(p_array[p_first], p_pivot)) {
if (Validate) {
ERR_BAD_COMPARE(p_first == unmodified_last - 1)
}
2014-02-10 01:10:30 +00:00
p_first++;
}
2014-02-10 01:10:30 +00:00
p_last--;
while (compare(p_pivot, p_array[p_last])) {
if (Validate) {
ERR_BAD_COMPARE(p_last == unmodified_first)
}
2014-02-10 01:10:30 +00:00
p_last--;
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
if (!(p_first < p_last))
return p_first;
2016-03-08 23:00:52 +00:00
SWAP(p_array[p_first], p_array[p_last]);
2014-02-10 01:10:30 +00:00
p_first++;
}
}
inline void introsort(int p_first, int p_last, T *p_array, int p_max_depth) const {
2014-02-10 01:10:30 +00:00
2017-07-08 15:12:18 +00:00
while (p_last - p_first > INTROSORT_THRESHOLD) {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
if (p_max_depth == 0) {
partial_sort(p_first, p_last, p_last, p_array);
2014-02-10 01:10:30 +00:00
return;
}
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
p_max_depth--;
2016-03-08 23:00:52 +00:00
int cut = partitioner(
p_first,
p_last,
median_of_3(
p_array[p_first],
p_array[p_first + (p_last - p_first) / 2],
p_array[p_last - 1]),
p_array);
introsort(cut, p_last, p_array, p_max_depth);
p_last = cut;
2014-02-10 01:10:30 +00:00
}
}
2014-02-10 01:10:30 +00:00
inline void introselect(int p_first, int p_nth, int p_last, T *p_array, int p_max_depth) const {
2014-02-10 01:10:30 +00:00
while (p_last - p_first > 3) {
2014-02-10 01:10:30 +00:00
if (p_max_depth == 0) {
partial_select(p_first, p_nth + 1, p_last, p_array);
SWAP(p_first, p_nth);
2014-02-10 01:10:30 +00:00
return;
}
p_max_depth--;
int cut = partitioner(
p_first,
p_last,
median_of_3(
p_array[p_first],
p_array[p_first + (p_last - p_first) / 2],
p_array[p_last - 1]),
p_array);
if (cut <= p_nth)
p_first = cut;
2014-02-10 01:10:30 +00:00
else
p_last = cut;
2014-02-10 01:10:30 +00:00
}
insertion_sort(p_first, p_last, p_array);
2014-02-10 01:10:30 +00:00
}
inline void unguarded_linear_insert(int p_last, T p_value, T *p_array) const {
2016-03-08 23:00:52 +00:00
int next = p_last - 1;
while (compare(p_value, p_array[next])) {
if (Validate) {
ERR_BAD_COMPARE(next == 0)
}
p_array[p_last] = p_array[next];
2014-02-10 01:10:30 +00:00
p_last = next;
next--;
}
p_array[p_last] = p_value;
}
2016-03-08 23:00:52 +00:00
inline void linear_insert(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
T val = p_array[p_last];
if (compare(val, p_array[p_first])) {
2016-03-08 23:00:52 +00:00
for (int i = p_last; i > p_first; i--)
p_array[i] = p_array[i - 1];
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
p_array[p_first] = val;
} else
2016-03-08 23:00:52 +00:00
unguarded_linear_insert(p_last, val, p_array);
2014-02-10 01:10:30 +00:00
}
2016-03-08 23:00:52 +00:00
inline void insertion_sort(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
if (p_first == p_last)
2014-02-10 01:10:30 +00:00
return;
for (int i = p_first + 1; i != p_last; i++)
linear_insert(p_first, i, p_array);
2014-02-10 01:10:30 +00:00
}
2016-03-08 23:00:52 +00:00
inline void unguarded_insertion_sort(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
for (int i = p_first; i != p_last; i++)
unguarded_linear_insert(i, p_array[i], p_array);
2014-02-10 01:10:30 +00:00
}
2016-03-08 23:00:52 +00:00
inline void final_insertion_sort(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
2017-07-08 15:12:18 +00:00
if (p_last - p_first > INTROSORT_THRESHOLD) {
insertion_sort(p_first, p_first + INTROSORT_THRESHOLD, p_array);
unguarded_insertion_sort(p_first + INTROSORT_THRESHOLD, p_last, p_array);
2014-02-10 01:10:30 +00:00
} else {
2016-03-08 23:00:52 +00:00
insertion_sort(p_first, p_last, p_array);
2016-03-08 23:00:52 +00:00
}
}
2014-02-10 01:10:30 +00:00
inline void sort_range(int p_first, int p_last, T *p_array) const {
2016-03-08 23:00:52 +00:00
2014-02-10 01:10:30 +00:00
if (p_first != p_last) {
introsort(p_first, p_last, p_array, bitlog(p_last - p_first) * 2);
2014-02-10 01:10:30 +00:00
final_insertion_sort(p_first, p_last, p_array);
}
}
inline void sort(T *p_array, int p_len) const {
2016-03-08 23:00:52 +00:00
sort_range(0, p_len, p_array);
2014-02-10 01:10:30 +00:00
}
inline void nth_element(int p_first, int p_last, int p_nth, T *p_array) const {
2014-02-10 01:10:30 +00:00
if (p_first == p_last || p_nth == p_last)
2014-02-10 01:10:30 +00:00
return;
introselect(p_first, p_nth, p_last, p_array, bitlog(p_last - p_first) * 2);
2014-02-10 01:10:30 +00:00
}
};
#endif