Update doxygen for release 2.3.1
[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.13"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>OpenJPEG: INVERT - Implementation of a matrix inversion</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
13 </head>
14 <body>
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <div id="titlearea">
17 <table cellspacing="0" cellpadding="0">
18  <tbody>
19  <tr style="height: 56px;">
20   <td id="projectalign" style="padding-left: 0.5em;">
21    <div id="projectname">OpenJPEG
22    &#160;<span id="projectnumber">2.3.1</span>
23    </div>
24   </td>
25  </tr>
26  </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.13 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 $(function() {
35   initMenu('',false,false,'search.php','Search');
36 });
37 </script>
38 <div id="main-nav"></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 id="ga7a19282d629041177b0c0fdf8a039b08"></a>
55 <h2 class="memtitle"><span class="permalink"><a href="#ga7a19282d629041177b0c0fdf8a039b08">&#9670;&nbsp;</a></span>opj_matrix_inversion_f()</h2>
56
57 <div class="memitem">
58 <div class="memproto">
59       <table class="memname">
60         <tr>
61           <td class="memname"><a class="el" href="openjpeg_8h.html#abb5dad6294f4611f1925388e919b16f4">OPJ_BOOL</a> opj_matrix_inversion_f </td>
62           <td>(</td>
63           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a62c71ae712322de0bef73cebae23fa04">OPJ_FLOAT32</a> *&#160;</td>
64           <td class="paramname"><em>pSrcMatrix</em>, </td>
65         </tr>
66         <tr>
67           <td class="paramkey"></td>
68           <td></td>
69           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a62c71ae712322de0bef73cebae23fa04">OPJ_FLOAT32</a> *&#160;</td>
70           <td class="paramname"><em>pDestMatrix</em>, </td>
71         </tr>
72         <tr>
73           <td class="paramkey"></td>
74           <td></td>
75           <td class="paramtype"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td>
76           <td class="paramname"><em>nb_compo</em>&#160;</td>
77         </tr>
78         <tr>
79           <td></td>
80           <td>)</td>
81           <td></td><td></td>
82         </tr>
83       </table>
84 </div><div class="memdoc">
85
86 <p>Calculates a n x n double matrix inversion with a LUP method. </p>
87 <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>
88 <dl class="params"><dt>Parameters</dt><dd>
89   <table class="params">
90     <tr><td class="paramname">pSrcMatrix</td><td>the matrix to invert. </td></tr>
91     <tr><td class="paramname">pDestMatrix</td><td>data to store the inverted matrix. </td></tr>
92     <tr><td class="paramname">nb_compo</td><td>size of the matrix </td></tr>
93   </table>
94   </dd>
95 </dl>
96 <dl class="section return"><dt>Returns</dt><dd>OPJ_TRUE if the inversion is successful, OPJ_FALSE if the matrix is singular.</dd></dl>
97 <p>Calculates a n x n double matrix inversion with a LUP method. </p>
98
99 <p class="reference">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>
100
101 <p class="reference">Referenced by <a class="el" href="group___j2_k.html#ga4a6561d0899d91b38099da38814cbe86">opj_j2k_setup_encoder()</a>.</p>
102
103 </div>
104 </div>
105 </div><!-- contents -->
106 <!-- start footer part -->
107 <hr class="footer"/><address class="footer"><small>
108 Generated by &#160;<a href="http://www.doxygen.org/index.html">
109 <img class="footer" src="doxygen.png" alt="doxygen"/>
110 </a> 1.8.13
111 </small></address>
112 </body>
113 </html>