<!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: VectorBlock< MatrixType, Size > 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_1VectorBlock.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_1VectorBlock-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">VectorBlock< MatrixType, Size > 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 MatrixType, int Size = Dynamic><br/>
class Eigen::VectorBlock< MatrixType, Size ></h3>
<p>Expression of a fixed-size or dynamic-size sub-vector. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">VectorType</td><td>the type of the object in which we are taking a sub-vector </td></tr>
<tr><td class="paramname">Size</td><td>size of the sub-vector 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 sub-vector. It is the return type of <a class="el" href="classEigen_1_1DenseBase.html#a3a182e8a52e9c6761ded3813f751ab03">DenseBase::segment(Index,Index)</a> and <a class="el" href="classEigen_1_1DenseBase.html#a712d8a3514a4454cecba9fc0910588e2">DenseBase::segment<int>(Index)</a> and most of the time this is the only way it is used.</p>
<p>However, if you want to directly maniputate sub-vector 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_1VectorBlock.html">Eigen::VectorBlock<Derived></a></div>
<div class="line">segmentFromRange(<a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& v, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> end)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1VectorBlock.html">Eigen::VectorBlock<Derived></a>(v.derived(), start, end-start);</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_1VectorBlock.html">Eigen::VectorBlock<const Derived></a></div>
<div class="line">segmentFromRange(<span class="keyword">const</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& v, <span class="keywordtype">int</span> start, <span class="keywordtype">int</span> end)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1VectorBlock.html">Eigen::VectorBlock<const Derived></a>(v.derived(), start, end-start);</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">Matrix<int,1,6></a> v; v << 1,2,3,4,5,6;</div>
<div class="line"> cout << segmentFromRange(2*v, 2, 4) << endl; <span class="comment">// calls the const version</span></div>
<div class="line"> segmentFromRange(v, 1, 3) *= 5; <span class="comment">// calls the non-const version</span></div>
<div class="line"> cout << <span class="stringliteral">"Now the vector v is:"</span> << endl << v << endl;</div>
<div class="line"> <span class="keywordflow">return</span> 0;</div>
<div class="line">}</div>
</div><!-- fragment --><p> Output: </p>
<pre class="fragment">6 8
Now the vector v is:
1 10 15 4 5 6
</pre><dl class="section note"><dt>Note</dt><dd>Even though this expression has dynamic size, in the case where <em>VectorType</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_1VectorBlock.html">Eigen::VectorBlock<Derived, 2></a></div>
<div class="line">firstTwo(<a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& v)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1VectorBlock.html">Eigen::VectorBlock<Derived, 2></a>(v.derived(), 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_1VectorBlock.html">Eigen::VectorBlock<const Derived, 2></a></div>
<div class="line">firstTwo(<span class="keyword">const</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived></a>& v)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1VectorBlock.html">Eigen::VectorBlock<const Derived, 2></a>(v.derived(), 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">Matrix<int,1,6></a> v; v << 1,2,3,4,5,6;</div>
<div class="line"> cout << firstTwo(4*v) << endl; <span class="comment">// calls the const version</span></div>
<div class="line"> firstTwo(v) *= 2; <span class="comment">// calls the non-const version</span></div>
<div class="line"> cout << <span class="stringliteral">"Now the vector v is:"</span> << endl << v << 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 8
Now the vector v is:
2 4 3 4 5 6
</pre><dl class="section see"><dt>See Also</dt><dd>class <a class="el" href="classEigen_1_1Block.html" title="Expression of a fixed-size or dynamic-size block. ">Block</a>, DenseBase::segment(Index,Index,Index,Index), <a class="el" href="classEigen_1_1DenseBase.html#a3a182e8a52e9c6761ded3813f751ab03">DenseBase::segment(Index,Index)</a> </dd></dl>
</div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for VectorBlock< MatrixType, Size >:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classEigen_1_1VectorBlock__inherit__graph.png" border="0" usemap="#VectorBlock_3_01MatrixType_00_01Size_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="VectorBlock_3_01MatrixType_00_01Size_01_4_inherit__map" id="VectorBlock_3_01MatrixType_00_01Size_01_4_inherit__map">
</map>
</div>
<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:af312216fff4513d4aa46ada769792333"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1VectorBlock.html#af312216fff4513d4aa46ada769792333">VectorBlock</a> (VectorType &vector, Index start, Index size)</td></tr>
<tr class="separator:af312216fff4513d4aa46ada769792333"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7d7aca9ed50dfbbe89514135c8865f5c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1VectorBlock.html#a7d7aca9ed50dfbbe89514135c8865f5c">VectorBlock</a> (VectorType &vector, Index start)</td></tr>
<tr class="separator:a7d7aca9ed50dfbbe89514135c8865f5c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="af312216fff4513d4aa46ada769792333"></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_1VectorBlock.html">VectorBlock</a> </td>
<td>(</td>
<td class="paramtype">VectorType & </td>
<td class="paramname"><em>vector</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Index </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Index </td>
<td class="paramname"><em>size</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>
</div>
</div>
<a class="anchor" id="a7d7aca9ed50dfbbe89514135c8865f5c"></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_1VectorBlock.html">VectorBlock</a> </td>
<td>(</td>
<td class="paramtype">VectorType & </td>
<td class="paramname"><em>vector</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Index </td>
<td class="paramname"><em>start</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>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ForwardDeclarations_8h_source.html">ForwardDeclarations.h</a></li>
<li><a class="el" href="VectorBlock_8h_source.html">VectorBlock.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_1VectorBlock.html">VectorBlock</a></li>
<li class="footer">Generated on Mon Oct 28 2013 11:04:31 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>
