Update Doxygen doc
[openjpeg.git] / doxygen / group___i_n_v_e_r_t.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.10"/>
7 <title>OpenJPEG: INVERT - Implementation of a matrix inversion</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
12 </head>
13 <body>
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
15 <div id="titlearea">
16 <table cellspacing="0" cellpadding="0">
17  <tbody>
18  <tr style="height: 56px;">
19   <td id="projectalign" style="padding-left: 0.5em;">
20    <div id="projectname">OpenJPEG
21    &#160;<span id="projectnumber">2.2.0</span>
22    </div>
23   </td>
24  </tr>
25  </tbody>
26 </table>
27 </div>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.10 -->
30   <div id="navrow1" class="tabs">
31     <ul class="tablist">
32       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
33       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
34       <li><a href="modules.html"><span>Modules</span></a></li>
35       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
36       <li><a href="files.html"><span>Files</span></a></li>
37     </ul>
38   </div>
39 </div><!-- top -->
40 <div class="header">
41   <div class="headertitle">
42 <div class="title">INVERT - Implementation of a matrix inversion</div>  </div>
43 </div><!--header-->
44 <div class="contents">
45 <table class="memberdecls">
46 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
47 Exported functions</h2></td></tr>
48 <tr class="memitem:ga7a19282d629041177b0c0fdf8a039b08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___i_n_v_e_r_t.html#ga7a19282d629041177b0c0fdf8a039b08">opj_matrix_inversion_f</a> (<a class="el" href="openjpeg_8h.html#a62c71ae712322de0bef73cebae23fa04">OPJ_FLOAT32</a> *pSrcMatrix, <a class="el" href="openjpeg_8h.html#a62c71ae712322de0bef73cebae23fa04">OPJ_FLOAT32</a> *pDestMatrix, <a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> nb_compo)</td></tr>
49 <tr class="memdesc:ga7a19282d629041177b0c0fdf8a039b08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculates a n x n double matrix inversion with a LUP method.  <a href="#ga7a19282d629041177b0c0fdf8a039b08">More...</a><br /></td></tr>
50 <tr class="separator:ga7a19282d629041177b0c0fdf8a039b08"><td class="memSeparator" colspan="2">&#160;</td></tr>
51 </table>
52 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
53 <h2 class="groupheader">Function Documentation</h2>
54 <a class="anchor" id="ga7a19282d629041177b0c0fdf8a039b08"></a>
55 <div class="memitem">
56 <div class="memproto">
57       <table class="memname">
58         <tr>
59           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_matrix_inversion_f </td>
60           <td>(</td>
61           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a62c71ae712322de0bef73cebae23fa04">OPJ_FLOAT32</a> *&#160;</td>
62           <td class="paramname"><em>pSrcMatrix</em>, </td>
63         </tr>
64         <tr>
65           <td class="paramkey"></td>
66           <td></td>
67           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a62c71ae712322de0bef73cebae23fa04">OPJ_FLOAT32</a> *&#160;</td>
68           <td class="paramname"><em>pDestMatrix</em>, </td>
69         </tr>
70         <tr>
71           <td class="paramkey"></td>
72           <td></td>
73           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
74           <td class="paramname"><em>nb_compo</em>&#160;</td>
75         </tr>
76         <tr>
77           <td></td>
78           <td>)</td>
79           <td></td><td></td>
80         </tr>
81       </table>
82 </div><div class="memdoc">
83
84 <p>Calculates a n x n double matrix inversion with a LUP method. </p>
85 <p>Data is aligned, rows after rows (or columns after columns). The function does not take ownership of any memory block, data must be fred by the user.</p>
86 <dl class="params"><dt>Parameters</dt><dd>
87   <table class="params">
88     <tr><td class="paramname">pSrcMatrix</td><td>the matrix to invert. </td></tr>
89     <tr><td class="paramname">pDestMatrix</td><td>data to store the inverted matrix. </td></tr>
90     <tr><td class="paramname">nb_compo</td><td>size of the matrix </td></tr>
91   </table>
92   </dd>
93 </dl>
94 <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE if the inversion is successful, OPJ_FALSE if the matrix is singular.</dd></dl>
95 <p>Calculates a n x n double matrix inversion with a LUP method. </p>
96
97 <p>References <a class="el" href="openjpeg_8h.html#ac672bfd7db39c609e828acb07a321964">OPJ_FALSE</a>, <a class="el" href="group___m_i_s_c.html#ga2bd00e2482ae36197631bde0665cfdfe">opj_free()</a>, <a class="el" href="invert_8c.html#a40666080ced941508395998c700a4b70">opj_lupDecompose()</a>, <a class="el" href="invert_8c.html#a88339411e582e3c36af4b808df8561e4">opj_lupInvert()</a>, <a class="el" href="group___m_i_s_c.html#ga49c70931cbed786f6eef5f095bcb2917">opj_malloc()</a>, and <a class="el" href="openjpeg_8h.html#a04830036d767cba56cbf5ae5bdc481d3">OPJ_TRUE</a>.</p>
98
99 <p>Referenced by <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>.</p>
100
101 </div>
102 </div>
103 </div><!-- contents -->
104 <!-- start footer part -->
105 <hr class="footer"/><address class="footer"><small>
106 Generated by &#160;<a href="http://www.doxygen.org/index.html">
107 <img class="footer" src="doxygen.png" alt="doxygen"/>
108 </a> 1.8.10
109 </small></address>
110 </body>
111 </html>