src/lib/openjp2/invert.h

   1 /*
   2  * Copyright (c) 2008, Jerome Fimes, Communications & Systemes <jerome.fimes@c-s.fr>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS `AS IS'
  15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24  * POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef __INVERT_H
  28 #define __INVERT_H
  29 /**
  30 @file invert.h
  31 @brief Implementation of the matrix inversion
  32
  33 The function in INVERT.H compute a matrix inversion with a LUP method
  34 */
  35
  36 /** @defgroup INVERT INVERT - Implementation of a matrix inversion */
  37 /*@{*/
  38 /** @name Exported functions */
  39 /*@{*/
  40 /* ----------------------------------------------------------------------- */
  41
  42 /**
  43  * Calculates a n x n double matrix inversion with a LUP method. Data is aligned, rows after rows (or columns after columns).
  44  * The function does not take ownership of any memory block, data must be fred by the user.
  45  *
  46  * @param pSrcMatrix    the matrix to invert.
  47  * @param pDestMatrix   data to store the inverted matrix.
  48  * @param n size of the matrix
  49  * @return OPJ_TRUE if the inversion is successful, OPJ_FALSE if the matrix is singular.
  50  */
  51 OPJ_BOOL opj_matrix_inversion_f(OPJ_FLOAT32 * pSrcMatrix,
  52                                 OPJ_FLOAT32 * pDestMatrix,
  53                                 OPJ_UINT32 nb_compo);
  54 /* ----------------------------------------------------------------------- */
  55 /*@}*/
  56
  57 /*@}*/
  58
  59 #endif /* __INVERT_H */