<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.16"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>RcdMathLib_doc: lu_decomp.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">RcdMathLib_doc </div> <div id="projectbrief">Open Source Library for Linear and Non-linear Algebra</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.16 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('lu__decomp_8h.html','');}); /* @license-end */ </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">lu_decomp.h File Reference<div class="ingroups"><a class="el" href="group__linear__algebra.html">LINEAR_ALGEBRA</a> » <a class="el" href="group__matrix__decompositions.html">MATRIX_DECOMPOSITIONS</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Computes the LU decomposition of the matrix. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="matrix_8h_source.html">matrix.h</a>"</code><br /> </div> <p><a href="lu__decomp_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:a8649e9f4b85f17bf35a22b18e7f239d7"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lu__decomp_8h.html#a8649e9f4b85f17bf35a22b18e7f239d7">lu_decomp</a> (uint8_t n, <a class="el" href="matrix_8h.html#af38ac6b76d645fea9abd6caeb4d9dd31">matrix_t</a> A[][n], <a class="el" href="matrix_8h.html#af38ac6b76d645fea9abd6caeb4d9dd31">matrix_t</a> L[][n], <a class="el" href="matrix_8h.html#af38ac6b76d645fea9abd6caeb4d9dd31">matrix_t</a> P[][n])</td></tr> <tr class="memdesc:a8649e9f4b85f17bf35a22b18e7f239d7"><td class="mdescLeft"> </td><td class="mdescRight">Computes the LU decomposition of the matrix. <a href="lu__decomp_8h.html#a8649e9f4b85f17bf35a22b18e7f239d7">More...</a><br /></td></tr> <tr class="separator:a8649e9f4b85f17bf35a22b18e7f239d7"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Computes the LU decomposition of the matrix. </p> <p>Computes the permutation matrix P such that: A = P'*L*U, where L is a lower triangular matrix and U is an upper triangular matrix. It implements the Gaussian Elimination (GE) with pivoting algorithm.</p> <dl class="section author"><dt>Author</dt><dd>Zakaria Kasmi <a href="#" onclick="location.href='mai'+'lto:'+'zka'+'sm'+'i@i'+'nf'+'.fu'+'-b'+'erl'+'in'+'.de'; return false;">zkasm<span style="display: none;">.nosp@m.</span>i@in<span style="display: none;">.nosp@m.</span>f.fu-<span style="display: none;">.nosp@m.</span>berl<span style="display: none;">.nosp@m.</span>in.de</a> </dd></dl> <p class="definition">Definition in file <a class="el" href="lu__decomp_8h_source.html">lu_decomp.h</a>.</p> </div><h2 class="groupheader">Function Documentation</h2> <a id="a8649e9f4b85f17bf35a22b18e7f239d7"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8649e9f4b85f17bf35a22b18e7f239d7">◆ </a></span>lu_decomp()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint8_t lu_decomp </td> <td>(</td> <td class="paramtype">uint8_t </td> <td class="paramname"><em>n</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="matrix_8h.html#af38ac6b76d645fea9abd6caeb4d9dd31">matrix_t</a> </td> <td class="paramname"><em>A</em>[][n], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="matrix_8h.html#af38ac6b76d645fea9abd6caeb4d9dd31">matrix_t</a> </td> <td class="paramname"><em>L</em>[][n], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="matrix_8h.html#af38ac6b76d645fea9abd6caeb4d9dd31">matrix_t</a> </td> <td class="paramname"><em>P</em>[][n] </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Computes the LU decomposition of the matrix. </p> <p>Computes the permutation matrix P such that: A = P'*L*U, where L is a lower triangular matrix and U is an upper triangular matrix. It implements the Gaussian Elimination with pivoting algorithm.</p> <dl class="section note"><dt>Note</dt><dd>Matrix U is stored in the matrix A.</dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in]</td><td class="paramname">n</td><td>column number of the matrix. </td></tr> <tr><td class="paramdir">[in,out]</td><td class="paramname">A[][]</td><td>pointer to the matrices A and U. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">L[][]</td><td>pointer to the L matrix. </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">P[][]</td><td>pointer to the P matrix.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the number of changes by computing the LU decomposition. </dd></dl> <p class="definition">Definition at line <a class="el" href="lu__decomp_8c_source.html#l00031">31</a> of file <a class="el" href="lu__decomp_8c_source.html">lu_decomp.c</a>.</p> <p class="reference">References <a class="el" href="matrix_8c_source.html#l00703">matrix_get_abs_max_elem_and_index_in_part_column()</a>, <a class="el" href="matrix_8c_source.html#l00594">matrix_get_diag_mat()</a>, <a class="el" href="matrix_8c_source.html#l00736">matrix_part_swap_rows()</a>, <a class="el" href="matrix_8c_source.html#l00725">matrix_swap_rows()</a>, and <a class="el" href="matrix_8h_source.html#l00038">matrix_t</a>.</p> <p class="reference">Referenced by <a class="el" href="lu__decomp__test_8c_source.html#l00029">lu_decomp_test()</a>, and <a class="el" href="solve_8c_source.html#l00124">solve_lu_decomp()</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_8c4128baa09a573ad2b8b8c0061a04c9.html">linear_algebra</a></li><li class="navelem"><a class="el" href="dir_997ac76a3d72a25dec85442c5f6c585d.html">matrix_decompositions</a></li><li class="navelem"><a class="el" href="dir_f9311e7dae5ba7dbc6ad9f75e6d9537e.html">include</a></li><li class="navelem"><a class="el" href="lu__decomp_8h.html">lu_decomp.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.16 </li> </ul> </div> </body> </html>