<!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: ReturnByValue.h Source File</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('ReturnByValue_8h_source.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="headertitle"> <div class="title">ReturnByValue.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// This file is part of Eigen, a lightweight C++ template library</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// for linear algebra.</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">//</span></div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">// Copyright (C) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Copyright (C) 2009-2010 Benoit Jacob <jacob.benoit.1@gmail.com></span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">//</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// This Source Code Form is subject to the terms of the Mozilla</span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Public License v. 2.0. If a copy of the MPL was not distributed</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// with this file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef EIGEN_RETURNBYVALUE_H</span></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_RETURNBYVALUE_H</span></div> <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span></div> <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">namespace </span>Eigen {</div> <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>internal {</div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">struct </span>traits<ReturnByValue<Derived> ></div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  : <span class="keyword">public</span> traits<typename traits<Derived>::ReturnType></div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">enum</span> {</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="comment">// We're disabling the DirectAccess because e.g. the constructor of</span></div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <span class="comment">// the Block-with-DirectAccess expression requires to have a coeffRef method.</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// Also, we don't want to have to implement the stride stuff.</span></div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  Flags = (traits<typename traits<Derived>::ReturnType>::Flags</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  | <a class="code" href="group__flags.html#gaf8ad6e2956f7368b8e3f7407e2319e63">EvalBeforeNestingBit</a>) & ~<a class="code" href="group__flags.html#ga54c3b872f5a14e7e0d3d6539b704ea67">DirectAccessBit</a></div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  };</div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> };</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/* The ReturnByValue object doesn't even have a coeff() method.</span></div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * So the only way that nesting it in an expression can work, is by evaluating it into a plain matrix.</span></div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * So internal::nested always gives the plain return matrix type.</span></div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> *</span></div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * FIXME: I don't understand why we need this specialization: isn't this taken care of by the EvalBeforeNestingBit ??</span></div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> */</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived,<span class="keywordtype">int</span> n,<span class="keyword">typename</span> PlainObject></div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">struct </span>nested<ReturnByValue<Derived>, n, PlainObject></div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> traits<Derived>::ReturnType type;</div> <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> };</div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> } <span class="comment">// end namespace internal</span></div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived> <span class="keyword">class </span>ReturnByValue</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  : internal::no_assignment_operator, <span class="keyword">public</span> internal::dense_xpr_base< ReturnByValue<Derived> >::type</div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div> <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> internal::traits<Derived>::ReturnType ReturnType;</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> internal::dense_xpr_base<ReturnByValue>::type Base;</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  EIGEN_DENSE_PUBLIC_INTERFACE(ReturnByValue)</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  template<typename Dest></div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  inline <span class="keywordtype">void</span> evalTo(Dest& dst)<span class="keyword"> const</span></div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword"> </span>{ <span class="keyword">static_cast<</span><span class="keyword">const </span>Derived*<span class="keyword">></span>(<span class="keyword">this</span>)->evalTo(dst); }</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">inline</span> Index rows()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keyword">const </span>Derived*<span class="keyword">></span>(<span class="keyword">this</span>)->rows(); }</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">inline</span> Index cols()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keyword">const </span>Derived*<span class="keyword">></span>(<span class="keyword">this</span>)->cols(); }</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#ifndef EIGEN_PARSED_BY_DOXYGEN</span></div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <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></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor"></span> <span class="keyword">class </span>Unusable{</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  Unusable(<span class="keyword">const</span> Unusable&) {}</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  Unusable& operator=(<span class="keyword">const</span> Unusable&) {<span class="keywordflow">return</span> *<span class="keyword">this</span>;}</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  };</div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <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>); }</div> <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <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>); }</div> <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  Unusable& coeffRef(Index) { <span class="keywordflow">return</span> *<span class="keyword">reinterpret_cast<</span>Unusable*<span class="keyword">></span>(<span class="keyword">this</span>); }</div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  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>); }</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#endif</span></div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span>};</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div> <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">template</span><<span class="keyword">typename</span> OtherDerived></div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> Derived& <a class="code" href="classEigen_1_1DenseBase.html#ab66e9094f443151c6bf7f51073dc847c">DenseBase<Derived>::operator=</a>(<span class="keyword">const</span> ReturnByValue<OtherDerived>& other)</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> {</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  other.evalTo(derived());</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordflow">return</span> derived();</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> } <span class="comment">// end namespace Eigen</span></div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="preprocessor">#endif // EIGEN_RETURNBYVALUE_H</span></div> <div class="ttc" id="group__flags_html_gaf8ad6e2956f7368b8e3f7407e2319e63"><div class="ttname"><a href="group__flags.html#gaf8ad6e2956f7368b8e3f7407e2319e63">Eigen::EvalBeforeNestingBit</a></div><div class="ttdeci">const unsigned int EvalBeforeNestingBit</div><div class="ttdef"><b>Definition:</b> Constants.h:58</div></div> <div class="ttc" id="classEigen_1_1DenseBase_html_ab66e9094f443151c6bf7f51073dc847c"><div class="ttname"><a href="classEigen_1_1DenseBase.html#ab66e9094f443151c6bf7f51073dc847c">Eigen::DenseBase::operator=</a></div><div class="ttdeci">Derived & operator=(const DenseBase< OtherDerived > &other)</div><div class="ttdef"><b>Definition:</b> Assign.h:543</div></div> <div class="ttc" id="group__flags_html_ga54c3b872f5a14e7e0d3d6539b704ea67"><div class="ttname"><a href="group__flags.html#ga54c3b872f5a14e7e0d3d6539b704ea67">Eigen::DirectAccessBit</a></div><div class="ttdeci">const unsigned int DirectAccessBit</div><div class="ttdef"><b>Definition:</b> Constants.h:142</div></div> </div><!-- fragment --></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="dir_e49d68e3078f12dfcf157021597ad168.html">Eigen</a></li><li class="navelem"><a class="el" href="dir_64b228556dc7f9fe757d43bb57fbfc24.html">src</a></li><li class="navelem"><a class="el" href="dir_55812ea607075be3acfc18281a2aed64.html">Core</a></li><li class="navelem"><b>ReturnByValue.h</b></li> <li class="footer">Generated on Mon Oct 28 2013 11:04:25 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>