<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>Eigen: Block< XprType, BlockRows, BlockCols, InnerPanel > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="eigendoxy.css" rel="stylesheet" type="text/css"> <!-- --> <script type="text/javascript" src="eigen_navtree_hacks.js"></script> <!-- <script type="text/javascript"> --> <!-- </script> --> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <!-- <a name="top"></a> --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen</a>  <span id="projectnumber">3.2.0</span> </div> </td> <td> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('classEigen_1_1Block.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="classEigen_1_1Block-members.html">List of all members</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">Block< XprType, BlockRows, BlockCols, InnerPanel > Class Template Reference<div class="ingroups"><a class="el" href="group__Core__Module.html">Core module</a></div></div> </div> </div><!--header--> <div class="contents"> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename XprType, int BlockRows, int BlockCols, bool InnerPanel><br/> class Eigen::Block< XprType, BlockRows, BlockCols, InnerPanel ></h3> <p>Expression of a fixed-size or dynamic-size block. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">XprType</td><td>the type of the expression in which we are taking a block </td></tr> <tr><td class="paramname">BlockRows</td><td>the number of rows of the block we are taking at compile time (optional) </td></tr> <tr><td class="paramname">BlockCols</td><td>the number of columns of the block we are taking at compile time (optional)</td></tr> </table> </dd> </dl> <p>This class represents an expression of either a fixed-size or dynamic-size block. It is the return type of <a class="el" href="classEigen_1_1DenseBase.html#a1dbaa2fc7b809720407130f48dfacf8f">DenseBase::block(Index,Index,Index,Index)</a> and <a class="el" href="classEigen_1_1DenseBase.html#a3e433315822db2811a65e88c70672743">DenseBase::block<int,int>(Index,Index)</a> and most of the time this is the only way it is used.</p> <p>However, if you want to directly maniputate block expressions, for instance if you want to write a function returning such an expression, you will need to use this class.</p> <p>Here is an example illustrating the dynamic case: </p> <div class="fragment"><div class="line"><span class="preprocessor">#include <Eigen/Core></span></div> <div class="line"><span class="preprocessor">#include <iostream></span></div> <div class="line"><span class="keyword">using namespace </span>Eigen;</div> <div class="line"><span class="keyword">using namespace </span>std;</div> <div class="line"></div> <div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> Derived></div> <div class="line"><a class="code" href="classEigen_1_1Block.html">Eigen::Block<Derived></a></div> <div class="line">topLeftCorner(<a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& m, <span class="keywordtype">int</span> rows, <span class="keywordtype">int</span> cols)</div> <div class="line">{</div> <div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1Block.html">Eigen::Block<Derived></a>(m.derived(), 0, 0, rows, cols);</div> <div class="line">}</div> <div class="line"></div> <div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> Derived></div> <div class="line"><span class="keyword">const</span> <a class="code" href="classEigen_1_1Block.html">Eigen::Block<const Derived></a></div> <div class="line">topLeftCorner(<span class="keyword">const</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& m, <span class="keywordtype">int</span> rows, <span class="keywordtype">int</span> cols)</div> <div class="line">{</div> <div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1Block.html">Eigen::Block<const Derived></a>(m.derived(), 0, 0, rows, cols);</div> <div class="line">}</div> <div class="line"></div> <div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span>, <span class="keywordtype">char</span>**)</div> <div class="line">{</div> <div class="line"> <a class="code" href="classEigen_1_1Matrix.html">Matrix4d</a> m = <a class="code" href="classEigen_1_1MatrixBase.html#a0650b65c6ae6c3d19a138b72a6d68568">Matrix4d::Identity</a>();</div> <div class="line"> cout << topLeftCorner(4*m, 2, 3) << endl; <span class="comment">// calls the const version</span></div> <div class="line"> topLeftCorner(m, 2, 3) *= 5; <span class="comment">// calls the non-const version</span></div> <div class="line"> cout << <span class="stringliteral">"Now the matrix m is:"</span> << endl << m << endl;</div> <div class="line"> <span class="keywordflow">return</span> 0;</div> <div class="line">}</div> </div><!-- fragment --><p> Output: </p> <pre class="fragment">4 0 0 0 4 0 Now the matrix m is: 5 0 0 0 0 5 0 0 0 0 1 0 0 0 0 1 </pre><dl class="section note"><dt>Note</dt><dd>Even though this expression has dynamic size, in the case where <em>XprType</em> has fixed size, this expression inherits a fixed maximal size which means that evaluating it does not cause a dynamic memory allocation.</dd></dl> <p>Here is an example illustrating the fixed-size case: </p> <div class="fragment"><div class="line"><span class="preprocessor">#include <Eigen/Core></span></div> <div class="line"><span class="preprocessor">#include <iostream></span></div> <div class="line"><span class="keyword">using namespace </span>Eigen;</div> <div class="line"><span class="keyword">using namespace </span>std;</div> <div class="line"></div> <div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> Derived></div> <div class="line"><a class="code" href="classEigen_1_1Block.html">Eigen::Block<Derived, 2, 2></a></div> <div class="line">topLeft2x2Corner(<a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& m)</div> <div class="line">{</div> <div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1Block.html">Eigen::Block<Derived, 2, 2></a>(m.derived(), 0, 0);</div> <div class="line">}</div> <div class="line"></div> <div class="line"><span class="keyword">template</span><<span class="keyword">typename</span> Derived></div> <div class="line"><span class="keyword">const</span> <a class="code" href="classEigen_1_1Block.html">Eigen::Block<const Derived, 2, 2></a></div> <div class="line">topLeft2x2Corner(<span class="keyword">const</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& m)</div> <div class="line">{</div> <div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1Block.html">Eigen::Block<const Derived, 2, 2></a>(m.derived(), 0, 0);</div> <div class="line">}</div> <div class="line"></div> <div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span>, <span class="keywordtype">char</span>**)</div> <div class="line">{</div> <div class="line"> <a class="code" href="classEigen_1_1Matrix.html">Matrix3d</a> m = <a class="code" href="classEigen_1_1MatrixBase.html#a0650b65c6ae6c3d19a138b72a6d68568">Matrix3d::Identity</a>();</div> <div class="line"> cout << topLeft2x2Corner(4*m) << endl; <span class="comment">// calls the const version</span></div> <div class="line"> topLeft2x2Corner(m) *= 2; <span class="comment">// calls the non-const version</span></div> <div class="line"> cout << <span class="stringliteral">"Now the matrix m is:"</span> << endl << m << endl;</div> <div class="line"> <span class="keywordflow">return</span> 0;</div> <div class="line">}</div> </div><!-- fragment --><p> Output: </p> <pre class="fragment">4 0 0 4 Now the matrix m is: 2 0 0 0 2 0 0 0 1 </pre><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1DenseBase.html#a1dbaa2fc7b809720407130f48dfacf8f">DenseBase::block(Index,Index,Index,Index)</a>, <a class="el" href="classEigen_1_1DenseBase.html#a3e433315822db2811a65e88c70672743">DenseBase::block(Index,Index)</a>, class <a class="el" href="classEigen_1_1VectorBlock.html" title="Expression of a fixed-size or dynamic-size sub-vector. ">VectorBlock</a> </dd></dl> </div> <p>Inherits BlockImpl< XprType, BlockRows, BlockCols, InnerPanel, internal::traits< XprType >::StorageKind >.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aa2e498fcabce35cbd29bc520af996fa0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1Block.html#aa2e498fcabce35cbd29bc520af996fa0">Block</a> (XprType &xpr, Index i)</td></tr> <tr class="separator:aa2e498fcabce35cbd29bc520af996fa0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a15092ab44ebcdd5a86f8c615b4da6318"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1Block.html#a15092ab44ebcdd5a86f8c615b4da6318">Block</a> (XprType &xpr, Index a_startRow, Index a_startCol)</td></tr> <tr class="separator:a15092ab44ebcdd5a86f8c615b4da6318"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae9850d0b93672cbf7d06d73507b5c5be"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1Block.html#ae9850d0b93672cbf7d06d73507b5c5be">Block</a> (XprType &xpr, Index a_startRow, Index a_startCol, Index blockRows, Index blockCols)</td></tr> <tr class="separator:ae9850d0b93672cbf7d06d73507b5c5be"><td class="memSeparator" colspan="2"> </td></tr> </table> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="aa2e498fcabce35cbd29bc520af996fa0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1Block.html">Block</a> </td> <td>(</td> <td class="paramtype">XprType & </td> <td class="paramname"><em>xpr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>i</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Column or Row constructor </p> </div> </div> <a class="anchor" id="a15092ab44ebcdd5a86f8c615b4da6318"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1Block.html">Block</a> </td> <td>(</td> <td class="paramtype">XprType & </td> <td class="paramname"><em>xpr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>a_startRow</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>a_startCol</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Fixed-size constructor </p> <p>References <a class="el" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Eigen::Dynamic</a>.</p> </div> </div> <a class="anchor" id="ae9850d0b93672cbf7d06d73507b5c5be"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEigen_1_1Block.html">Block</a> </td> <td>(</td> <td class="paramtype">XprType & </td> <td class="paramname"><em>xpr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>a_startRow</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>a_startCol</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>blockRows</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Index </td> <td class="paramname"><em>blockCols</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Dynamic-size constructor </p> <p>References <a class="el" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Eigen::Dynamic</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="Block_8h_source.html">Block.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1Block.html">Block</a></li> <li class="footer">Generated on Mon Oct 28 2013 11:04:28 for Eigen by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li> </ul> </div> <!-- Piwik --> <!-- <script type="text/javascript"> var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.sylphide-consulting.com/piwik/" : "http://stats.sylphide-consulting.com/piwik/"); document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E")); </script><script type="text/javascript"> try { var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 20); piwikTracker.trackPageView(); piwikTracker.enableLinkTracking(); } catch( err ) {} </script><noscript><p><img src="http://stats.sylphide-consulting.com/piwik/piwik.php?idsite=20" style="border:0" alt="" /></p></noscript> --> <!-- End Piwik Tracking Code --> </body> </html>