Eliminate some unreachable cases from the cwrs code and fixup the
[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 /* Insertion sort (fast for already almost sorted arrays):   */
29 /* Best case:  O(n)   for an already sorted array            */
30 /* Worst case: O(n^2) for an inversely sorted array          */
31 /*                                                           */
32 /* Shell short:    http://en.wikipedia.org/wiki/Shell_sort   */
33
34 #include "silk_SigProc_FIX.h"
35
36 void silk_insertion_sort_increasing(
37     opus_int32           *a,             /* I/O:  Unsorted / Sorted vector               */
38     opus_int             *idx,           /* O:    Index vector for the sorted elements   */
39     const opus_int       L,              /* I:    Vector length                          */
40     const opus_int       K               /* I:    Number of correctly sorted positions   */
41 )
42 {
43     opus_int32    value;
44     opus_int        i, j;
45
46     /* Safety checks */
47     SKP_assert( K >  0 );
48     SKP_assert( L >  0 );
49     SKP_assert( L >= K );
50
51     /* Write start indices in index vector */
52     for( i = 0; i < K; i++ ) {
53         idx[ i ] = i;
54     }
55
56     /* Sort vector elements by value, increasing order */
57     for( i = 1; i < K; i++ ) {
58         value = a[ i ];
59         for( j = i - 1; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {
60             a[ j + 1 ]   = a[ j ];       /* Shift value */
61             idx[ j + 1 ] = idx[ j ];     /* Shift index */
62         }
63         a[ j + 1 ]   = value;   /* Write value */
64         idx[ j + 1 ] = i;       /* Write index */
65     }
66
67     /* If less than L values are asked for, check the remaining values, */
68     /* but only spend CPU to ensure that the K first values are correct */
69     for( i = K; i < L; i++ ) {
70         value = a[ i ];
71         if( value < a[ K - 1 ] ) {
72             for( j = K - 2; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {
73                 a[ j + 1 ]   = a[ j ];       /* Shift value */
74                 idx[ j + 1 ] = idx[ j ];     /* Shift index */
75             }
76             a[ j + 1 ]   = value;   /* Write value */
77             idx[ j + 1 ] = i;       /* Write index */
78         }
79     }
80 }
81
82 void silk_insertion_sort_decreasing_int16(
83     opus_int16           *a,             /* I/O: Unsorted / Sorted vector                */
84     opus_int             *idx,           /* O:   Index vector for the sorted elements    */
85     const opus_int       L,              /* I:   Vector length                           */
86     const opus_int       K               /* I:   Number of correctly sorted positions    */
87 )
88 {
89     opus_int i, j;
90     opus_int value;
91
92     /* Safety checks */
93     SKP_assert( K >  0 );
94     SKP_assert( L >  0 );
95     SKP_assert( L >= K );
96
97     /* Write start indices in index vector */
98     for( i = 0; i < K; i++ ) {
99         idx[ i ] = i;
100     }
101
102     /* Sort vector elements by value, decreasing order */
103     for( i = 1; i < K; i++ ) {
104         value = a[ i ];
105         for( j = i - 1; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {
106             a[ j + 1 ]   = a[ j ];     /* Shift value */
107             idx[ j + 1 ] = idx[ j ];   /* Shift index */
108         }
109         a[ j + 1 ]   = value;   /* Write value */
110         idx[ j + 1 ] = i;       /* Write index */
111     }
112
113     /* If less than L values are asked for, check the remaining values, */
114     /* but only spend CPU to ensure that the K first values are correct */
115     for( i = K; i < L; i++ ) {
116         value = a[ i ];
117         if( value > a[ K - 1 ] ) {
118             for( j = K - 2; ( j >= 0 ) && ( value > a[ j ] ); j-- ) {
119                 a[ j + 1 ]   = a[ j ];     /* Shift value */
120                 idx[ j + 1 ] = idx[ j ];   /* Shift index */
121             }
122             a[ j + 1 ]   = value;   /* Write value */
123             idx[ j + 1 ] = i;       /* Write index */
124         }
125     }
126 }
127
128 void silk_insertion_sort_increasing_all_values_int16(
129     opus_int16           *a,             /* I/O: Unsorted / Sorted vector                */
130     const opus_int       L               /* I:   Vector length                           */
131 )
132 {
133     opus_int    value;
134     opus_int    i, j;
135
136     /* Safety checks */
137     SKP_assert( L >  0 );
138
139     /* Sort vector elements by value, increasing order */
140     for( i = 1; i < L; i++ ) {
141         value = a[ i ];
142         for( j = i - 1; ( j >= 0 ) && ( value < a[ j ] ); j-- ) {
143             a[ j + 1 ] = a[ j ]; /* Shift value */
144         }
145         a[ j + 1 ] = value; /* Write value */
146     }
147 }