Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 6611

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Householder module</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> &gt; <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
          <div class="left">
            <form id="FSearchBox" action="search.php" method="get">
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
            </form>
          </div><div class="right"></div>
        </div>
      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Householder module</div>  </div>
<div class="ingroups"><a class="el" href="group__eigen__grp.html">The Eigen3 library</a></div></div>
<div class="contents">
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>This module provides Householder transformations. </p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include &lt;<a class="code" href="_householder.html">Eigen/Householder</a>&gt;</span>
</pre></div> <div class="dynheader">
Collaboration diagram for Householder module:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group___householder___module.png" border="0" alt="" usemap="#group______householder______module"/>
<map name="group______householder______module" id="group______householder______module">
<area shape="rect" id="node1" href="group__eigen__grp.html" title="The Eigen3 library" alt="" coords="6,5,133,32"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_householder_sequence.html">Eigen::HouseholderSequence</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="class_eigen_1_1_householder_sequence.html#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename VectorsType , typename CoeffsType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">HouseholderSequence<br class="typebreak"/>
&lt; VectorsType, CoeffsType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___householder___module.html#ga5f2b3f80cdf7ae96609e4a8d2e55e371">Eigen::householderSequence</a> (const VectorsType &amp;v, const CoeffsType &amp;h)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">\  <a href="#ga5f2b3f80cdf7ae96609e4a8d2e55e371"></a><br/></td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename VectorsType , typename CoeffsType &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">HouseholderSequence<br class="typebreak"/>
&lt; VectorsType, CoeffsType, <br class="typebreak"/>
OnTheRight &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___householder___module.html#ga897ebce658762148f706f73a05525e89">Eigen::rightHouseholderSequence</a> (const VectorsType &amp;v, const CoeffsType &amp;h)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">\  <a href="#ga897ebce658762148f706f73a05525e89"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga5f2b3f80cdf7ae96609e4a8d2e55e371"></a><!-- doxytag: member="Eigen::householderSequence" ref="ga5f2b3f80cdf7ae96609e4a8d2e55e371" args="(const VectorsType &amp;v, const CoeffsType &amp;h)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VectorsType , typename CoeffsType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">HouseholderSequence&lt;VectorsType,CoeffsType&gt; Eigen::householderSequence </td>
          <td>(</td>
          <td class="paramtype">const VectorsType &amp;&#160;</td>
          <td class="paramname"><em>v</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const CoeffsType &amp;&#160;</td>
          <td class="paramname"><em>h</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>\ </p>
<p>Convenience function for constructing a Householder sequence. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_eigen_1_1_householder_sequence.html">HouseholderSequence</a> constructed from the specified arguments. </dd></dl>

<p>Definition at line <a class="el" href="_householder_source.html#l00413">413</a> of file <a class="el" href="_householder_source.html">Householder</a>.</p>

</div>
</div>
<a class="anchor" id="ga897ebce658762148f706f73a05525e89"></a><!-- doxytag: member="Eigen::rightHouseholderSequence" ref="ga897ebce658762148f706f73a05525e89" args="(const VectorsType &amp;v, const CoeffsType &amp;h)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename VectorsType , typename CoeffsType &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">HouseholderSequence&lt;VectorsType,CoeffsType,OnTheRight&gt; Eigen::rightHouseholderSequence </td>
          <td>(</td>
          <td class="paramtype">const VectorsType &amp;&#160;</td>
          <td class="paramname"><em>v</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const CoeffsType &amp;&#160;</td>
          <td class="paramname"><em>h</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>\ </p>
<p>Convenience function for constructing a Householder sequence. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="class_eigen_1_1_householder_sequence.html">HouseholderSequence</a> constructed from the specified arguments.</dd></dl>
<p>This function differs from <a class="el" href="group___householder___module.html#ga5f2b3f80cdf7ae96609e4a8d2e55e371" title="\">householderSequence()</a> in that the template argument <code>OnTheSide</code> of the constructed <a class="el" href="class_eigen_1_1_householder_sequence.html">HouseholderSequence</a> is set to OnTheRight, instead of the default OnTheLeft. </p>

<p>Definition at line <a class="el" href="_householder_source.html#l00425">425</a> of file <a class="el" href="_householder_source.html">Householder</a>.</p>

</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150">  </td></tr> </table>  </body></html>