<!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: PastixLU< _MatrixType, IsStrSym > 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</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_1PastixLU.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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><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_1PastixLU-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">PastixLU< _MatrixType, IsStrSym > Class Template Reference<div class="ingroups"><a class="el" href="group__PaStiXSupport__Module.html">PaStiXSupport 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, bool IsStrSym = false><br/>
class Eigen::PastixLU< _MatrixType, IsStrSym ></h3>
<p>Interface to the PaStix solver. </p>
<p><a class="el" href="structEigen_1_1Sparse.html">Sparse</a> direct LU solver based on PaStiX library.</p>
<p>This class is used to solve the linear systems A.X = B via the PaStix library. The matrix can be either real or complex, symmetric or not.</p>
<dl class="section see"><dt>See Also</dt><dd>TutorialSparseDirectSolvers</dd></dl>
<p>This class is used to solve the linear systems A.X = B with a supernodal LU factorization in the PaStiX library. The matrix A should be squared and nonsingular PaStiX requires that the matrix A has a symmetric structural pattern. This interface can symmetrize the input matrix otherwise. The vectors or matrices X and B can be either dense or sparse.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">_MatrixType</td><td>the type of the sparse matrix A, it must be a SparseMatrix<> </td></tr>
<tr><td class="paramname">IsStrSym</td><td>Indicates if the input matrix has a symmetric pattern, default is false NOTE : Note that if the analysis and factorization phase are called separately, the input matrix will be symmetrized at each call, hence it is advised to symmetrize the matrix in a end-user program and set <code>IsStrSym</code> to true</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__TopicSparseSystems.html#TutorialSparseDirectSolvers">Sparse solvers</a> </dd></dl>
</div>
<p>Inherits PastixBase< Derived >.</p>
<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:a6f2a135bd741b6b2f2558e6a404581ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1PastixLU.html#a6f2a135bd741b6b2f2558e6a404581ff">analyzePattern</a> (const MatrixType &matrix)</td></tr>
<tr class="separator:a6f2a135bd741b6b2f2558e6a404581ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05a0eac1c146e9e62df9ec70f5a6f69d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1PastixLU.html#a05a0eac1c146e9e62df9ec70f5a6f69d">compute</a> (const MatrixType &matrix)</td></tr>
<tr class="separator:a05a0eac1c146e9e62df9ec70f5a6f69d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39e7187739766b84398ef4ab69ebd3b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classEigen_1_1Array.html">Array</a>< RealScalar, IPARM_SIZE, 1 > & </td><td class="memItemRight" valign="bottom"><b>dparm</b> ()</td></tr>
<tr class="separator:a39e7187739766b84398ef4ab69ebd3b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a630a06e066f058db093e7dca06ce45af"><td class="memItemLeft" align="right" valign="top">double & </td><td class="memItemRight" valign="bottom"><b>dparm</b> (int idxparam)</td></tr>
<tr class="separator:a630a06e066f058db093e7dca06ce45af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33e2421e468033a883c041f940537a7c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1PastixLU.html#a33e2421e468033a883c041f940537a7c">factorize</a> (const MatrixType &matrix)</td></tr>
<tr class="separator:a33e2421e468033a883c041f940537a7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c06d5c2034ebb329c54235369643ad2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__enums.html#ga51bc1ac16f26ebe51eae1abb77bd037b">ComputationInfo</a> </td><td class="memItemRight" valign="bottom"><b>info</b> () const </td></tr>
<tr class="memdesc:a0c06d5c2034ebb329c54235369643ad2"><td class="mdescLeft"> </td><td class="mdescRight">Reports whether previous computation was successful. <a href="#a0c06d5c2034ebb329c54235369643ad2">More...</a><br/></td></tr>
<tr class="separator:a0c06d5c2034ebb329c54235369643ad2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33dbeb031de0bc9542eda27e189d5b90"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classEigen_1_1Array.html">Array</a>< Index, IPARM_SIZE, 1 > & </td><td class="memItemRight" valign="bottom"><b>iparm</b> ()</td></tr>
<tr class="separator:a33dbeb031de0bc9542eda27e189d5b90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97a90db0b2fa4f10c945f800f23e076a"><td class="memItemLeft" align="right" valign="top">int & </td><td class="memItemRight" valign="bottom"><b>iparm</b> (int idxparam)</td></tr>
<tr class="separator:a97a90db0b2fa4f10c945f800f23e076a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23c397917859a65ea35f10b1f70a1f16"><td class="memTemplParams" colspan="2">template<typename Rhs > </td></tr>
<tr class="memitem:a23c397917859a65ea35f10b1f70a1f16"><td class="memTemplItemLeft" align="right" valign="top">const internal::solve_retval<br class="typebreak"/>
< PastixBase, Rhs > </td><td class="memTemplItemRight" valign="bottom"><b>solve</b> (const <a class="el" href="classEigen_1_1MatrixBase.html">MatrixBase</a>< Rhs > &b) const </td></tr>
<tr class="separator:a23c397917859a65ea35f10b1f70a1f16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba716659ad1cad5bea6c2b45bb3abb6f"><td class="memTemplParams" colspan="2">template<typename Rhs > </td></tr>
<tr class="memitem:aba716659ad1cad5bea6c2b45bb3abb6f"><td class="memTemplItemLeft" align="right" valign="top">const <br class="typebreak"/>
internal::sparse_solve_retval<br class="typebreak"/>
< PastixBase, Rhs > </td><td class="memTemplItemRight" valign="bottom"><b>solve</b> (const <a class="el" href="classEigen_1_1SparseMatrixBase.html">SparseMatrixBase</a>< Rhs > &b) const </td></tr>
<tr class="separator:aba716659ad1cad5bea6c2b45bb3abb6f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a6f2a135bd741b6b2f2558e6a404581ff"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void analyzePattern </td>
<td>(</td>
<td class="paramtype">const MatrixType & </td>
<td class="paramname"><em>matrix</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>Compute the LU symbolic factorization of <code>matrix</code> using its sparsity pattern. Several ordering methods can be used at this step. See the PaStiX user's manual. The result of this operation can be used with successive matrices having the same pattern as <code>matrix</code> </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1PastixLU.html#a33e2421e468033a883c041f940537a7c">factorize()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a05a0eac1c146e9e62df9ec70f5a6f69d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void compute </td>
<td>(</td>
<td class="paramtype">const MatrixType & </td>
<td class="paramname"><em>matrix</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>Compute the LU supernodal factorization of <code>matrix</code>. iparm and dparm can be used to tune the PaStiX parameters. see the PaStiX user's manual </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1PastixLU.html#a6f2a135bd741b6b2f2558e6a404581ff">analyzePattern()</a> <a class="el" href="classEigen_1_1PastixLU.html#a33e2421e468033a883c041f940537a7c">factorize()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a39e7187739766b84398ef4ab69ebd3b3"></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_1Array.html">Array</a><RealScalar,IPARM_SIZE,1>& dparm </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the double vector DPARM of PaStiX parameters The statistics related to the different phases of factorization and solve are saved here as well </p>
<dl class="section see"><dt>See Also</dt><dd>analyzePattern() factorize() </dd></dl>
</div>
</div>
<a class="anchor" id="a630a06e066f058db093e7dca06ce45af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double& dparm </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>idxparam</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a reference to a particular index parameter of the DPARM vector </p>
<dl class="section see"><dt>See Also</dt><dd>dparm() </dd></dl>
</div>
</div>
<a class="anchor" id="a33e2421e468033a883c041f940537a7c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void factorize </td>
<td>(</td>
<td class="paramtype">const MatrixType & </td>
<td class="paramname"><em>matrix</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>Compute the LU supernodal factorization of <code>matrix</code> WARNING The matrix <code>matrix</code> should have the same structural pattern as the same used in the analysis phase. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1PastixLU.html#a6f2a135bd741b6b2f2558e6a404581ff">analyzePattern()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a0c06d5c2034ebb329c54235369643ad2"></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="group__enums.html#ga51bc1ac16f26ebe51eae1abb77bd037b">ComputationInfo</a> info </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 class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reports whether previous computation was successful. </p>
<dl class="section return"><dt>Returns</dt><dd><code>Success</code> if computation was succesful, <code>NumericalIssue</code> if the PaStiX reports a problem <code>InvalidInput</code> if the input matrix is invalid</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>iparm() </dd></dl>
</div>
</div>
<a class="anchor" id="a33dbeb031de0bc9542eda27e189d5b90"></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_1Array.html">Array</a><Index,IPARM_SIZE,1>& iparm </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a reference to the integer vector IPARM of PaStiX parameters to modify the default parameters. The statistics related to the different phases of factorization and solve are saved here as well </p>
<dl class="section see"><dt>See Also</dt><dd>analyzePattern() factorize() </dd></dl>
</div>
</div>
<a class="anchor" id="a97a90db0b2fa4f10c945f800f23e076a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int& iparm </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>idxparam</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a reference to a particular index parameter of the IPARM vector </p>
<dl class="section see"><dt>See Also</dt><dd>iparm() </dd></dl>
</div>
</div>
<a class="anchor" id="a23c397917859a65ea35f10b1f70a1f16"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const internal::solve_retval<PastixBase, Rhs> solve </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classEigen_1_1MatrixBase.html">MatrixBase</a>< Rhs > & </td>
<td class="paramname"><em>b</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the solution x of <img class="formulaInl" alt="$ A x = b $" src="form_3.png"/> using the current decomposition of A.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>compute() </dd></dl>
</div>
</div>
<a class="anchor" id="aba716659ad1cad5bea6c2b45bb3abb6f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const internal::sparse_solve_retval<PastixBase, Rhs> solve </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classEigen_1_1SparseMatrixBase.html">SparseMatrixBase</a>< Rhs > & </td>
<td class="paramname"><em>b</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the solution x of <img class="formulaInl" alt="$ A x = b $" src="form_3.png"/> using the current decomposition of A.</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>compute() </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="PaStiXSupport_8h_source.html">PaStiXSupport.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_1PastixLU.html">PastixLU</a></li>
<li class="footer">Generated on Mon Oct 28 2013 11:04:30 for Eigen 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>
