Sophie

Sophie

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

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>Eigen::CommaInitializer 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> &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 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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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="struct_eigen_1_1_comma_initializer.html">CommaInitializer</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">Eigen::CommaInitializer 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::CommaInitializer" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Helper class used by the comma initializer operator. </p>
<p>This class is internally used to implement the comma initializer feature. It is the return type of <a class="el" href="class_eigen_1_1_dense_base.html#a5737842dc619e1f9340f1b1c40498b6d">MatrixBase::operator&lt;&lt;</a>, and most of the time this is the only way it is used.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_eigen_1_1_dense_base.html#MatrixBaseCommaInitRef">MatrixBase::operator&lt;&lt;</a>, <a class="el" href="struct_eigen_1_1_comma_initializer.html#a9c0d55bb903c6ef3e30fe6a2246b1115">CommaInitializer::finished()</a> </dd></dl>
</div>
<p><a href="class_eigen_1_1_comma_initializer-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef XprType::Scalar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a908968a63c06ea7d0bada74ac4e4f8c0">Scalar</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef XprType::Index&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#ad4835e4f837b926eb9bb88c316d7ee16">CommaInitializer</a> (XprType &amp;xpr, const <a class="el" href="struct_eigen_1_1_comma_initializer.html#a908968a63c06ea7d0bada74ac4e4f8c0">Scalar</a> &amp;s)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename OtherDerived &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a066dfecac8fb7807e2f1b731a84204b8">CommaInitializer</a> (XprType &amp;xpr, const <a class="el" href="class_eigen_1_1_dense_base.html">DenseBase</a>&lt; OtherDerived &gt; &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_eigen_1_1_comma_initializer.html">CommaInitializer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#aa8d82ada157ca47fdea1730cadf5241f">operator,</a> (const <a class="el" href="struct_eigen_1_1_comma_initializer.html#a908968a63c06ea7d0bada74ac4e4f8c0">Scalar</a> &amp;s)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;typename OtherDerived &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="struct_eigen_1_1_comma_initializer.html">CommaInitializer</a> &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a3b77a209c7a4f777f01825cf25505d4f">operator,</a> (const <a class="el" href="class_eigen_1_1_dense_base.html">DenseBase</a>&lt; OtherDerived &gt; &amp;other)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a7d2377c7352768a53b76f1f55ca0f34b">~CommaInitializer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">XprType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a9c0d55bb903c6ef3e30fe6a2246b1115">finished</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">XprType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#ab3175dbef13a29de1e13cf51b370640c">m_xpr</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a60ae75bb5a761ecb06f2329ddb4301b8">m_row</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#ab075fb53200169c14e846c8524c07cc5">m_col</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a938405970f868b1fcf63035258c69bf6">m_currentBlockRows</a></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a1ba746f481a3682494c8e7ce10010e24"></a><!-- doxytag: member="Eigen::CommaInitializer::Index" ref="a1ba746f481a3682494c8e7ce10010e24" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef XprType::Index <a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Eigen::CommaInitializer::Index</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00045">45</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="a908968a63c06ea7d0bada74ac4e4f8c0"></a><!-- doxytag: member="Eigen::CommaInitializer::Scalar" ref="a908968a63c06ea7d0bada74ac4e4f8c0" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef XprType::Scalar <a class="el" href="struct_eigen_1_1_comma_initializer.html#a908968a63c06ea7d0bada74ac4e4f8c0">Eigen::CommaInitializer::Scalar</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00044">44</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ad4835e4f837b926eb9bb88c316d7ee16"></a><!-- doxytag: member="Eigen::CommaInitializer::CommaInitializer" ref="ad4835e4f837b926eb9bb88c316d7ee16" args="(XprType &amp;xpr, const Scalar &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Eigen::CommaInitializer::CommaInitializer </td>
          <td>(</td>
          <td class="paramtype">XprType &amp;&#160;</td>
          <td class="paramname"><em>xpr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_eigen_1_1_comma_initializer.html#a908968a63c06ea7d0bada74ac4e4f8c0">Scalar</a> &amp;&#160;</td>
          <td class="paramname"><em>s</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00047">47</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="a066dfecac8fb7807e2f1b731a84204b8"></a><!-- doxytag: member="Eigen::CommaInitializer::CommaInitializer" ref="a066dfecac8fb7807e2f1b731a84204b8" args="(XprType &amp;xpr, const DenseBase&lt; OtherDerived &gt; &amp;other)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename OtherDerived &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">Eigen::CommaInitializer::CommaInitializer </td>
          <td>(</td>
          <td class="paramtype">XprType &amp;&#160;</td>
          <td class="paramname"><em>xpr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_eigen_1_1_dense_base.html">DenseBase</a>&lt; OtherDerived &gt; &amp;&#160;</td>
          <td class="paramname"><em>other</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00054">54</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="a7d2377c7352768a53b76f1f55ca0f34b"></a><!-- doxytag: member="Eigen::CommaInitializer::~CommaInitializer" ref="a7d2377c7352768a53b76f1f55ca0f34b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Eigen::CommaInitializer::~CommaInitializer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00103">103</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="a9c0d55bb903c6ef3e30fe6a2246b1115"></a><!-- doxytag: member="Eigen::CommaInitializer::finished" ref="a9c0d55bb903c6ef3e30fe6a2246b1115" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XprType&amp; Eigen::CommaInitializer::finished </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the built matrix once all its coefficients have been set. Calling finished is 100% optional. Its purpose is to write expressions like this: <div class="fragment"><pre class="fragment"> quaternion.fromRotationMatrix((Matrix3f() &lt;&lt; axis0, axis1, axis2).<a class="code" href="struct_eigen_1_1_comma_initializer.html#a9c0d55bb903c6ef3e30fe6a2246b1115">finished</a>());
</pre></div> </dd></dl>

<p>Definition at line <a class="el" href="_core_source.html#l00117">117</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="aa8d82ada157ca47fdea1730cadf5241f"></a><!-- doxytag: member="Eigen::CommaInitializer::operator," ref="aa8d82ada157ca47fdea1730cadf5241f" args="(const Scalar &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_eigen_1_1_comma_initializer.html">CommaInitializer</a>&amp; Eigen::CommaInitializer::operator, </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_eigen_1_1_comma_initializer.html#a908968a63c06ea7d0bada74ac4e4f8c0">Scalar</a> &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00061">61</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="a3b77a209c7a4f777f01825cf25505d4f"></a><!-- doxytag: member="Eigen::CommaInitializer::operator," ref="a3b77a209c7a4f777f01825cf25505d4f" args="(const DenseBase&lt; OtherDerived &gt; &amp;other)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename OtherDerived &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_eigen_1_1_comma_initializer.html">CommaInitializer</a>&amp; Eigen::CommaInitializer::operator, </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_eigen_1_1_dense_base.html">DenseBase</a>&lt; OtherDerived &gt; &amp;&#160;</td>
          <td class="paramname"><em>other</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00080">80</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="ab075fb53200169c14e846c8524c07cc5"></a><!-- doxytag: member="Eigen::CommaInitializer::m_col" ref="ab075fb53200169c14e846c8524c07cc5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a> <a class="el" href="struct_eigen_1_1_comma_initializer.html#ab075fb53200169c14e846c8524c07cc5">Eigen::CommaInitializer::m_col</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00121">121</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="a938405970f868b1fcf63035258c69bf6"></a><!-- doxytag: member="Eigen::CommaInitializer::m_currentBlockRows" ref="a938405970f868b1fcf63035258c69bf6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a> <a class="el" href="struct_eigen_1_1_comma_initializer.html#a938405970f868b1fcf63035258c69bf6">Eigen::CommaInitializer::m_currentBlockRows</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00122">122</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="a60ae75bb5a761ecb06f2329ddb4301b8"></a><!-- doxytag: member="Eigen::CommaInitializer::m_row" ref="a60ae75bb5a761ecb06f2329ddb4301b8" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_eigen_1_1_comma_initializer.html#a1ba746f481a3682494c8e7ce10010e24">Index</a> <a class="el" href="struct_eigen_1_1_comma_initializer.html#a60ae75bb5a761ecb06f2329ddb4301b8">Eigen::CommaInitializer::m_row</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00120">120</a> of file <a class="el" href="_core_source.html">Core</a>.</p>

</div>
</div>
<a class="anchor" id="ab3175dbef13a29de1e13cf51b370640c"></a><!-- doxytag: member="Eigen::CommaInitializer::m_xpr" ref="ab3175dbef13a29de1e13cf51b370640c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">XprType&amp; <a class="el" href="struct_eigen_1_1_comma_initializer.html#ab3175dbef13a29de1e13cf51b370640c">Eigen::CommaInitializer::m_xpr</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_core_source.html#l00119">119</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>