<!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: CholmodBase< _MatrixType, _UpLo, Derived > 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_1CholmodBase.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_1CholmodBase-members.html">List of all members</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">CholmodBase< _MatrixType, _UpLo, Derived > Class Template Reference<div class="ingroups"><a class="el" href="group__CholmodSupport__Module.html">CholmodSupport 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, int _UpLo, typename Derived><br/> class Eigen::CholmodBase< _MatrixType, _UpLo, Derived ></h3> <p>The base class for the direct Cholesky factorization of Cholmod. </p> <dl class="section see"><dt>See Also</dt><dd>class <a class="el" href="classEigen_1_1CholmodSupernodalLLT.html" title="A supernodal Cholesky (LLT) factorization and solver based on Cholmod. ">CholmodSupernodalLLT</a>, class <a class="el" href="classEigen_1_1CholmodSimplicialLDLT.html" title="A simplicial direct Cholesky (LDLT) factorization and solver based on Cholmod. ">CholmodSimplicialLDLT</a>, class <a class="el" href="classEigen_1_1CholmodSimplicialLLT.html" title="A simplicial direct Cholesky (LLT) factorization and solver based on Cholmod. ">CholmodSimplicialLLT</a> </dd></dl> </div> <p>Inherits noncopyable.</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_1CholmodBase.html#a6f2a135bd741b6b2f2558e6a404581ff">analyzePattern</a> (const MatrixType &matrix)</td></tr> <tr class="separator:a6f2a135bd741b6b2f2558e6a404581ff"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2a4ffc9577cb0e860a22a145593b745f"><td class="memItemLeft" align="right" valign="top">cholmod_common & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1CholmodBase.html#a2a4ffc9577cb0e860a22a145593b745f">cholmod</a> ()</td></tr> <tr class="separator:a2a4ffc9577cb0e860a22a145593b745f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acdc1509616c36e6dfbf4eeaac4f6f473"><td class="memItemLeft" align="right" valign="top">Derived & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1CholmodBase.html#acdc1509616c36e6dfbf4eeaac4f6f473">compute</a> (const MatrixType &matrix)</td></tr> <tr class="separator:acdc1509616c36e6dfbf4eeaac4f6f473"><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_1CholmodBase.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"><a class="el" href="classEigen_1_1CholmodBase.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:ab2efe8546d442e79f9c3f574adab5d5e"><td class="memItemLeft" align="right" valign="top">Derived & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1CholmodBase.html#ab2efe8546d442e79f9c3f574adab5d5e">setShift</a> (const RealScalar &offset)</td></tr> <tr class="separator:ab2efe8546d442e79f9c3f574adab5d5e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4cc20d34149422380d332ddd1d371652"><td class="memTemplParams" colspan="2">template<typename Rhs > </td></tr> <tr class="memitem:a4cc20d34149422380d332ddd1d371652"><td class="memTemplItemLeft" align="right" valign="top">const internal::solve_retval<br class="typebreak"/> < <a class="el" href="classEigen_1_1CholmodBase.html">CholmodBase</a>, Rhs > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1CholmodBase.html#a4cc20d34149422380d332ddd1d371652">solve</a> (const <a class="el" href="classEigen_1_1MatrixBase.html">MatrixBase</a>< Rhs > &b) const </td></tr> <tr class="separator:a4cc20d34149422380d332ddd1d371652"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a81db76105fedf365cdbc200774911847"><td class="memTemplParams" colspan="2">template<typename Rhs > </td></tr> <tr class="memitem:a81db76105fedf365cdbc200774911847"><td class="memTemplItemLeft" align="right" valign="top">const <br class="typebreak"/> internal::sparse_solve_retval<br class="typebreak"/> < <a class="el" href="classEigen_1_1CholmodBase.html">CholmodBase</a>, Rhs > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classEigen_1_1CholmodBase.html#a81db76105fedf365cdbc200774911847">solve</a> (const <a class="el" href="classEigen_1_1SparseMatrixBase.html">SparseMatrixBase</a>< Rhs > &b) const </td></tr> <tr class="separator:a81db76105fedf365cdbc200774911847"><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>Performs a symbolic decomposition on the sparcity of <em>matrix</em>.</p> <p>This function is particularly useful when solving for several problems having the same structure.</p> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1CholmodBase.html#a33e2421e468033a883c041f940537a7c">factorize()</a> </dd></dl> <p>Referenced by <a class="el" href="classEigen_1_1CholmodBase.html#acdc1509616c36e6dfbf4eeaac4f6f473">CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute()</a>.</p> </div> </div> <a class="anchor" id="a2a4ffc9577cb0e860a22a145593b745f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">cholmod_common& cholmod </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> </td> </tr> </table> </div><div class="memdoc"> <p>Returns a reference to the Cholmod's configuration structure to get a full control over the performed operations. See the Cholmod user guide for details. </p> </div> </div> <a class="anchor" id="acdc1509616c36e6dfbf4eeaac4f6f473"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Derived& 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>Computes the sparse Cholesky decomposition of <em>matrix</em> </p> </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>Performs a numeric decomposition of <em>matrix</em> </p> <p>The given matrix must has the same sparcity than the matrix on which the symbolic decomposition has been performed.</p> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1CholmodBase.html#a6f2a135bd741b6b2f2558e6a404581ff">analyzePattern()</a> </dd></dl> <p>Referenced by <a class="el" href="classEigen_1_1CholmodBase.html#acdc1509616c36e6dfbf4eeaac4f6f473">CholmodBase< _MatrixType, _UpLo, CholmodSimplicialLLT< _MatrixType, _UpLo > >::compute()</a>.</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 matrix.appears to be negative. </dd></dl> </div> </div> <a class="anchor" id="ab2efe8546d442e79f9c3f574adab5d5e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Derived& setShift </td> <td>(</td> <td class="paramtype">const RealScalar & </td> <td class="paramname"><em>offset</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 shift parameter that will be used to adjust the diagonal coefficients during the numerical factorization.</p> <p>During the numerical factorization, an offset term is added to the diagonal coefficients:<br/> <code>d_ii</code> = <em>offset</em> + <code>d_ii</code> </p> <p>The default is <em>offset=0</em>.</p> <dl class="section return"><dt>Returns</dt><dd>a reference to <code>*this</code>. </dd></dl> </div> </div> <a class="anchor" id="a4cc20d34149422380d332ddd1d371652"></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_1CholmodBase.html">CholmodBase</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_3.png"/> using the current decomposition of A.</dd></dl> <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1CholmodBase.html#acdc1509616c36e6dfbf4eeaac4f6f473">compute()</a> </dd></dl> </div> </div> <a class="anchor" id="a81db76105fedf365cdbc200774911847"></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<<a class="el" href="classEigen_1_1CholmodBase.html">CholmodBase</a>, 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> </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><a class="el" href="classEigen_1_1CholmodBase.html#acdc1509616c36e6dfbf4eeaac4f6f473">compute()</a> </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="CholmodSupport_8h_source.html">CholmodSupport.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_1CholmodBase.html">CholmodBase</a></li> <li class="footer">Generated on Mon Oct 28 2013 11:04:28 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>