<!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: Householder module</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('group__Householder__Module.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="#nested-classes">Classes</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Householder module<div class="ingroups"><a class="el" href="group__DenseMatrixManipulation__Reference.html">Reference</a></div></div> </div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>This module provides Householder transformations.</p> <div class="fragment"><div class="line">* #include <Eigen/Householder></div> <div class="line">* </div> </div><!-- fragment --> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1HouseholderSequence.html">HouseholderSequence< VectorsType, CoeffsType, Side ></a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Sequence of Householder reflections acting on subspaces with decreasing size. <a href="classEigen_1_1HouseholderSequence.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga5f2b3f80cdf7ae96609e4a8d2e55e371"><td class="memTemplParams" colspan="2">template<typename VectorsType , typename CoeffsType > </td></tr> <tr class="memitem:ga5f2b3f80cdf7ae96609e4a8d2e55e371"><td class="memTemplItemLeft" align="right" valign="top">HouseholderSequence<br class="typebreak"/> < VectorsType, CoeffsType > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Householder__Module.html#ga5f2b3f80cdf7ae96609e4a8d2e55e371">householderSequence</a> (const VectorsType &v, const CoeffsType &h)</td></tr> <tr class="memdesc:ga5f2b3f80cdf7ae96609e4a8d2e55e371"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function for constructing a Householder sequence. <a href="#ga5f2b3f80cdf7ae96609e4a8d2e55e371">More...</a><br/></td></tr> <tr class="separator:ga5f2b3f80cdf7ae96609e4a8d2e55e371"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga897ebce658762148f706f73a05525e89"><td class="memTemplParams" colspan="2">template<typename VectorsType , typename CoeffsType > </td></tr> <tr class="memitem:ga897ebce658762148f706f73a05525e89"><td class="memTemplItemLeft" align="right" valign="top">HouseholderSequence<br class="typebreak"/> < VectorsType, CoeffsType, <br class="typebreak"/> OnTheRight > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__Householder__Module.html#ga897ebce658762148f706f73a05525e89">rightHouseholderSequence</a> (const VectorsType &v, const CoeffsType &h)</td></tr> <tr class="memdesc:ga897ebce658762148f706f73a05525e89"><td class="mdescLeft"> </td><td class="mdescRight">Convenience function for constructing a Householder sequence. <a href="#ga897ebce658762148f706f73a05525e89">More...</a><br/></td></tr> <tr class="separator:ga897ebce658762148f706f73a05525e89"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga5f2b3f80cdf7ae96609e4a8d2e55e371"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">HouseholderSequence<VectorsType,CoeffsType> Eigen::householderSequence </td> <td>(</td> <td class="paramtype">const VectorsType & </td> <td class="paramname"><em>v</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const CoeffsType & </td> <td class="paramname"><em>h</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convenience function for constructing a Householder sequence. </p> <pre class="fragment"> % . \ # </> \ </pre> <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classEigen_1_1HouseholderSequence.html" title="Sequence of Householder reflections acting on subspaces with decreasing size. ">HouseholderSequence</a> constructed from the specified arguments. </dd></dl> </div> </div> <a class="anchor" id="ga897ebce658762148f706f73a05525e89"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">HouseholderSequence<VectorsType,CoeffsType,OnTheRight> Eigen::rightHouseholderSequence </td> <td>(</td> <td class="paramtype">const VectorsType & </td> <td class="paramname"><em>v</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const CoeffsType & </td> <td class="paramname"><em>h</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convenience function for constructing a Householder sequence. </p> <pre class="fragment"> % . \ # </> \ </pre> <dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classEigen_1_1HouseholderSequence.html" title="Sequence of Householder reflections acting on subspaces with decreasing size. ">HouseholderSequence</a> constructed from the specified arguments.</dd></dl> <p>This function differs from <a class="el" href="group__Householder__Module.html#ga5f2b3f80cdf7ae96609e4a8d2e55e371" title="Convenience function for constructing a Householder sequence. ">householderSequence()</a> in that the template argument <code>OnTheSide</code> of the constructed <a class="el" href="classEigen_1_1HouseholderSequence.html" title="Sequence of Householder reflections acting on subspaces with decreasing size. ">HouseholderSequence</a> is set to OnTheRight, instead of the default OnTheLeft. </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="footer">Generated on Mon Oct 28 2013 11:04:27 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>