<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.5"/>
<title>Eigen-unsupported: SkylineInplaceLU< MatrixType > Class Template 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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="eigendoxy.css" rel="stylesheet" type="text/css">
<!-- -->
<script type="text/javascript" src="eigen_navtree_hacks.js"></script>
<!-- <script type="text/javascript"> -->
<!-- </script> -->
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- <a name="top"></a> -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen-unsupported</a>
 <span id="projectnumber">3.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</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">
$(document).ready(function(){initNavTree('classEigen_1_1SkylineInplaceLU.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></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="classEigen_1_1SkylineInplaceLU-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">SkylineInplaceLU< MatrixType > Class Template Reference<div class="ingroups"><a class="el" href="group__Skyline__Module.html">Skyline module</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename MatrixType><br/>
class Eigen::SkylineInplaceLU< MatrixType ></h3>
<p>Inplace LU decomposition of a skyline matrix and associated features. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">MatrixType</td><td>the type of the matrix of which we are computing the LU factorization </td></tr>
</table>
</dd>
</dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4993c97a669fa259c6574a18d547c117"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a4993c97a669fa259c6574a18d547c117">compute</a> ()</td></tr>
<tr class="separator:a4993c97a669fa259c6574a18d547c117"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f944e30665d7e6775691e5fc63e9dc7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a5f944e30665d7e6775691e5fc63e9dc7">flags</a> () const </td></tr>
<tr class="separator:a5f944e30665d7e6775691e5fc63e9dc7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe5bb554978d7584795e2ebd121115aa"><td class="memItemLeft" align="right" valign="top">RealScalar </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#abe5bb554978d7584795e2ebd121115aa">precision</a> () const </td></tr>
<tr class="separator:abe5bb554978d7584795e2ebd121115aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f29e5457641fae1b405b144a8206ca5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a9f29e5457641fae1b405b144a8206ca5">setFlags</a> (int f)</td></tr>
<tr class="separator:a9f29e5457641fae1b405b144a8206ca5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bc6e7b398a8db1c0d746fecbf367c1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a7bc6e7b398a8db1c0d746fecbf367c1d">setPrecision</a> (RealScalar v)</td></tr>
<tr class="separator:a7bc6e7b398a8db1c0d746fecbf367c1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a117b7ef0aaa2c7684fa235c0ab98e7cf"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a117b7ef0aaa2c7684fa235c0ab98e7cf">SkylineInplaceLU</a> (MatrixType &matrix, int <a class="el" href="classEigen_1_1SkylineInplaceLU.html#a5f944e30665d7e6775691e5fc63e9dc7">flags</a>=0)</td></tr>
<tr class="separator:a117b7ef0aaa2c7684fa235c0ab98e7cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a62ff65772ecf9f45bba123bdff524b31"><td class="memTemplParams" colspan="2">template<typename BDerived , typename XDerived > </td></tr>
<tr class="memitem:a62ff65772ecf9f45bba123bdff524b31"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a62ff65772ecf9f45bba123bdff524b31">solve</a> (const MatrixBase< BDerived > &b, MatrixBase< XDerived > *x, const int transposed=0) const </td></tr>
<tr class="separator:a62ff65772ecf9f45bba123bdff524b31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ff21cd2cb5ff6d358bb3eef3fbc4b3d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a9ff21cd2cb5ff6d358bb3eef3fbc4b3d">succeeded</a> (void) const </td></tr>
<tr class="separator:a9ff21cd2cb5ff6d358bb3eef3fbc4b3d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a117b7ef0aaa2c7684fa235c0ab98e7cf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classEigen_1_1SkylineInplaceLU.html">SkylineInplaceLU</a> </td>
<td>(</td>
<td class="paramtype">MatrixType & </td>
<td class="paramname"><em>matrix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a LU object and compute the respective factorization of <em>matrix</em> using flags <em>flags</em>. </p>
<p>References <a class="el" href="classEigen_1_1SkylineInplaceLU.html#a4993c97a669fa259c6574a18d547c117">SkylineInplaceLU< MatrixType >::compute()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4993c97a669fa259c6574a18d547c117"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void compute </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Computes/re-computes the LU factorization</p>
<p>Computes / recomputes the in place LU decomposition of the <a class="el" href="classEigen_1_1SkylineInplaceLU.html" title="Inplace LU decomposition of a skyline matrix and associated features. ">SkylineInplaceLU</a>. using the default algorithm. </p>
<p>Referenced by <a class="el" href="classEigen_1_1SkylineInplaceLU.html#a117b7ef0aaa2c7684fa235c0ab98e7cf">SkylineInplaceLU< MatrixType >::SkylineInplaceLU()</a>.</p>
</div>
</div>
<a class="anchor" id="a5f944e30665d7e6775691e5fc63e9dc7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int flags </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the current flags </dd></dl>
</div>
</div>
<a class="anchor" id="abe5bb554978d7584795e2ebd121115aa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">RealScalar precision </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the current precision.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a7bc6e7b398a8db1c0d746fecbf367c1d">setPrecision()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a9f29e5457641fae1b405b144a8206ca5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void setFlags </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the flags. Possible values are:</p>
<ul>
<li>CompleteFactorization</li>
<li>IncompleteFactorization</li>
<li>MemoryEfficient</li>
<li>one of the ordering methods</li>
<li>etc...</li>
</ul>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1SkylineInplaceLU.html#a5f944e30665d7e6775691e5fc63e9dc7">flags()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7bc6e7b398a8db1c0d746fecbf367c1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void setPrecision </td>
<td>(</td>
<td class="paramtype">RealScalar </td>
<td class="paramname"><em>v</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the relative threshold value used to prune zero coefficients during the decomposition.</p>
<p>Setting a value greater than zero speeds up computation, and yields to an imcomplete factorization with fewer non zero coefficients. Such approximate factors are especially useful to initialize an iterative solver.</p>
<p>Note that the exact meaning of this parameter might depends on the actual backend. Moreover, not all backends support this feature.</p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1SkylineInplaceLU.html#abe5bb554978d7584795e2ebd121115aa">precision()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a62ff65772ecf9f45bba123bdff524b31"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool solve </td>
<td>(</td>
<td class="paramtype">const MatrixBase< BDerived > & </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MatrixBase< XDerived > * </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const int </td>
<td class="paramname"><em>transposed</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the lower triangular matrix L </dd>
<dd>
the upper triangular matrix U</dd></dl>
<p>Computes *x = U^-1 L^-1 b</p>
<p>If <em>transpose</em> is set to SvTranspose or SvAdjoint, the solution of the transposed/adjoint system is computed instead.</p>
<p>Not all backends implement the solution of the transposed or adjoint system. </p>
</div>
</div>
<a class="anchor" id="a9ff21cd2cb5ff6d358bb3eef3fbc4b3d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool succeeded </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if the factorization succeeded </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SkylineInplaceLU_8h_source.html">SkylineInplaceLU.h</a></li>
</ul>
</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="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1SkylineInplaceLU.html">SkylineInplaceLU</a></li>
<li class="footer">Generated on Mon Oct 28 2013 11:05:27 for Eigen-unsupported by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
<!-- Piwik -->
<!--
<script type="text/javascript">
var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.sylphide-consulting.com/piwik/" : "http://stats.sylphide-consulting.com/piwik/");
document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
</script><script type="text/javascript">
try {
var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 20);
piwikTracker.trackPageView();
piwikTracker.enableLinkTracking();
} catch( err ) {}
</script><noscript><p><img src="http://stats.sylphide-consulting.com/piwik/piwik.php?idsite=20" style="border:0" alt="" /></p></noscript>
-->
<!-- End Piwik Tracking Code -->
</body>
</html>
