<!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>Jacobi 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> > <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 Page</span></a></li> <li><a href="pages.html"><span>Related 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> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Jacobi 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 Jacobi and Givens rotations. </p> <div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <<a class="code" href="_jacobi.html">Eigen/Jacobi</a>></span> </pre></div><p>In addition to listed classes, it defines the two following <a class="el" href="class_eigen_1_1_matrix_base.html" title="Base class for all dense matrices, vectors, and expressions.">MatrixBase</a> methods to apply a Jacobi or Givens rotation:</p> <ul> <li><a class="el" href="class_eigen_1_1_matrix_base.html#a9885400152e84d4ec66c75db81ea1efd" title="replaces *this by *this * other.">MatrixBase::applyOnTheLeft()</a></li> <li><a class="el" href="class_eigen_1_1_matrix_base.html#ac55d95621af611ba203816897935d108" title="replaces *this by *this * other.">MatrixBase::applyOnTheRight()</a>. </li> </ul> <div class="dynheader"> Collaboration diagram for Jacobi module:</div> <div class="dyncontent"> <center><table><tr><td><img src="group___jacobi___module.png" border="0" alt="" usemap="#group______jacobi______module"/> <map name="group______jacobi______module" id="group______jacobi______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  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_jacobi_rotation.html">Eigen::JacobiRotation</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="class_eigen_1_1_jacobi_rotation.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<typename OtherScalar > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group___jacobi___module.html#gab1eac0f41045a97ca5b9f3b50d1216c9">Eigen::MatrixBase::applyOnTheRight</a> (Index p, Index q, const JacobiRotation< OtherScalar > &j)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Applies the rotation in the plane <em>j</em> to the columns <em>p</em> and <em>q</em> of <code>*this</code>, i.e., it computes B = B * J with <img class="formulaInl" alt="$ B = \left ( \begin{array}{cc} \text{*this.col}(p) & \text{*this.col}(q) \end{array} \right ) $" src="form_262.png"/>. <a href="#gab1eac0f41045a97ca5b9f3b50d1216c9"></a><br/></td></tr> </table> <hr/><h2>Function Documentation</h2> <a class="anchor" id="gab1eac0f41045a97ca5b9f3b50d1216c9"></a><!-- doxytag: member="Eigen::MatrixBase::applyOnTheRight" ref="gab1eac0f41045a97ca5b9f3b50d1216c9" args="(Index p, Index q, const JacobiRotation< OtherScalar > &j)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename OtherScalar > </div> <table class="memname"> <tr> <td class="memname">void Eigen::MatrixBase::applyOnTheRight </td> <td>(</td> <td class="paramtype"><a class="el" href="class_eigen_1_1_dense_base.html#a0b34caae3eba4bdda82764279e0ed4a5">Index</a> </td> <td class="paramname"><em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="class_eigen_1_1_dense_base.html#a0b34caae3eba4bdda82764279e0ed4a5">Index</a> </td> <td class="paramname"><em>q</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="class_eigen_1_1_jacobi_rotation.html">JacobiRotation</a>< OtherScalar > & </td> <td class="paramname"><em>j</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Applies the rotation in the plane <em>j</em> to the columns <em>p</em> and <em>q</em> of <code>*this</code>, i.e., it computes B = B * J with <img class="formulaInl" alt="$ B = \left ( \begin{array}{cc} \text{*this.col}(p) & \text{*this.col}(q) \end{array} \right ) $" src="form_262.png"/>. </p> <dl class="see"><dt><b>See also:</b></dt><dd>class <a class="el" href="class_eigen_1_1_jacobi_rotation.html">JacobiRotation</a>, <a class="el" href="class_eigen_1_1_matrix_base.html#a9885400152e84d4ec66c75db81ea1efd" title="replaces *this by *this * other.">MatrixBase::applyOnTheLeft()</a>, <a class="el" href="namespace_eigen_1_1internal.html#a6dee95d83b1ec9a6870422bba0dfea71">internal::apply_rotation_in_the_plane()</a> </dd></dl> <p>Definition at line <a class="el" href="_jacobi_source.html#l00298">298</a> of file <a class="el" href="_jacobi_source.html">Jacobi</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>