<!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::CwiseNullaryOp 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_cwise_nullary_op.html">CwiseNullaryOp</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">Eigen::CwiseNullaryOp 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::CwiseNullaryOp" --><!-- doxytag: inherits="Eigen::internal::no_assignment_operator" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Generic expression of a matrix where all coefficients are defined by a functor. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">NullaryOp</td><td>template functor implementing the operator </td></tr> <tr><td class="paramname">PlainObjectType</td><td>the underlying plain matrix/array type</td></tr> </table> </dd> </dl> <p>This class represents an expression of a generic nullary operator. It is the return type of the Ones(), Zero(), Constant(), Identity() and Random() methods, and most of the time this is the only way it is used.</p> <p>However, if you want to write a function returning such an expression, you will need to use this class.</p> <dl class="see"><dt><b>See also:</b></dt><dd>class <a class="el" href="class_eigen_1_1_cwise_unary_op.html" title="Generic expression where a coefficient-wise unary operator is applied to an expression.">CwiseUnaryOp</a>, class <a class="el" href="class_eigen_1_1_cwise_binary_op.html" title="Generic expression where a coefficient-wise binary operator is applied to two expressions.">CwiseBinaryOp</a>, <a class="el" href="class_eigen_1_1_dense_base.html#ad2733654f1222a9c312f5e9463e5c557">DenseBase::NullaryExpr()</a> </dd></dl> </div><div class="dynheader"> Inheritance diagram for Eigen::CwiseNullaryOp:</div> <div class="dyncontent"> <div class="center"><img src="class_eigen_1_1_cwise_nullary_op__inherit__graph.png" border="0" usemap="#_eigen_1_1_cwise_nullary_op_inherit__map" alt="Inheritance graph"/></div> <map name="_eigen_1_1_cwise_nullary_op_inherit__map" id="_eigen_1_1_cwise_nullary_op_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_cwise_nullary_op-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 <br class="typebreak"/> <a class="el" href="struct_eigen_1_1internal_1_1dense__xpr__base.html">internal::dense_xpr_base</a><br class="typebreak"/> < <a class="el" href="class_eigen_1_1_cwise_nullary_op.html">CwiseNullaryOp</a> >::type </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a8df6329fa542133178d4e9cc1ea23d39">Base</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a4e8975c7d0e28a64a1a48283fac52ca9">CwiseNullaryOp</a> (Index rows, Index cols, const NullaryOp &func=NullaryOp())</td></tr> <tr><td class="memItemLeft" align="right" valign="top">EIGEN_STRONG_INLINE Index </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#afcd2ff66894bbb91279df3ba448aba74">rows</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">EIGEN_STRONG_INLINE Index </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a20934e8a4fa238b54134104b10080be6">cols</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">EIGEN_STRONG_INLINE const Scalar </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a2e396df4a69d334fb2849346872376f5">coeff</a> (Index rows, Index cols) const </td></tr> <tr><td class="memTemplParams" colspan="2">template<int LoadMode> </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">EIGEN_STRONG_INLINE PacketScalar </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a38529c09e66cbeaad3cebbc44311c96f">packet</a> (Index row, Index col) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">EIGEN_STRONG_INLINE const Scalar </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a0c2d11133ea76acd6952a7fb3506c39e">coeff</a> (Index index) const </td></tr> <tr><td class="memTemplParams" colspan="2">template<int LoadMode> </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">EIGEN_STRONG_INLINE PacketScalar </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a813e51550bb95ef451a76916c70ca7af">packet</a> (Index index) const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">const NullaryOp & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#af34fb94d3a9131683cf3f6a22e13b065">functor</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 <br class="typebreak"/> <a class="el" href="class_eigen_1_1internal_1_1variable__if__dynamic.html">internal::variable_if_dynamic</a><br class="typebreak"/> < Index, RowsAtCompileTime > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a4d54550d07253a4a4db5028c92e6b266">m_rows</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const <br class="typebreak"/> <a class="el" href="class_eigen_1_1internal_1_1variable__if__dynamic.html">internal::variable_if_dynamic</a><br class="typebreak"/> < Index, ColsAtCompileTime > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a12dafcc04ff79735042a2c0e2084d087">m_cols</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const NullaryOp </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a650d567e693c21c1af65951f4f426c09">m_functor</a></td></tr> </table> <hr/><h2>Member Typedef Documentation</h2> <a class="anchor" id="a8df6329fa542133178d4e9cc1ea23d39"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::Base" ref="a8df6329fa542133178d4e9cc1ea23d39" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="struct_eigen_1_1internal_1_1dense__xpr__base.html">internal::dense_xpr_base</a><<a class="el" href="class_eigen_1_1_cwise_nullary_op.html">CwiseNullaryOp</a>>::type <a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a8df6329fa542133178d4e9cc1ea23d39">Eigen::CwiseNullaryOp::Base</a></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00068">68</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a4e8975c7d0e28a64a1a48283fac52ca9"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::CwiseNullaryOp" ref="a4e8975c7d0e28a64a1a48283fac52ca9" args="(Index rows, Index cols, const NullaryOp &func=NullaryOp())" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Eigen::CwiseNullaryOp::CwiseNullaryOp </td> <td>(</td> <td class="paramtype">Index </td> <td class="paramname"><em>rows</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>cols</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const NullaryOp & </td> <td class="paramname"><em>func</em> = <code>NullaryOp()</code> </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#l00071">71</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="a2e396df4a69d334fb2849346872376f5"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::coeff" ref="a2e396df4a69d334fb2849346872376f5" args="(Index rows, Index cols) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EIGEN_STRONG_INLINE const Scalar Eigen::CwiseNullaryOp::coeff </td> <td>(</td> <td class="paramtype">Index </td> <td class="paramname"><em>rows</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>cols</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00083">83</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="a0c2d11133ea76acd6952a7fb3506c39e"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::coeff" ref="a0c2d11133ea76acd6952a7fb3506c39e" args="(Index index) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EIGEN_STRONG_INLINE const Scalar Eigen::CwiseNullaryOp::coeff </td> <td>(</td> <td class="paramtype">Index </td> <td class="paramname"><em>index</em></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00094">94</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="a20934e8a4fa238b54134104b10080be6"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::cols" ref="a20934e8a4fa238b54134104b10080be6" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EIGEN_STRONG_INLINE Index Eigen::CwiseNullaryOp::cols </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00081">81</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="af34fb94d3a9131683cf3f6a22e13b065"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::functor" ref="af34fb94d3a9131683cf3f6a22e13b065" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const NullaryOp& Eigen::CwiseNullaryOp::functor </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>the functor representing the nullary operation </dd></dl> <p>Definition at line <a class="el" href="_core_source.html#l00106">106</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="a38529c09e66cbeaad3cebbc44311c96f"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::packet" ref="a38529c09e66cbeaad3cebbc44311c96f" args="(Index row, Index col) const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<int LoadMode> </div> <table class="memname"> <tr> <td class="memname">EIGEN_STRONG_INLINE PacketScalar Eigen::CwiseNullaryOp::packet </td> <td>(</td> <td class="paramtype">Index </td> <td class="paramname"><em>row</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>col</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00089">89</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="a813e51550bb95ef451a76916c70ca7af"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::packet" ref="a813e51550bb95ef451a76916c70ca7af" args="(Index index) const " --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<int LoadMode> </div> <table class="memname"> <tr> <td class="memname">EIGEN_STRONG_INLINE PacketScalar Eigen::CwiseNullaryOp::packet </td> <td>(</td> <td class="paramtype">Index </td> <td class="paramname"><em>index</em></td><td>)</td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00100">100</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="afcd2ff66894bbb91279df3ba448aba74"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::rows" ref="afcd2ff66894bbb91279df3ba448aba74" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">EIGEN_STRONG_INLINE Index Eigen::CwiseNullaryOp::rows </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const<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="a12dafcc04ff79735042a2c0e2084d087"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::m_cols" ref="a12dafcc04ff79735042a2c0e2084d087" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="class_eigen_1_1internal_1_1variable__if__dynamic.html">internal::variable_if_dynamic</a><Index, ColsAtCompileTime> <a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a12dafcc04ff79735042a2c0e2084d087">Eigen::CwiseNullaryOp::m_cols</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00110">110</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="a650d567e693c21c1af65951f4f426c09"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::m_functor" ref="a650d567e693c21c1af65951f4f426c09" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const NullaryOp <a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a650d567e693c21c1af65951f4f426c09">Eigen::CwiseNullaryOp::m_functor</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00111">111</a> of file <a class="el" href="_core_source.html">Core</a>.</p> </div> </div> <a class="anchor" id="a4d54550d07253a4a4db5028c92e6b266"></a><!-- doxytag: member="Eigen::CwiseNullaryOp::m_rows" ref="a4d54550d07253a4a4db5028c92e6b266" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const <a class="el" href="class_eigen_1_1internal_1_1variable__if__dynamic.html">internal::variable_if_dynamic</a><Index, RowsAtCompileTime> <a class="el" href="class_eigen_1_1_cwise_nullary_op.html#a4d54550d07253a4a4db5028c92e6b266">Eigen::CwiseNullaryOp::m_rows</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Definition at line <a class="el" href="_core_source.html#l00109">109</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>