2c539caf2c361824783c10d3140cb1dda3f9907d
[opus.git] / silk / silk_sort.c
1 /***********************************************************************
2 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
3 Redistribution and use in source and binary forms, with or without
4 modification, (subject to the limitations in the disclaimer below)
5 are permitted provided that the following conditions are met:
6 - Redistributions of source code must retain the above copyright notice,
7 this list of conditions and the following disclaimer.
8 - Redistributions in binary form must reproduce the above copyright
9 notice, this list of conditions and the following disclaimer in the
10 documentation and/or other materials provided with the distribution.
11 - Neither the name of Skype Limited, nor the names of specific
12 contributors, may be used to endorse or promote products derived from
13 this software without specific prior written permission.
14 NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
15 BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
16 CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
17 BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
18 FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
22 USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
23 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 ***********************************************************************/
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 /* Insertion sort (fast for already almost sorted arrays):   */
33 /* Best case:  O(n)   for an already sorted array            */
34 /* Worst case: O(n^2) for an inversely sorted array          */
35 /*                                                           */
36 /* Shell short:    http://en.wikipedia.org/wiki/Shell_sort   */
37
38 #include "silk_SigProc_FIX.h"
39
40 void silk_insertion_sort_increasing(
41     opus_int32           *a,             /* I/O:  Unsorted / Sorted vector               */
42     opus_int             *idx,           /* O:    Index vector for the sorted elements   */
43     const opus_int       L,              /* I:    Vector length                          */
44     const opus_int       K               /* I:    Number of correctly sorted positions   */
45 )
46 {
47     opus_int32    value;
48     opus_int        i, j;
49
50     /* Safety checks */
51     silk_assert( K >  0 );
52     silk_assert( L >  0 );
53     silk_assert( L >= K );
54
55     /* Write start indices in index vector */
56     for( i = 0; i < K; i++ ) {
57         idx[ i ] = i;
58     }
59
60     /* Sort vector elements by value, increasing order */
61     for( i = 1; i < K; i++ ) {
62         value = a[ i ];
63         for( j = i - 1; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {
64             a[ j + 1 ]   = a[ j ];       /* Shift value */
65             idx[ j + 1 ] = idx[ j ];     /* Shift index */
66         }
67         a[ j + 1 ]   = value;   /* Write value */
68         idx[ j + 1 ] = i;       /* Write index */
69     }
70
71     /* If less than L values are asked for, check the remaining values, */
72     /* but only spend CPU to ensure that the K first values are correct */
73     for( i = K; i < L; i++ ) {
74         value = a[ i ];
75         if( value < a[ K - 1 ] ) {
76             for( j = K - 2; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {
77                 a[ j + 1 ]   = a[ j ];       /* Shift value */
78                 idx[ j + 1 ] = idx[ j ];     /* Shift index */
79             }
80             a[ j + 1 ]   = value;   /* Write value */
81             idx[ j + 1 ] = i;       /* Write index */
82         }
83     }
84 }
85
86 void silk_insertion_sort_decreasing_int16(
87     opus_int16           *a,             /* I/O: Unsorted / Sorted vector                */
88     opus_int             *idx,           /* O:   Index vector for the sorted elements    */
89     const opus_int       L,              /* I:   Vector length                           */
90     const opus_int       K               /* I:   Number of correctly sorted positions    */
91 )
92 {
93     opus_int i, j;
94     opus_int value;
95
96     /* Safety checks */
97     silk_assert( K >  0 );
98     silk_assert( L >  0 );
99     silk_assert( L >= K );
100
101     /* Write start indices in index vector */
102     for( i = 0; i < K; i++ ) {
103         idx[ i ] = i;
104     }
105
106     /* Sort vector elements by value, decreasing order */
107     for( i = 1; i < K; i++ ) {
108         value = a[ i ];
109         for( j = i - 1; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {
110             a[ j + 1 ]   = a[ j ];     /* Shift value */
111             idx[ j + 1 ] = idx[ j ];   /* Shift index */
112         }
113         a[ j + 1 ]   = value;   /* Write value */
114         idx[ j + 1 ] = i;       /* Write index */
115     }
116
117     /* If less than L values are asked for, check the remaining values, */
118     /* but only spend CPU to ensure that the K first values are correct */
119     for( i = K; i < L; i++ ) {
120         value = a[ i ];
121         if( value > a[ K - 1 ] ) {
122             for( j = K - 2; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {
123                 a[ j + 1 ]   = a[ j ];     /* Shift value */
124                 idx[ j + 1 ] = idx[ j ];   /* Shift index */
125             }
126             a[ j + 1 ]   = value;   /* Write value */
127             idx[ j + 1 ] = i;       /* Write index */
128         }
129     }
130 }
131
132 void silk_insertion_sort_increasing_all_values_int16(
133     opus_int16           *a,             /* I/O: Unsorted / Sorted vector                */
134     const opus_int       L               /* I:   Vector length                           */
135 )
136 {
137     opus_int    value;
138     opus_int    i, j;
139
140     /* Safety checks */
141     silk_assert( L >  0 );
142
143     /* Sort vector elements by value, increasing order */
144     for( i = 1; i < L; i++ ) {
145         value = a[ i ];
146         for( j = i - 1; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {
147             a[ j + 1 ] = a[ j ]; /* Shift value */
148         }
149         a[ j + 1 ] = value; /* Write value */
150     }
151 }