<!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::Map 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_map.html">Map</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::Map 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::Map" --><!-- doxytag: inherits="MapBase< Map< PlainObjectType, MapOptions, StrideType > >" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A matrix or vector expression mapping an existing array of data. </p>
<dl><dt><b>Template Parameters:</b></dt><dd>
<table class="">
<tr><td class="paramname">PlainObjectType</td><td>the equivalent matrix type of the mapped data </td></tr>
<tr><td class="paramname">MapOptions</td><td>specifies whether the pointer is <code><a class="el" href="group__enums.html#gga7ffcbdd4d5e5d6da4cd1497c9c52d454ae12d0f8f869c40c76128260af2242bc8" title="Object is aligned for vectorization.">Aligned</a></code>, or <code><a class="el" href="group__enums.html#gga7ffcbdd4d5e5d6da4cd1497c9c52d454a4e19dd09d5ff42295ba1d72d12a46686" title="Object is not correctly aligned for vectorization.">Unaligned</a></code>. The default is <code><a class="el" href="group__enums.html#gga7ffcbdd4d5e5d6da4cd1497c9c52d454a4e19dd09d5ff42295ba1d72d12a46686" title="Object is not correctly aligned for vectorization.">Unaligned</a></code>. </td></tr>
<tr><td class="paramname">StrideType</td><td>optionnally specifies strides. By default, <a class="el" href="class_eigen_1_1_map.html" title="A matrix or vector expression mapping an existing array of data.">Map</a> assumes the memory layout of an ordinary, contiguous array. This can be overridden by specifying strides. The type passed here must be a specialization of the <a class="el" href="class_eigen_1_1_stride.html" title="Holds strides information for Map.">Stride</a> template, see examples below.</td></tr>
</table>
</dd>
</dl>
<p>This class represents a matrix or vector expression mapping an existing array of data. It can be used to let <a class="el" href="namespace_eigen.html" title="Namespace containing all symbols from the Eigen library.">Eigen</a> interface without any overhead with non-Eigen data structures, such as plain C arrays or structures from other libraries. By default, it assumes that the data is laid out contiguously in memory. You can however override this by explicitly specifying inner and outer strides.</p>
<p>Here's an example of simply mapping a contiguous array as a column-major matrix: </p>
<div class="fragment"><pre class="fragment"></pre></div><p> Output: </p>
<div class="fragment"><pre class="fragment"></pre></div><p>If you need to map non-contiguous arrays, you can do so by specifying strides:</p>
<p>Here's an example of mapping an array as a vector, specifying an inner stride, that is, the pointer increment between two consecutive coefficients. Here, we're specifying the inner stride as a compile-time fixed value. </p>
<div class="fragment"><pre class="fragment"></pre></div><p> Output: </p>
<div class="fragment"><pre class="fragment"></pre></div><p>Here's an example of mapping an array while specifying an outer stride. Here, since we're mapping as a column-major matrix, 'outer stride' means the pointer increment between two consecutive columns. Here, we're specifying the outer stride as a runtime parameter. Note that here <code>OuterStride<></code> is a short version of <code>OuterStride<Dynamic></code> because the default template parameter of <a class="el" href="class_eigen_1_1_outer_stride.html" title="Convenience specialization of Stride to specify only an outer stride See class Map for some examples...">OuterStride</a> is <code>Dynamic</code> </p>
<div class="fragment"><pre class="fragment"></pre></div><p> Output: </p>
<div class="fragment"><pre class="fragment"></pre></div><p>For more details and for an example of specifying both an inner and an outer stride, see class <a class="el" href="class_eigen_1_1_stride.html" title="Holds strides information for Map.">Stride</a>.</p>
<p><b>Tip:</b> to change the array of data mapped by a <a class="el" href="class_eigen_1_1_map.html" title="A matrix or vector expression mapping an existing array of data.">Map</a> object, you can use the C++ placement new syntax:</p>
<p>Example: </p>
<div class="fragment"><pre class="fragment"></pre></div><p> Output: </p>
<div class="fragment"><pre class="fragment"></pre></div><p>This class is the return type of <a class="el" href="class_eigen_1_1_plain_object_base.html#ab686847dffbdaf938923ab773e5144de">Matrix::Map()</a> but can also be used directly.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_eigen_1_1_plain_object_base.html#ab686847dffbdaf938923ab773e5144de">Matrix::Map()</a>, TopicStorageOrders </dd></dl>
</div><div class="dynheader">
Inheritance diagram for Eigen::Map:</div>
<div class="dyncontent">
<div class="center"><img src="class_eigen_1_1_map__inherit__graph.png" border="0" usemap="#_eigen_1_1_map_inherit__map" alt="Inheritance graph"/></div>
<map name="_eigen_1_1_map_inherit__map" id="_eigen_1_1_map_inherit__map">
<area shape="rect" id="node2" href="class_map_base.html" title="MapBase\< Map\< PlainObjectType, MapOptions, StrideType \> \>" alt="" coords="5,96,400,123"/><area shape="rect" id="node4" href="class_map_base.html" title="Base class for Map and Block expression with direct access." alt="" coords="164,5,240,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_eigen_1_1_map-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 <a class="el" href="class_map_base.html">MapBase</a>< <a class="el" href="class_eigen_1_1_map.html">Map</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a442ae8c40c47c5c60b9b1ea09dbcc848">Base</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef Base::PointerType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#af9124c10543a116061158dd68472baa9">PointerType</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef const Scalar * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</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"><a class="el" href="class_eigen_1_1_map.html#af9124c10543a116061158dd68472baa9">PointerType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a789af221723314182ee5115198d380cf">cast_to_pointer_type</a> (<a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> ptr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a5fe6e392e251a05f616a3662e6c522b6">innerStride</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a9e8432d12e00d83983ade44296e32e15">outerStride</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#acf079959e59986e8852f8a7b89e3e6dc">Map</a> (<a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> data, const StrideType &stride=StrideType())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor in the fixed-size case. <a href="#acf079959e59986e8852f8a7b89e3e6dc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#ada96bb90747580f661dcca89d448c2f0">Map</a> (<a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> data, Index size, const StrideType &stride=StrideType())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor in the dynamic-size vector case. <a href="#ada96bb90747580f661dcca89d448c2f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a940c1a819b4174fa703c482e28b9f883">Map</a> (<a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> data, Index rows, Index cols, const StrideType &stride=StrideType())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor in the dynamic-size matrix case. <a href="#a940c1a819b4174fa703c482e28b9f883"></a><br/></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">StrideType </td><td class="memItemRight" valign="bottom"><a class="el" href="class_eigen_1_1_map.html#a038f0f8b23a32df152d303540aff1b2a">m_stride</a></td></tr>
</table>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a442ae8c40c47c5c60b9b1ea09dbcc848"></a><!-- doxytag: member="Eigen::Map::Base" ref="a442ae8c40c47c5c60b9b1ea09dbcc848" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="class_map_base.html">MapBase</a><<a class="el" href="class_eigen_1_1_map.html">Map</a>> <a class="el" href="class_eigen_1_1_map.html#a442ae8c40c47c5c60b9b1ea09dbcc848">Eigen::Map::Base</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_core_source.html#l00123">123</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
</div>
</div>
<a class="anchor" id="a4810c087e5123987f20f87215b388ed9"></a><!-- doxytag: member="Eigen::Map::PointerArgType" ref="a4810c087e5123987f20f87215b388ed9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const Scalar* <a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">Eigen::Map::PointerArgType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_core_source.html#l00129">129</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
</div>
</div>
<a class="anchor" id="af9124c10543a116061158dd68472baa9"></a><!-- doxytag: member="Eigen::Map::PointerType" ref="af9124c10543a116061158dd68472baa9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Base::PointerType <a class="el" href="class_eigen_1_1_map.html#af9124c10543a116061158dd68472baa9">Eigen::Map::PointerType</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_core_source.html#l00127">127</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="acf079959e59986e8852f8a7b89e3e6dc"></a><!-- doxytag: member="Eigen::Map::Map" ref="acf079959e59986e8852f8a7b89e3e6dc" args="(PointerArgType data, const StrideType &stride=StrideType())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Eigen::Map::Map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const StrideType & </td>
<td class="paramname"><em>stride</em> = <code>StrideType()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor in the fixed-size case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>pointer to the array to map </td></tr>
<tr><td class="paramname">stride</td><td>optional <a class="el" href="class_eigen_1_1_stride.html" title="Holds strides information for Map.">Stride</a> object, passing the strides. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_core_source.html#l00154">154</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
</div>
</div>
<a class="anchor" id="ada96bb90747580f661dcca89d448c2f0"></a><!-- doxytag: member="Eigen::Map::Map" ref="ada96bb90747580f661dcca89d448c2f0" args="(PointerArgType data, Index size, const StrideType &stride=StrideType())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Eigen::Map::Map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> </td>
<td class="paramname"><em>data</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 class="paramkey"></td>
<td></td>
<td class="paramtype">const StrideType & </td>
<td class="paramname"><em>stride</em> = <code>StrideType()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor in the dynamic-size vector case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>pointer to the array to map </td></tr>
<tr><td class="paramname">size</td><td>the size of the vector expression </td></tr>
<tr><td class="paramname">stride</td><td>optional <a class="el" href="class_eigen_1_1_stride.html" title="Holds strides information for Map.">Stride</a> object, passing the strides. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_core_source.html#l00166">166</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
</div>
</div>
<a class="anchor" id="a940c1a819b4174fa703c482e28b9f883"></a><!-- doxytag: member="Eigen::Map::Map" ref="a940c1a819b4174fa703c482e28b9f883" args="(PointerArgType data, Index rows, Index cols, const StrideType &stride=StrideType())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Eigen::Map::Map </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></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 StrideType & </td>
<td class="paramname"><em>stride</em> = <code>StrideType()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor in the dynamic-size matrix case. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>pointer to the array to map </td></tr>
<tr><td class="paramname">rows</td><td>the number of rows of the matrix expression </td></tr>
<tr><td class="paramname">cols</td><td>the number of columns of the matrix expression </td></tr>
<tr><td class="paramname">stride</td><td>optional <a class="el" href="class_eigen_1_1_stride.html" title="Holds strides information for Map.">Stride</a> object, passing the strides. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_core_source.html#l00179">179</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="a789af221723314182ee5115198d380cf"></a><!-- doxytag: member="Eigen::Map::cast_to_pointer_type" ref="a789af221723314182ee5115198d380cf" args="(PointerArgType ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_eigen_1_1_map.html#af9124c10543a116061158dd68472baa9">PointerType</a> Eigen::Map::cast_to_pointer_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_eigen_1_1_map.html#a4810c087e5123987f20f87215b388ed9">PointerArgType</a> </td>
<td class="paramname"><em>ptr</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#l00130">130</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
</div>
</div>
<a class="anchor" id="a5fe6e392e251a05f616a3662e6c522b6"></a><!-- doxytag: member="Eigen::Map::innerStride" ref="a5fe6e392e251a05f616a3662e6c522b6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Index Eigen::Map::innerStride </td>
<td>(</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#l00136">136</a> of file <a class="el" href="_core_source.html">Core</a>.</p>
</div>
</div>
<a class="anchor" id="a9e8432d12e00d83983ade44296e32e15"></a><!-- doxytag: member="Eigen::Map::outerStride" ref="a9e8432d12e00d83983ade44296e32e15" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Index Eigen::Map::outerStride </td>
<td>(</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#l00141">141</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="a038f0f8b23a32df152d303540aff1b2a"></a><!-- doxytag: member="Eigen::Map::m_stride" ref="a038f0f8b23a32df152d303540aff1b2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StrideType <a class="el" href="class_eigen_1_1_map.html#a038f0f8b23a32df152d303540aff1b2a">Eigen::Map::m_stride</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_core_source.html#l00189">189</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>
