Initial Skype commit taken from FreeSwitch, which got it from the IETF draft.
[opus.git] / src_SigProc_FIX / SKP_Silk_sort.c
1 /***********************************************************************\r
2 Copyright (c) 2006-2010, Skype Limited. All rights reserved. \r
3 Redistribution and use in source and binary forms, with or without \r
4 modification, (subject to the limitations in the disclaimer below) \r
5 are permitted provided that the following conditions are met:\r
6 - Redistributions of source code must retain the above copyright notice,\r
7 this list of conditions and the following disclaimer.\r
8 - Redistributions in binary form must reproduce the above copyright \r
9 notice, this list of conditions and the following disclaimer in the \r
10 documentation and/or other materials provided with the distribution.\r
11 - Neither the name of Skype Limited, nor the names of specific \r
12 contributors, may be used to endorse or promote products derived from \r
13 this software without specific prior written permission.\r
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED \r
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND \r
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,\r
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \r
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE \r
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, \r
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF \r
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON \r
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT \r
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE \r
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
26 ***********************************************************************/\r
27 \r
28 /* Insertion sort (fast for already almost sorted arrays):   */\r
29 /* Best case:  O(n)   for an already sorted array            */\r
30 /* Worst case: O(n^2) for an inversely sorted array          */\r
31 /*                                                           */\r
32 /* Shell short:    http://en.wikipedia.org/wiki/Shell_sort   */\r
33 \r
34 #include "SKP_Silk_SigProc_FIX.h"\r
35 \r
36 void SKP_Silk_insertion_sort_increasing(\r
37     SKP_int32           *a,             /* I/O:  Unsorted / Sorted vector               */\r
38     SKP_int             *index,         /* O:    Index vector for the sorted elements   */\r
39     const SKP_int       L,              /* I:    Vector length                          */\r
40     const SKP_int       K               /* I:    Number of correctly sorted positions   */\r
41 )\r
42 {\r
43     SKP_int32    value;\r
44     SKP_int        i, j;\r
45 \r
46     /* Safety checks */\r
47     SKP_assert( K >  0 );\r
48     SKP_assert( L >  0 );\r
49     SKP_assert( L >= K );\r
50 \r
51     /* Write start indices in index vector */\r
52     for( i = 0; i < K; i++ ) {\r
53         index[ i ] = i;\r
54     }\r
55 \r
56     /* Sort vector elements by value, increasing order */\r
57     for( i = 1; i < K; i++ ) {\r
58         value = a[ i ];\r
59         for( j = i - 1; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {\r
60             a[ j + 1 ]     = a[ j ];     /* Shift value */\r
61             index[ j + 1 ] = index[ j ]; /* Shift index */\r
62         }\r
63         a[ j + 1 ]     = value; /* Write value */\r
64         index[ j + 1 ] = i;     /* Write index */\r
65     }\r
66 \r
67     /* If less than L values are asked for, check the remaining values, */\r
68     /* but only spend CPU to ensure that the K first values are correct */\r
69     for( i = K; i < L; i++ ) {\r
70         value = a[ i ];\r
71         if( value < a[ K - 1 ] ) {\r
72             for( j = K - 2; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {\r
73                 a[ j + 1 ]     = a[ j ];     /* Shift value */\r
74                 index[ j + 1 ] = index[ j ]; /* Shift index */\r
75             }\r
76             a[ j + 1 ]     = value; /* Write value */\r
77             index[ j + 1 ] = i;        /* Write index */\r
78         }\r
79     }\r
80 }\r
81 \r
82 void SKP_Silk_insertion_sort_decreasing(\r
83     SKP_int             *a,             /* I/O: Unsorted / Sorted vector                */\r
84     SKP_int             *index,         /* O:   Index vector for the sorted elements    */\r
85     const SKP_int       L,              /* I:   Vector length                           */\r
86     const SKP_int       K               /* I:   Number of correctly sorted positions    */\r
87 )\r
88 {\r
89     SKP_int    value;\r
90     SKP_int    i, j;\r
91 \r
92     /* Safety checks */\r
93     SKP_assert( K >  0 );\r
94     SKP_assert( L >  0 );\r
95     SKP_assert( L >= K );\r
96 \r
97     /* Write start indices in index vector */\r
98     for( i = 0; i < K; i++ ) {\r
99         index[ i ] = i;\r
100     }\r
101 \r
102     /* Sort vector elements by value, decreasing order */\r
103     for( i = 1; i < K; i++ ) {\r
104         value = a[ i ];\r
105         for( j = i - 1; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {\r
106             a[ j + 1 ]     = a[ j ];     /* Shift value */\r
107             index[ j + 1 ] = index[ j ]; /* Shift index */\r
108         }\r
109         a[ j + 1 ]     = value; /* Write value */\r
110         index[ j + 1 ] = i;     /* Write index */\r
111     }\r
112 \r
113     /* If less than L values are asked for, check the remaining values, */\r
114     /* but only spend CPU to ensure that the K first values are correct */\r
115     for( i = K; i < L; i++ ) {\r
116         value = a[ i ];\r
117         if( value > a[ K - 1 ] ) {\r
118             for( j = K - 2; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {\r
119                 a[ j + 1 ]     = a[ j ];     /* Shift value */\r
120                 index[ j + 1 ] = index[ j ]; /* Shift index */\r
121             }\r
122             a[ j + 1 ]     = value; /* Write value */\r
123             index[ j + 1 ] = i;     /* Write index */\r
124         }\r
125     }\r
126 }\r
127 \r
128 void SKP_Silk_insertion_sort_decreasing_int16(\r
129     SKP_int16           *a,             /* I/O: Unsorted / Sorted vector                */\r
130     SKP_int             *index,         /* O:   Index vector for the sorted elements    */\r
131     const SKP_int       L,              /* I:   Vector length                           */\r
132     const SKP_int       K               /* I:   Number of correctly sorted positions    */\r
133 )\r
134 {\r
135     SKP_int i, j;\r
136     SKP_int value;\r
137 \r
138     /* Safety checks */\r
139     SKP_assert( K >  0 );\r
140     SKP_assert( L >  0 );\r
141     SKP_assert( L >= K );\r
142 \r
143     /* Write start indices in index vector */\r
144     for( i = 0; i < K; i++ ) {\r
145         index[ i ] = i;\r
146     }\r
147 \r
148     /* Sort vector elements by value, decreasing order */\r
149     for( i = 1; i < K; i++ ) {\r
150         value = a[ i ];\r
151         for( j = i - 1; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {    \r
152             a[ j + 1 ]     = a[ j ];     /* Shift value */\r
153             index[ j + 1 ] = index[ j ]; /* Shift index */\r
154         }\r
155         a[ j + 1 ]     = value; /* Write value */\r
156         index[ j + 1 ] = i;     /* Write index */\r
157     }\r
158 \r
159     /* If less than L values are asked for, check the remaining values, */\r
160     /* but only spend CPU to ensure that the K first values are correct */\r
161     for( i = K; i < L; i++ ) {\r
162         value = a[ i ];\r
163         if( value > a[ K - 1 ] ) {\r
164             for( j = K - 2; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {    \r
165                 a[ j + 1 ]     = a[ j ];     /* Shift value */\r
166                 index[ j + 1 ] = index[ j ]; /* Shift index */\r
167             }\r
168             a[ j + 1 ]     = value; /* Write value */\r
169             index[ j + 1 ] = i;     /* Write index */\r
170         }\r
171     }\r
172 }\r
173 \r
174 void SKP_Silk_insertion_sort_increasing_all_values(\r
175     SKP_int             *a,             /* I/O: Unsorted / Sorted vector                */\r
176     const SKP_int       L               /* I:   Vector length                           */\r
177 )\r
178 {\r
179     SKP_int    value;\r
180     SKP_int    i, j;\r
181 \r
182     /* Safety checks */\r
183     SKP_assert( L >  0 );\r
184 \r
185     /* Sort vector elements by value, increasing order */\r
186     for( i = 1; i < L; i++ ) {\r
187         value = a[ i ];\r
188         for( j = i - 1; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {\r
189             a[ j + 1 ] = a[ j ]; /* Shift value */\r
190         }\r
191         a[ j + 1 ] = value; /* Write value */\r
192     }\r
193 }\r
194 \r
195 void SKP_Silk_shell_insertion_sort_increasing(\r
196     SKP_int32           *a,             /* I/O:  Unsorted / Sorted vector               */\r
197     SKP_int             *index,         /* O:    Index vector for the sorted elements   */\r
198     const SKP_int       L,              /* I:    Vector length                          */\r
199     const SKP_int       K               /* I:    Number of correctly sorted positions   */\r
200 )\r
201 {\r
202     SKP_int32    value, inc_Q16_tmp;\r
203     SKP_int      i, j, inc, idx;\r
204    \r
205     /* Safety checks */\r
206     SKP_assert( K >  0 );\r
207     SKP_assert( L >  0 );\r
208     SKP_assert( L >= K );\r
209     \r
210     /* Calculate initial step size */\r
211     inc_Q16_tmp = SKP_LSHIFT( (SKP_int32)L, 15 );\r
212     inc = SKP_RSHIFT( inc_Q16_tmp, 16 );\r
213 \r
214     /* Write start indices in index vector */\r
215     for( i = 0; i < K; i++ ) {\r
216         index[ i ] = i;\r
217     }\r
218 \r
219     /* Shell sort first values */\r
220     while( inc > 0 ) {\r
221         for( i = inc; i < K; i++ ) {\r
222             value = a[ i ];\r
223             idx   = index[ i ];\r
224             for( j = i - inc; ( j >= 0 ) && ( value < a[ j ] ); j -= inc ) {\r
225                 a[ j + inc ]     = a[ j ];     /* Shift value */\r
226                 index[ j + inc ] = index[ j ]; /* Shift index */\r
227             }\r
228             a[ j + inc ]     = value; /* Write value */\r
229             index[ j + inc ] = idx;   /* Write index */\r
230         }\r
231         inc_Q16_tmp = SKP_SMULWB( inc_Q16_tmp, 29789 ); // 29789_Q16 = 2.2^(-1)_Q0\r
232         inc = SKP_RSHIFT_ROUND( inc_Q16_tmp, 16 );\r
233     }\r
234 \r
235     /* If less than L values are asked for, check the remaining values, */\r
236     /* but only spend CPU to ensure that the K first values are correct */\r
237     /* Insertion sort remaining values */\r
238     for( i = K; i < L; i++ ) {\r
239         value = a[ i ];\r
240         if( value < a[ K - 1 ] ) {\r
241             for( j = K - 2; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {\r
242                 a[ j + 1 ]     = a[ j ];     /* Shift value */\r
243                 index[ j + 1 ] = index[ j ]; /* Shift index */\r
244             }\r
245             a[ j + 1 ]     = value; /* Write value */\r
246             index[ j + 1 ] = i;     /* Write index */\r
247         }\r
248     }\r
249 }\r
250 \r
251 void SKP_Silk_shell_sort_increasing_all_values(\r
252     SKP_int32           *a,             /* I/O:  Unsorted / Sorted vector               */\r
253     SKP_int             *index,         /* O:    Index vector for the sorted elements   */\r
254     const SKP_int       L               /* I:    Vector length                          */\r
255 )\r
256 {\r
257     SKP_int32    value, inc_Q16_tmp;\r
258     SKP_int      i, j, inc, idx;\r
259    \r
260     /* Safety checks */\r
261     SKP_assert( L >  0 );\r
262  \r
263     /* Calculate initial step size */\r
264     inc_Q16_tmp = SKP_LSHIFT( (SKP_int32)L, 15 );\r
265     inc = SKP_RSHIFT( inc_Q16_tmp, 16 );\r
266 \r
267     /* Write start indices in index vector */\r
268     for( i = 0; i < L; i++ ) {\r
269         index[ i ] = i;\r
270     }\r
271 \r
272     /* Sort vector elements by value, increasing order */\r
273     while( inc > 0 ) {\r
274         for( i = inc; i < L; i++ ) {\r
275             value = a[ i ];\r
276             idx = index[ i ];\r
277             for( j = i - inc; ( j >= 0 ) && ( value < a[ j ] ); j -= inc ) {\r
278                 a[ j + inc ]     = a[ j ];     /* Shift value */\r
279                 index[ j + inc ] = index[ j ]; /* Shift index */\r
280             }\r
281             a[ j + inc ] = value;   /* Write value */\r
282             index[ j + inc ] = idx; /* Write index */\r
283         }\r
284         inc_Q16_tmp = SKP_SMULWB( inc_Q16_tmp, 29789 ); // 29789_Q16 = 2.2^(-1)_Q0\r
285         inc = SKP_RSHIFT_ROUND( inc_Q16_tmp, 16 );\r
286     }\r
287 }\r