License update using the IETF Trust flavour of the BSD on the Silk code
[opus.git] / silk / float / solve_LS_FLP.c
index c04cb59..a4bb052 100644 (file)
@@ -1,28 +1,28 @@
 /***********************************************************************
 Copyright (c) 2006-2011, Skype Limited. All rights reserved.
 Redistribution and use in source and binary forms, with or without
-modification, (subject to the limitations in the disclaimer below)
-are permitted provided that the following conditions are met:
+modification, are permitted provided that the following conditions
+are met:
 - Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.
 - Redistributions in binary form must reproduce the above copyright
 notice, this list of conditions and the following disclaimer in the
 documentation and/or other materials provided with the distribution.
-- Neither the name of Skype Limited, nor the names of specific
-contributors, may be used to endorse or promote products derived from
-this software without specific prior written permission.
-NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED
-BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
-CONTRIBUTORS ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
-BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
-COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
-ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+- Neither the name of Internet Society, IETF or IETF Trust, nor the 
+names of specific contributors, may be used to endorse or promote
+products derived from this software without specific prior written
+permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
 ***********************************************************************/
 
 #ifdef HAVE_CONFIG_H
@@ -38,10 +38,10 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  * the symmetric matric A is given by A = L*D*L'.
  **********************************************************************/
 static inline void silk_LDL_FLP(
-    silk_float           *A,      /* (I/O) Pointer to Symetric Square Matrix */
-    opus_int             M,       /* (I) Size of Matrix */
-    silk_float           *L,      /* (I/O) Pointer to Square Upper triangular Matrix */
-    silk_float           *Dinv    /* (I/O) Pointer to vector holding the inverse diagonal elements of D */
+    silk_float          *A,         /* I/O  Pointer to Symetric Square Matrix                               */
+    opus_int            M,          /* I    Size of Matrix                                                  */
+    silk_float          *L,         /* I/O  Pointer to Square Upper triangular Matrix                       */
+    silk_float          *Dinv       /* I/O  Pointer to vector holding the inverse diagonal elements of D    */
 );
 
 /**********************************************************************
@@ -49,10 +49,10 @@ static inline void silk_LDL_FLP(
  * triangular matrix, with ones on the diagonal.
  **********************************************************************/
 static inline void silk_SolveWithLowerTriangularWdiagOnes_FLP(
-    const silk_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
-    opus_int             M,      /* (I) Dim of Matrix equation */
-    const silk_float     *b,     /* (I) b Vector */
-    silk_float           *x      /* (O) x Vector */
+    const silk_float    *L,         /* I    Pointer to Lower Triangular Matrix                              */
+    opus_int            M,          /* I    Dim of Matrix equation                                          */
+    const silk_float    *b,         /* I    b Vector                                                        */
+    silk_float          *x          /* O    x Vector                                                        */
 );
 
 /**********************************************************************
@@ -60,10 +60,10 @@ static inline void silk_SolveWithLowerTriangularWdiagOnes_FLP(
  * triangular, with ones on the diagonal. (ie then A^T is upper triangular)
  **********************************************************************/
 static inline void silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP(
-    const silk_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
-    opus_int             M,      /* (I) Dim of Matrix equation */
-    const silk_float     *b,     /* (I) b Vector */
-    silk_float           *x      /* (O) x Vector */
+    const silk_float    *L,         /* I    Pointer to Lower Triangular Matrix                              */
+    opus_int            M,          /* I    Dim of Matrix equation                                          */
+    const silk_float    *b,         /* I    b Vector                                                        */
+    silk_float          *x          /* O    x Vector                                                        */
 );
 
 /**********************************************************************
@@ -71,10 +71,10 @@ static inline void silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP(
  * symmetric square matrix - using LDL factorisation
  **********************************************************************/
 void silk_solve_LDL_FLP(
-          silk_float                 *A,                 /* I/O  Symmetric square matrix, out: reg.      */
-    const opus_int                   M,                  /* I    Size of matrix                          */
-    const silk_float                 *b,                 /* I    Pointer to b vector                     */
-          silk_float                 *x                  /* O    Pointer to x solution vector            */
+    silk_float                      *A,                                 /* I/O  Symmetric square matrix, out: reg.          */
+    const opus_int                  M,                                  /* I    Size of matrix                              */
+    const silk_float                *b,                                 /* I    Pointer to b vector                         */
+    silk_float                      *x                                  /* O    Pointer to x solution vector                */
 )
 {
     opus_int   i;
@@ -110,10 +110,10 @@ void silk_solve_LDL_FLP(
 }
 
 static inline void silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP(
-    const silk_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
-    opus_int             M,      /* (I) Dim of Matrix equation */
-    const silk_float     *b,     /* (I) b Vector */
-    silk_float           *x      /* (O) x Vector */
+    const silk_float    *L,         /* I    Pointer to Lower Triangular Matrix                              */
+    opus_int            M,          /* I    Dim of Matrix equation                                          */
+    const silk_float    *b,         /* I    b Vector                                                        */
+    silk_float          *x          /* O    x Vector                                                        */
 )
 {
     opus_int   i, j;
@@ -132,10 +132,10 @@ static inline void silk_SolveWithUpperTriangularFromLowerWdiagOnes_FLP(
 }
 
 static inline void silk_SolveWithLowerTriangularWdiagOnes_FLP(
-    const silk_float     *L,     /* (I) Pointer to Lower Triangular Matrix */
-    opus_int             M,      /* (I) Dim of Matrix equation */
-    const silk_float     *b,     /* (I) b Vector */
-    silk_float           *x      /* (O) x Vector */
+    const silk_float    *L,         /* I    Pointer to Lower Triangular Matrix                              */
+    opus_int            M,          /* I    Dim of Matrix equation                                          */
+    const silk_float    *b,         /* I    b Vector                                                        */
+    silk_float          *x          /* O    x Vector                                                        */
 )
 {
     opus_int   i, j;
@@ -154,10 +154,10 @@ static inline void silk_SolveWithLowerTriangularWdiagOnes_FLP(
 }
 
 static inline void silk_LDL_FLP(
-    silk_float           *A,      /* (I/O) Pointer to Symetric Square Matrix */
-    opus_int             M,       /* (I) Size of Matrix */
-    silk_float           *L,      /* (I/O) Pointer to Square Upper triangular Matrix */
-    silk_float           *Dinv    /* (I/O) Pointer to vector holding the inverse diagonal elements of D */
+    silk_float          *A,         /* I/O  Pointer to Symetric Square Matrix                               */
+    opus_int            M,          /* I    Size of Matrix                                                  */
+    silk_float          *L,         /* I/O  Pointer to Square Upper triangular Matrix                       */
+    silk_float          *Dinv       /* I/O  Pointer to vector holding the inverse diagonal elements of D    */
 )
 {
     opus_int i, j, k, loop_count, err = 1;