<!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: SPQR< 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</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_1SPQR.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_1SPQR-members.html">List of all members</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">SPQR< MatrixType > Class Template Reference<div class="ingroups"><a class="el" href="group__SPQRSupport__Module.html">SuiteSparseQR 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::SPQR< MatrixType ></h3> <p><a class="el" href="structEigen_1_1Sparse.html">Sparse</a> QR factorization based on SuiteSparseQR library. </p> <p>This class is used to perform a multithreaded and multifrontal rank-revealing QR decomposition of sparse matrices. The result is then used to solve linear leasts_square systems. Clearly, a QR factorization is returned such that A*P = Q*R where :</p> <p>P is the column permutation. Use <a class="el" href="classEigen_1_1SPQR.html#a60c6e65462cb1cab3a89d3afb37b35a0" title="Get the permutation that was applied to columns of A. ">colsPermutation()</a> to get it.</p> <p>Q is the orthogonal matrix represented as Householder reflectors. Use <a class="el" href="classEigen_1_1SPQR.html#a2cca4c4270406a8d173bcc4339ef9394" title="Get an expression of the matrix Q. ">matrixQ()</a> to get an expression and <a class="el" href="classEigen_1_1SPQR.html#a2cca4c4270406a8d173bcc4339ef9394" title="Get an expression of the matrix Q. ">matrixQ()</a>.transpose() to get the transpose. You can then apply it to a vector.</p> <p>R is the sparse triangular factor. Use matrixQR() to get it as <a class="el" href="classEigen_1_1SparseMatrix.html" title="A versatible sparse matrix representation. ">SparseMatrix</a>. NOTE : The Index type of R is always UF_long. You can get it with SPQR::Index</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, must be a column-major SparseMatrix<> NOTE </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:a6900999956a38bc60855289918a62d82"><td class="memItemLeft" align="right" valign="top">cholmod_common * </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a6900999956a38bc60855289918a62d82">cholmodCommon</a> () const </td></tr> <tr class="separator:a6900999956a38bc60855289918a62d82"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaca1908a5ec508a25ff0a8bca803e5f3"><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#aaca1908a5ec508a25ff0a8bca803e5f3">cols</a> () const </td></tr> <tr class="separator:aaca1908a5ec508a25ff0a8bca803e5f3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a60c6e65462cb1cab3a89d3afb37b35a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60c6e65462cb1cab3a89d3afb37b35a0"></a> <a class="el" href="classEigen_1_1PermutationMatrix.html">PermutationType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a60c6e65462cb1cab3a89d3afb37b35a0">colsPermutation</a> () const </td></tr> <tr class="memdesc:a60c6e65462cb1cab3a89d3afb37b35a0"><td class="mdescLeft"> </td><td class="mdescRight">Get the permutation that was applied to columns of A. <br/></td></tr> <tr class="separator:a60c6e65462cb1cab3a89d3afb37b35a0"><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"><a class="el" href="classEigen_1_1SPQR.html#a0c06d5c2034ebb329c54235369643ad2">info</a> () 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:a2cca4c4270406a8d173bcc4339ef9394"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cca4c4270406a8d173bcc4339ef9394"></a> SPQRMatrixQReturnType< <a class="el" href="classEigen_1_1SPQR.html">SPQR</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a2cca4c4270406a8d173bcc4339ef9394">matrixQ</a> () const </td></tr> <tr class="memdesc:a2cca4c4270406a8d173bcc4339ef9394"><td class="mdescLeft"> </td><td class="mdescRight">Get an expression of the matrix Q. <br/></td></tr> <tr class="separator:a2cca4c4270406a8d173bcc4339ef9394"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a9e36438e57c52afd02c489ab9833a440"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classEigen_1_1SparseMatrix.html">MatrixType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a9e36438e57c52afd02c489ab9833a440">matrixR</a> () const </td></tr> <tr class="separator:a9e36438e57c52afd02c489ab9833a440"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a363d1c09d77f09d6ea2d2789776e7be3"><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a363d1c09d77f09d6ea2d2789776e7be3">rank</a> () const </td></tr> <tr class="separator:a363d1c09d77f09d6ea2d2789776e7be3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5552abd83dbd03c85cea6d61fd8875a5"><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a5552abd83dbd03c85cea6d61fd8875a5">rows</a> () const </td></tr> <tr class="separator:a5552abd83dbd03c85cea6d61fd8875a5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5d0d1c42d19d3e538a123813f7b62c5b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5d0d1c42d19d3e538a123813f7b62c5b"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a5d0d1c42d19d3e538a123813f7b62c5b">setPivotThreshold</a> (const RealScalar &tol)</td></tr> <tr class="memdesc:a5d0d1c42d19d3e538a123813f7b62c5b"><td class="mdescLeft"> </td><td class="mdescRight">Set the tolerance tol to treat columns with 2-norm < =tol as zero. <br/></td></tr> <tr class="separator:a5d0d1c42d19d3e538a123813f7b62c5b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a2c8ca72c8bbd609c162950128ac969"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a2c8ca72c8bbd609c162950128ac969"></a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a2a2c8ca72c8bbd609c162950128ac969">setSPQROrdering</a> (int ord)</td></tr> <tr class="memdesc:a2a2c8ca72c8bbd609c162950128ac969"><td class="mdescLeft"> </td><td class="mdescRight">Set the fill-reducing ordering method to be used. <br/></td></tr> <tr class="separator:a2a2c8ca72c8bbd609c162950128ac969"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7fcaf5446687d32b11ec4fb9fc5587e2"><td class="memTemplParams" colspan="2">template<typename Rhs > </td></tr> <tr class="memitem:a7fcaf5446687d32b11ec4fb9fc5587e2"><td class="memTemplItemLeft" align="right" valign="top">const internal::solve_retval<br class="typebreak"/> < <a class="el" href="classEigen_1_1SPQR.html">SPQR</a>, Rhs > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1SPQR.html#a7fcaf5446687d32b11ec4fb9fc5587e2">solve</a> (const <a class="el" href="classEigen_1_1MatrixBase.html">MatrixBase</a>< Rhs > &B) const </td></tr> <tr class="separator:a7fcaf5446687d32b11ec4fb9fc5587e2"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a6900999956a38bc60855289918a62d82"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">cholmod_common* cholmodCommon </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>a pointer to the <a class="el" href="classEigen_1_1SPQR.html" title="Sparse QR factorization based on SuiteSparseQR library. ">SPQR</a> workspace </dd></dl> </div> </div> <a class="anchor" id="aaca1908a5ec508a25ff0a8bca803e5f3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Index cols </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"> <p>Get the number of columns of the input matrix. </p> </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> </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 sparse QR can not be computed </dd></dl> </div> </div> <a class="anchor" id="a9e36438e57c52afd02c489ab9833a440"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="classEigen_1_1SparseMatrix.html">MatrixType</a> matrixR </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 sparse triangular factor R. It is a sparse matrix </dd></dl> </div> </div> <a class="anchor" id="a363d1c09d77f09d6ea2d2789776e7be3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Index rank </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"> <p>Gets the rank of the matrix. It should be equal to matrixQR().cols if the matrix is full-rank </p> </div> </div> <a class="anchor" id="a5552abd83dbd03c85cea6d61fd8875a5"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Index rows </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"> <p>Get the number of rows of the input matrix and the Q matrix </p> <p>Referenced by <a class="el" href="classEigen_1_1SPQR.html#a7fcaf5446687d32b11ec4fb9fc5587e2">SPQR< MatrixType >::solve()</a>.</p> </div> </div> <a class="anchor" id="a7fcaf5446687d32b11ec4fb9fc5587e2"></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<<a class="el" href="classEigen_1_1SPQR.html">SPQR</a>, 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> </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_162.png"/> using the current decomposition of A.</dd></dl> <dl class="section see"><dt>See Also</dt><dd>compute() </dd></dl> <p>References <a class="el" href="classEigen_1_1SPQR.html#a5552abd83dbd03c85cea6d61fd8875a5">SPQR< MatrixType >::rows()</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="SuiteSparseQRSupport_8h_source.html">SuiteSparseQRSupport.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_1SPQR.html">SPQR</a></li> <li class="footer">Generated on Mon Oct 28 2013 11:04:31 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>