<!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>The MRPT project: ReturnByValue.h Source File</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.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span 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>
</span><span class="right"></span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>ReturnByValue.h</h1> </div>
</div>
<div class="contents">
<a href="_return_by_value_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// This file is part of Eigen, a lightweight C++ template library</span>
<a name="l00002"></a>00002 <span class="comment">// for linear algebra.</span>
<a name="l00003"></a>00003 <span class="comment">//</span>
<a name="l00004"></a>00004 <span class="comment">// Copyright (C) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr></span>
<a name="l00005"></a>00005 <span class="comment">// Copyright (C) 2009-2010 Benoit Jacob <jacob.benoit.1@gmail.com></span>
<a name="l00006"></a>00006 <span class="comment">//</span>
<a name="l00007"></a>00007 <span class="comment">// Eigen is free software; you can redistribute it and/or</span>
<a name="l00008"></a>00008 <span class="comment">// modify it under the terms of the GNU Lesser General Public</span>
<a name="l00009"></a>00009 <span class="comment">// License as published by the Free Software Foundation; either</span>
<a name="l00010"></a>00010 <span class="comment">// version 3 of the License, or (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment">//</span>
<a name="l00012"></a>00012 <span class="comment">// Alternatively, you can redistribute it and/or</span>
<a name="l00013"></a>00013 <span class="comment">// modify it under the terms of the GNU General Public License as</span>
<a name="l00014"></a>00014 <span class="comment">// published by the Free Software Foundation; either version 2 of</span>
<a name="l00015"></a>00015 <span class="comment">// the License, or (at your option) any later version.</span>
<a name="l00016"></a>00016 <span class="comment">//</span>
<a name="l00017"></a>00017 <span class="comment">// Eigen is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00018"></a>00018 <span class="comment">// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00019"></a>00019 <span class="comment">// FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License or the</span>
<a name="l00020"></a>00020 <span class="comment">// GNU General Public License for more details.</span>
<a name="l00021"></a>00021 <span class="comment">//</span>
<a name="l00022"></a>00022 <span class="comment">// You should have received a copy of the GNU Lesser General Public</span>
<a name="l00023"></a>00023 <span class="comment">// License and a copy of the GNU General Public License along with</span>
<a name="l00024"></a>00024 <span class="comment">// Eigen. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#ifndef EIGEN_RETURNBYVALUE_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_RETURNBYVALUE_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment">/** \class ReturnByValue</span>
<a name="l00030"></a>00030 <span class="comment"> * \ingroup Core_Module</span>
<a name="l00031"></a>00031 <span class="comment"> *</span>
<a name="l00032"></a>00032 <span class="comment"> */</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>internal {
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">template</span><<span class="keyword">typename</span> Derived>
<a name="l00037"></a><a class="code" href="structinternal_1_1traits_3_01_return_by_value_3_01_derived_01_4_01_4.html">00037</a> <span class="keyword">struct </span>traits<<a class="code" href="class_return_by_value.html">ReturnByValue</a><Derived> >
<a name="l00038"></a>00038 : <span class="keyword">public</span> traits<typename traits<Derived>::ReturnType>
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">enum</span> {
<a name="l00041"></a>00041 <span class="comment">// We're disabling the DirectAccess because e.g. the constructor of</span>
<a name="l00042"></a>00042 <span class="comment">// the Block-with-DirectAccess expression requires to have a coeffRef method.</span>
<a name="l00043"></a>00043 <span class="comment">// Also, we don't want to have to implement the stride stuff.</span>
<a name="l00044"></a><a class="code" href="structinternal_1_1traits_3_01_return_by_value_3_01_derived_01_4_01_4.html#a2c9cda224089c891142022479cf52a3ea5e27ff699a28bd59dfed2dc04ed17045">00044</a> Flags = (traits<typename traits<Derived>::ReturnType>::Flags
<a name="l00045"></a>00045 | <a class="code" href="group__flags.html#gaf8ad6e2956f7368b8e3f7407e2319e63" title="means the expression should be evaluated by the calling expression">EvalBeforeNestingBit</a>) & ~<a class="code" href="group__flags.html#ga54c3b872f5a14e7e0d3d6539b704ea67" title="Means that the underlying array of coefficients can be directly accessed as a plain strided array...">DirectAccessBit</a>
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">/* The ReturnByValue object doesn't even have a coeff() method.</span>
<a name="l00050"></a>00050 <span class="comment"> * So the only way that nesting it in an expression can work, is by evaluating it into a plain matrix.</span>
<a name="l00051"></a>00051 <span class="comment"> * So internal::nested always gives the plain return matrix type.</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * FIXME: I don't understand why we need this specialization: isn't this taken care of by the EvalBeforeNestingBit ??</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 <span class="keyword">template</span><<span class="keyword">typename</span> Derived,<span class="keywordtype">int</span> n,<span class="keyword">typename</span> PlainObject>
<a name="l00056"></a><a class="code" href="structinternal_1_1nested_3_01_return_by_value_3_01_derived_01_4_00_01n_00_01_plain_object_01_4.html">00056</a> <span class="keyword">struct </span><a class="code" href="structinternal_1_1nested.html">nested</a><<a class="code" href="class_return_by_value.html">ReturnByValue</a><Derived>, n, PlainObject>
<a name="l00057"></a>00057 {
<a name="l00058"></a><a class="code" href="structinternal_1_1nested_3_01_return_by_value_3_01_derived_01_4_00_01n_00_01_plain_object_01_4.html#a3faa324db53e29ce0f0217ec49d4bbc2">00058</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> traits<Derived>::ReturnType <a class="code" href="structinternal_1_1nested_3_01_return_by_value_3_01_derived_01_4_00_01n_00_01_plain_object_01_4.html#a3faa324db53e29ce0f0217ec49d4bbc2">type</a>;
<a name="l00059"></a>00059 };
<a name="l00060"></a>00060
<a name="l00061"></a>00061 } <span class="comment">// end namespace internal</span>
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="class_return_by_value.html">00063</a> <span class="keyword">template</span><<span class="keyword">typename</span> Derived> <span class="keyword">class </span><a class="code" href="class_return_by_value.html">ReturnByValue</a>
<a name="l00064"></a>00064 : <span class="keyword">public</span> internal::dense_xpr_base< ReturnByValue<Derived> >::<a class="code" href="classinternal_1_1dense__xpr__base_1_1type.html">type</a>
<a name="l00065"></a>00065 {
<a name="l00066"></a>00066 <span class="keyword">public</span>:
<a name="l00067"></a><a class="code" href="class_return_by_value.html#afbd1f883b446056473a6a177195a16fb">00067</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> internal::traits<Derived>::ReturnType <a class="code" href="class_return_by_value.html#afbd1f883b446056473a6a177195a16fb">ReturnType</a>;
<a name="l00068"></a>00068
<a name="l00069"></a><a class="code" href="class_return_by_value.html#ae65d79774c6d3a99a64b4ce0a3b88f6b">00069</a> <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="structinternal_1_1dense__xpr__base.html">internal::dense_xpr_base<ReturnByValue>::type</a> <a class="code" href="class_return_by_value.html#ae65d79774c6d3a99a64b4ce0a3b88f6b">Base</a>;
<a name="l00070"></a>00070 <a class="code" href="_macros_8h.html#ab29ea1da9635d033ca44cf26ad6fa0cf">EIGEN_DENSE_PUBLIC_INTERFACE</a>(<a class="code" href="class_return_by_value.html">ReturnByValue</a>)
<a name="l00071"></a>00071
<a name="l00072"></a>00072 template<typename Dest>
<a name="l00073"></a><a class="code" href="class_return_by_value.html#ae86e975793c1d769b641e17e765b5419">00073</a> inline <span class="keywordtype">void</span> evalTo(Dest& dst)<span class="keyword"> const</span>
<a name="l00074"></a>00074 <span class="keyword"> </span>{ <span class="keyword">static_cast<</span><span class="keyword">const </span>Derived* const<span class="keyword">></span>(<span class="keyword">this</span>)-><a class="code" href="class_return_by_value.html#ae86e975793c1d769b641e17e765b5419">evalTo</a>(dst); }
<a name="l00075"></a><a class="code" href="class_return_by_value.html#a113326fb637c9106286cd28da5e938ba">00075</a> <span class="keyword">inline</span> Index <a class="code" href="class_return_by_value.html#a113326fb637c9106286cd28da5e938ba">rows</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keyword">const </span>Derived* const<span class="keyword">></span>(<span class="keyword">this</span>)-><a class="code" href="class_return_by_value.html#a113326fb637c9106286cd28da5e938ba">rows</a>(); }
<a name="l00076"></a><a class="code" href="class_return_by_value.html#a892673e2391273e40426a36810962fc4">00076</a> <span class="keyword">inline</span> Index <a class="code" href="class_return_by_value.html#a892673e2391273e40426a36810962fc4">cols</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keyword">const </span>Derived* const<span class="keyword">></span>(<span class="keyword">this</span>)-><a class="code" href="class_return_by_value.html#a892673e2391273e40426a36810962fc4">cols</a>(); }
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="preprocessor">#ifndef EIGEN_PARSED_BY_DOXYGEN</span>
<a name="l00079"></a>00079 <span class="preprocessor"></span><span class="preprocessor">#define Unusable YOU_ARE_TRYING_TO_ACCESS_A_SINGLE_COEFFICIENT_IN_A_SPECIAL_EXPRESSION_WHERE_THAT_IS_NOT_ALLOWED_BECAUSE_THAT_WOULD_BE_INEFFICIENT</span>
<a name="l00080"></a>00080 <span class="preprocessor"></span> <span class="keyword">class </span>Unusable{
<a name="l00081"></a>00081 Unusable(<span class="keyword">const</span> Unusable&) {}
<a name="l00082"></a>00082 Unusable& operator=(<span class="keyword">const</span> Unusable&) {<span class="keywordflow">return</span> *<span class="keyword">this</span>;}
<a name="l00083"></a>00083 };
<a name="l00084"></a>00084 <span class="keyword">const</span> Unusable& coeff(Index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span>Unusable*<span class="keyword">></span>(<span class="keyword">this</span>); }
<a name="l00085"></a>00085 <span class="keyword">const</span> Unusable& coeff(Index,Index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast<</span><span class="keyword">const </span>Unusable*<span class="keyword">></span>(<span class="keyword">this</span>); }
<a name="l00086"></a>00086 Unusable& coeffRef(Index) { <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast<</span>Unusable*<span class="keyword">></span>(<span class="keyword">this</span>); }
<a name="l00087"></a>00087 Unusable& coeffRef(Index,Index) { <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast<</span>Unusable*<span class="keyword">></span>(<span class="keyword">this</span>); }
<a name="l00088"></a>00088 <span class="preprocessor">#endif</span>
<a name="l00089"></a>00089 <span class="preprocessor"></span>};
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">template</span><<span class="keyword">typename</span> Derived>
<a name="l00092"></a>00092 <span class="keyword">template</span><<span class="keyword">typename</span> OtherDerived>
<a name="l00093"></a><a class="code" href="class_dense_base.html#a7f1092af48a0913b8b0d7994287996d0">00093</a> Derived& <a class="code" href="class_dense_base.html" title="Base class for all dense matrices, vectors, and arrays.">DenseBase<Derived>::operator=</a>(<span class="keyword">const</span> <a class="code" href="class_return_by_value.html">ReturnByValue<OtherDerived></a>& other)
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 other.<a class="code" href="class_return_by_value.html#ae86e975793c1d769b641e17e765b5419">evalTo</a>(derived());
<a name="l00096"></a>00096 <span class="keywordflow">return</span> derived();
<a name="l00097"></a>00097 }
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor">#endif // EIGEN_RETURNBYVALUE_H</span>
</pre></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.2</a> for MRPT 0.9.4 SVN: at Mon Jan 10 22:30:30 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
