Convert all CRLF in the SILK code, tabs to spaces, and trailing
[opus.git] / silk / float / silk_solve_LS_FLP.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 #include "silk_main_FLP.h"
29 #include "silk_tuning_parameters.h"
30
31 /**********************************************************************
32  * LDL Factorisation. Finds the upper triangular matrix L and the diagonal
33  * Matrix D (only the diagonal elements returned in a vector)such that
34  * the symmetric matric A is given by A = L*D*L'.
35  **********************************************************************/
36 void silk_LDL_FLP(
37     SKP_float           *A,      /* (I/O) Pointer to Symetric Square Matrix */
38     opus_int             M,       /* (I) Size of Matrix */
39     SKP_float           *L,      /* (I/O) Pointer to Square Upper triangular Matrix */
40     SKP_float           *Dinv    /* (I/O) Pointer to vector holding the inverse diagonal elements of D */
41 );
42
43 /**********************************************************************
44  * Function to solve linear equation Ax = b, when A is a MxM lower
45  * triangular matrix, with ones on the diagonal.
46  **********************************************************************/
47 void silk_SolveWithLowerTriangularWdiagOnes_FLP(
48     const SKP_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
49     opus_int             M,      /* (I) Dim of Matrix equation */
50     const SKP_float     *b,     /* (I) b Vector */
51     SKP_float           *x      /* (O) x Vector */
52 );
53
54 /**********************************************************************
55  * Function to solve linear equation (A^T)x = b, when A is a MxM lower
56  * triangular, with ones on the diagonal. (ie then A^T is upper triangular)
57  **********************************************************************/
58 void silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP(
59     const SKP_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
60     opus_int             M,      /* (I) Dim of Matrix equation */
61     const SKP_float     *b,     /* (I) b Vector */
62     SKP_float           *x      /* (O) x Vector */
63 );
64
65 /**********************************************************************
66  * Function to solve linear equation Ax = b, when A is a MxM
67  * symmetric square matrix - using LDL factorisation
68  **********************************************************************/
69 void silk_solve_LDL_FLP(
70           SKP_float                 *A,                 /* I/O  Symmetric square matrix, out: reg.      */
71     const opus_int                   M,                  /* I    Size of matrix                          */
72     const SKP_float                 *b,                 /* I    Pointer to b vector                     */
73           SKP_float                 *x                  /* O    Pointer to x solution vector            */
74 )
75 {
76     opus_int   i;
77     SKP_float L[    MAX_MATRIX_SIZE ][ MAX_MATRIX_SIZE ];
78     SKP_float T[    MAX_MATRIX_SIZE ];
79     SKP_float Dinv[ MAX_MATRIX_SIZE ]; // inverse diagonal elements of D
80
81     SKP_assert( M <= MAX_MATRIX_SIZE );
82
83     /***************************************************
84     Factorize A by LDL such that A = L*D*(L^T),
85     where L is lower triangular with ones on diagonal
86     ****************************************************/
87     silk_LDL_FLP( A, M, &L[ 0 ][ 0 ], Dinv );
88
89     /****************************************************
90     * substitute D*(L^T) = T. ie:
91     L*D*(L^T)*x = b => L*T = b <=> T = inv(L)*b
92     ******************************************************/
93     silk_SolveWithLowerTriangularWdiagOnes_FLP( &L[ 0 ][ 0 ], M, b, T );
94
95     /****************************************************
96     D*(L^T)*x = T <=> (L^T)*x = inv(D)*T, because D is
97     diagonal just multiply with 1/d_i
98     ****************************************************/
99     for( i = 0; i < M; i++ ) {
100         T[ i ] = T[ i ] * Dinv[ i ];
101     }
102     /****************************************************
103     x = inv(L') * inv(D) * T
104     *****************************************************/
105     silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP( &L[ 0 ][ 0 ], M, T, x );
106 }
107
108 void silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP(
109     const SKP_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
110     opus_int             M,      /* (I) Dim of Matrix equation */
111     const SKP_float     *b,     /* (I) b Vector */
112     SKP_float           *x      /* (O) x Vector */
113 )
114 {
115     opus_int   i, j;
116     SKP_float temp;
117     const SKP_float *ptr1;
118
119     for( i = M - 1; i >= 0; i-- ) {
120         ptr1 =  matrix_adr( L, 0, i, M );
121         temp = 0;
122         for( j = M - 1; j > i ; j-- ) {
123             temp += ptr1[ j * M ] * x[ j ];
124         }
125         temp = b[ i ] - temp;
126         x[ i ] = temp;
127     }
128 }
129
130 void silk_SolveWithLowerTriangularWdiagOnes_FLP(
131     const SKP_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
132     opus_int             M,      /* (I) Dim of Matrix equation */
133     const SKP_float     *b,     /* (I) b Vector */
134     SKP_float           *x      /* (O) x Vector */
135 )
136 {
137     opus_int   i, j;
138     SKP_float temp;
139     const SKP_float *ptr1;
140
141     for( i = 0; i < M; i++ ) {
142         ptr1 =  matrix_adr( L, i, 0, M );
143         temp = 0;
144         for( j = 0; j < i; j++ ) {
145             temp += ptr1[ j ] * x[ j ];
146         }
147         temp = b[ i ] - temp;
148         x[ i ] = temp;
149     }
150 }
151
152 void silk_LDL_FLP(
153     SKP_float           *A,      /* (I/O) Pointer to Symetric Square Matrix */
154     opus_int             M,       /* (I) Size of Matrix */
155     SKP_float           *L,      /* (I/O) Pointer to Square Upper triangular Matrix */
156     SKP_float           *Dinv    /* (I/O) Pointer to vector holding the inverse diagonal elements of D */
157 )
158 {
159     opus_int i, j, k, loop_count, err = 1;
160     SKP_float *ptr1, *ptr2;
161     double temp, diag_min_value;
162     SKP_float v[ MAX_MATRIX_SIZE ], D[ MAX_MATRIX_SIZE ]; // temp arrays
163
164     SKP_assert( M <= MAX_MATRIX_SIZE );
165
166     diag_min_value = FIND_LTP_COND_FAC * 0.5f * ( A[ 0 ] + A[ M * M - 1 ] );
167     for( loop_count = 0; loop_count < M && err == 1; loop_count++ ) {
168         err = 0;
169         for( j = 0; j < M; j++ ) {
170             ptr1 = matrix_adr( L, j, 0, M );
171             temp = matrix_ptr( A, j, j, M ); // element in row j column j
172             for( i = 0; i < j; i++ ) {
173                 v[ i ] = ptr1[ i ] * D[ i ];
174                 temp  -= ptr1[ i ] * v[ i ];
175             }
176             if( temp < diag_min_value ) {
177                 /* Badly conditioned matrix: add white noise and run again */
178                 temp = ( loop_count + 1 ) * diag_min_value - temp;
179                 for( i = 0; i < M; i++ ) {
180                     matrix_ptr( A, i, i, M ) += ( SKP_float )temp;
181                 }
182                 err = 1;
183                 break;
184             }
185             D[ j ]    = ( SKP_float )temp;
186             Dinv[ j ] = ( SKP_float )( 1.0f / temp );
187             matrix_ptr( L, j, j, M ) = 1.0f;
188
189             ptr1 = matrix_adr( A, j, 0, M );
190             ptr2 = matrix_adr( L, j + 1, 0, M);
191             for( i = j + 1; i < M; i++ ) {
192                 temp = 0.0;
193                 for( k = 0; k < j; k++ ) {
194                     temp += ptr2[ k ] * v[ k ];
195                 }
196                 matrix_ptr( L, i, j, M ) = ( SKP_float )( ( ptr1[ i ] - temp ) * Dinv[ j ] );
197                 ptr2 += M; // go to next column
198             }
199         }
200     }
201     SKP_assert( err == 0 );
202 }
203