doxygen: add newline after \file
[blender.git] / source / blender / blenlib / intern / sort.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup bli
22  */
23
24 #include <stdlib.h>
25
26 #if defined(__GLIBC__) && (__GLIBC__ > 2 || (__GLIBC__ == 2 && __GLIBC_MINOR__ >= 8))
27 /* do nothing! */
28 #else
29
30 #include "BLI_utildefines.h"
31
32 #include "BLI_sort.h"
33
34 #ifdef min  /* for msvc */
35 #  undef min
36 #endif
37
38 /**
39  * qsort, copied from FreeBSD source.
40  * with only very minor edits, see:
41  * http://github.com/freebsd/freebsd/blob/master/sys/libkern/qsort.c
42  *
43  * \note modified to use glibc arg order for callbacks.
44  */
45 BLI_INLINE char *med3(char *, char *, char *, BLI_sort_cmp_t, void *);
46 BLI_INLINE void  swapfunc(char *, char *, int, int);
47
48 #define min(a, b)       (a) < (b) ? (a) : (b)
49 #define swapcode(TYPE, parmi, parmj, n)         \
50 {                                                                                       \
51         long i = (n) / sizeof(TYPE);                    \
52         TYPE *pi = (TYPE *) (parmi);                    \
53         TYPE *pj = (TYPE *) (parmj);                    \
54         do {                                                                    \
55                 TYPE    t = *pi;                                        \
56                 *pi++ = *pj;                                            \
57                 *pj++ = t;                                                      \
58         } while (--i > 0);                                              \
59 }
60 #define SWAPINIT(a, es) swaptype = ((char *)a - (char *)0) % sizeof(long) || \
61         es % sizeof(long) ? 2 : es == sizeof(long)? 0 : 1;
62
63 BLI_INLINE void swapfunc(char *a, char *b, int n, int swaptype)
64 {
65         if (swaptype <= 1)
66                 swapcode(long, a, b, n)
67         else
68                 swapcode(char, a, b, n)
69 }
70
71 #define swap(a, b)                                      \
72         if (swaptype == 0) {                    \
73                 long t = *(long *)(a);          \
74                 *(long *)(a) = *(long *)(b);\
75                 *(long *)(b) = t;                       \
76         } else                                                  \
77                 swapfunc(a, b, es, swaptype)
78
79 #define vecswap(a, b, n)        if ((n) > 0) swapfunc(a, b, n, swaptype)
80 #define CMP(t, x, y) (cmp((x), (y), (t)))
81
82 BLI_INLINE char *med3(char *a, char *b, char *c, BLI_sort_cmp_t cmp, void *thunk)
83 {
84         return  CMP(thunk, a, b) < 0 ?
85                (CMP(thunk, b, c) < 0 ? b : (CMP(thunk, a, c) < 0 ? c : a )) :
86                (CMP(thunk, b, c) > 0 ? b : (CMP(thunk, a, c) < 0 ? a : c ));
87 }
88
89 /**
90  * Quick sort reentrant.
91  */
92 void BLI_qsort_r(void *a, size_t n, size_t es, BLI_sort_cmp_t cmp, void *thunk)
93 {
94         char *pa, *pb, *pc, *pd, *pl, *pm, *pn;
95         int d, r, swaptype, swap_cnt;
96
97 loop:
98         SWAPINIT(a, es);
99         swap_cnt = 0;
100         if (n < 7) {
101                 for (pm = (char *)a + es; pm < (char *)a + n * es; pm += es) {
102                         for (pl = pm;
103                              pl > (char *)a && CMP(thunk, pl - es, pl) > 0;
104                              pl -= es)
105                         {
106                                 swap(pl, pl - es);
107                         }
108                 }
109                 return;
110         }
111         pm = (char *)a + (n / 2) * es;
112         if (n > 7) {
113                 pl = (char *)a;
114                 pn = (char *)a + (n - 1) * es;
115                 if (n > 40) {
116                         d = (n / 8) * es;
117                         pl = med3(pl, pl + d, pl + 2 * d, cmp, thunk);
118                         pm = med3(pm - d, pm, pm + d, cmp, thunk);
119                         pn = med3(pn - 2 * d, pn - d, pn, cmp, thunk);
120                 }
121                 pm = med3(pl, pm, pn, cmp, thunk);
122         }
123         swap((char *)a, pm);
124         pa = pb = (char *)a + es;
125
126         pc = pd = (char *)a + (n - 1) * es;
127         for (;;) {
128                 while (pb <= pc && (r = CMP(thunk, pb, a)) <= 0) {
129                         if (r == 0) {
130                                 swap_cnt = 1;
131                                 swap(pa, pb);
132                                 pa += es;
133                         }
134                         pb += es;
135                 }
136                 while (pb <= pc && (r = CMP(thunk, pc, a)) >= 0) {
137                         if (r == 0) {
138                                 swap_cnt = 1;
139                                 swap(pc, pd);
140                                 pd -= es;
141                         }
142                         pc -= es;
143                 }
144                 if (pb > pc)
145                         break;
146                 swap(pb, pc);
147                 swap_cnt = 1;
148                 pb += es;
149                 pc -= es;
150         }
151         if (swap_cnt == 0) {  /* Switch to insertion sort */
152                 for (pm = (char *)a + es; pm < (char *)a + n * es; pm += es) {
153                         for (pl = pm;
154                              pl > (char *)a && CMP(thunk, pl - es, pl) > 0;
155                              pl -= es)
156                         {
157                                 swap(pl, pl - es);
158                         }
159                 }
160                 return;
161         }
162
163         pn = (char *)a + n * es;
164         r = min(pa - (char *)a, pb - pa);
165         vecswap((char *)a, pb - r, r);
166         r = min(pd - pc, pn - pd - es);
167         vecswap(pb, pn - r, r);
168         if ((r = pb - pa) > es)
169                 BLI_qsort_r(a, r / es, es, cmp, thunk);
170         if ((r = pd - pc) > es) {
171                 /* Iterate rather than recurse to save stack space */
172                 a = pn - r;
173                 n = r / es;
174                 goto loop;
175         }
176 }
177
178 #endif  /* __GLIBC__ */