<!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>Eigen::DiagonalWrapper Class Reference</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 class="current"><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 id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_eigen.html">Eigen</a> </li> <li class="navelem"><a class="el" href="class_eigen_1_1_diagonal_wrapper.html">DiagonalWrapper</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">Eigen::DiagonalWrapper Class Reference<div class="ingroups"><a class="el" href="group___core___module.html">Core module</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="Eigen::DiagonalWrapper" --><!-- doxytag: inherits="Eigen::internal::no_assignment_operator" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Expression of a diagonal matrix. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">_DiagonalVectorType</td><td>the type of the vector of diagonal coefficients</td></tr> </table> </dd> </dl> <p>This class is an expression of a diagonal matrix, but not storing its own vector of diagonal coefficients, instead wrapping an existing vector expression. It is the return type of <a class="el" href="class_eigen_1_1_matrix_base.html#a62c8567f1e2a28162fb2b63e8ccbca33">MatrixBase::asDiagonal()</a> and most of the time this is the only way that it is used.</p> <dl class="see"><dt><b>See also:</b></dt><dd>class <a class="el" href="class_eigen_1_1_diagonal_matrix.html" title="Represents a diagonal matrix with its storage.">DiagonalMatrix</a>, class DiagonalBase, <a class="el" href="class_eigen_1_1_matrix_base.html#a62c8567f1e2a28162fb2b63e8ccbca33">MatrixBase::asDiagonal()</a> </dd></dl> </div><div class="dynheader"> Inheritance diagram for Eigen::DiagonalWrapper:</div> <div class="dyncontent"> <div class="center"><img src="class_eigen_1_1_diagonal_wrapper__inherit__graph.png" border="0" usemap="#_eigen_1_1_diagonal_wrapper_inherit__map" alt="Inheritance graph"/></div> <map name="_eigen_1_1_diagonal_wrapper_inherit__map" id="_eigen_1_1_diagonal_wrapper_inherit__map"> <area shape="rect" id="node2" href="class_eigen_1_1internal_1_1no__assignment__operator.html" title="Eigen::internal::no_assignment_operator" alt="" coords="5,5,259,32"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="class_eigen_1_1_diagonal_wrapper-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_diagonal_wrapper.html#a4cff6e0e6b49610b7fd4bf1345f67edd">DiagonalWrapper</a> (const DiagonalVectorType &diagonal)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor from expression of diagonal coefficients to wrap. <a href="#a4cff6e0e6b49610b7fd4bf1345f67edd"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const DiagonalVectorType & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_diagonal_wrapper.html#ab34d371c45abbaa9b6666cd8afe5a3f1">diagonal</a> () const </td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const DiagonalVectorType::Nested </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_diagonal_wrapper.html#ae1cf72d7fd2d9afc4630bd0b83ec0c56">m_diagonal</a></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a4cff6e0e6b49610b7fd4bf1345f67edd"></a><!-- doxytag: member="Eigen::DiagonalWrapper::DiagonalWrapper" ref="a4cff6e0e6b49610b7fd4bf1345f67edd" args="(const DiagonalVectorType &diagonal)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Eigen::DiagonalWrapper::DiagonalWrapper </td> <td>(</td> <td class="paramtype">const DiagonalVectorType & </td> <td class="paramname"><em>diagonal</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Constructor from expression of diagonal coefficients to wrap. </p> <p>Definition at line <a class="el" href="_core_source.html#l00255">255</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab34d371c45abbaa9b6666cd8afe5a3f1"></a><!-- doxytag: member="Eigen::DiagonalWrapper::diagonal" ref="ab34d371c45abbaa9b6666cd8afe5a3f1" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const DiagonalVectorType& Eigen::DiagonalWrapper::diagonal </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>a const reference to the wrapped expression of diagonal coefficients. </dd></dl> <p>Definition at line <a class="el" href="_core_source.html#l00258">258</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="ae1cf72d7fd2d9afc4630bd0b83ec0c56"></a><!-- doxytag: member="Eigen::DiagonalWrapper::m_diagonal" ref="ae1cf72d7fd2d9afc4630bd0b83ec0c56" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const DiagonalVectorType::Nested <a class="el" href="class_eigen_1_1_diagonal_wrapper.html#ae1cf72d7fd2d9afc4630bd0b83ec0c56">Eigen::DiagonalWrapper::m_diagonal</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00261">261</a> of file <a class="el" href="_core_source.html">Core</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>