<!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: Diagonal.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('Diagonal_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">Diagonal.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) 2007-2009 Benoit Jacob <jacob.benoit.1@gmail.com></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">// Copyright (C) 2009-2010 Gael Guennebaud <gael.guennebaud@inria.fr></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_DIAGONAL_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define EIGEN_DIAGONAL_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="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace </span>internal {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">template</span><<span class="keyword">typename</span> MatrixType, <span class="keywordtype">int</span> DiagIndex></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">struct </span>traits<Diagonal<MatrixType,DiagIndex> ></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  : traits<MatrixType></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> nested<MatrixType>::type MatrixTypeNested;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> remove_reference<MatrixTypeNested>::type _MatrixTypeNested;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> MatrixType::StorageKind StorageKind;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  RowsAtCompileTime = (int(DiagIndex) == <a class="code" href="namespaceEigen.html#abaee3972025110fb68546b12092203c0">DynamicIndex</a> || int(MatrixType::SizeAtCompileTime) == <a class="code" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a>) ? <a class="code" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  : (EIGEN_PLAIN_ENUM_MIN(MatrixType::RowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0),</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  MatrixType::ColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))),</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  ColsAtCompileTime = 1,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  MaxRowsAtCompileTime = <span class="keywordtype">int</span>(MatrixType::MaxSizeAtCompileTime) == <a class="code" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a> ? <a class="code" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  : DiagIndex == <a class="code" href="namespaceEigen.html#abaee3972025110fb68546b12092203c0">DynamicIndex</a> ? EIGEN_SIZE_MIN_PREFER_FIXED(MatrixType::MaxRowsAtCompileTime,</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  MatrixType::MaxColsAtCompileTime)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  : (EIGEN_PLAIN_ENUM_MIN(MatrixType::MaxRowsAtCompileTime - EIGEN_PLAIN_ENUM_MAX(-DiagIndex, 0),</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  MatrixType::MaxColsAtCompileTime - EIGEN_PLAIN_ENUM_MAX( DiagIndex, 0))),</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  MaxColsAtCompileTime = 1,</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  MaskLvalueBit = is_lvalue<MatrixType>::value ? <a class="code" href="group__flags.html#ga64e21b7543bdedce27f013512a4403a3">LvalueBit</a> : 0,</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  Flags = (unsigned int)_MatrixTypeNested::Flags & (HereditaryBits | <a class="code" href="group__flags.html#gab9799bf6feed77fc9fce0136ee55b99c">LinearAccessBit</a> | MaskLvalueBit | <a class="code" href="group__flags.html#ga54c3b872f5a14e7e0d3d6539b704ea67">DirectAccessBit</a>) & ~<a class="code" href="group__flags.html#ga7bd49e7b260e869e10fb9dc4fd081a85">RowMajorBit</a>,</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  CoeffReadCost = _MatrixTypeNested::CoeffReadCost,</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  MatrixTypeOuterStride = outer_stride_at_compile_time<MatrixType>::ret,</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  InnerStrideAtCompileTime = MatrixTypeOuterStride == <a class="code" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a> ? <a class="code" href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Dynamic</a> : MatrixTypeOuterStride+1,</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  OuterStrideAtCompileTime = 0</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  };</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> };</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classEigen_1_1Diagonal.html"> 64</a></span> <span class="keyword">template</span><<span class="keyword">typename</span> MatrixType, <span class="keywordtype">int</span> _DiagIndex> <span class="keyword">class </span><a class="code" href="classEigen_1_1Diagonal.html">Diagonal</a></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  : <span class="keyword">public</span> internal::dense_xpr_base< Diagonal<MatrixType,_DiagIndex> >::type</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> {</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">enum</span> { DiagIndex = _DiagIndex };</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> internal::dense_xpr_base<Diagonal>::type Base;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  EIGEN_DENSE_PUBLIC_INTERFACE(<a class="code" href="classEigen_1_1Diagonal.html">Diagonal</a>)</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">inline</span> <a class="code" href="classEigen_1_1Diagonal.html">Diagonal</a>(MatrixType& matrix, Index a_index = DiagIndex) : m_matrix(matrix), m_index(a_index) {}</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  EIGEN_INHERIT_ASSIGNMENT_OPERATORS(<a class="code" href="classEigen_1_1Diagonal.html">Diagonal</a>)</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">inline</span> Index rows()<span class="keyword"> const</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword"> </span>{ <span class="keywordflow">return</span> m_index.value()<0 ? (std::min<Index>)(m_matrix.cols(),m_matrix.rows()+m_index.value()) : (std::min<Index>)(m_matrix.rows(),m_matrix.cols()-m_index.value()); }</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">inline</span> Index cols()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }</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>  <span class="keyword">inline</span> Index innerStride()<span class="keyword"> const</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordflow">return</span> m_matrix.outerStride() + 1;</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> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">inline</span> Index outerStride()<span class="keyword"> const</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  }</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keyword">typedef</span> <span class="keyword">typename</span> internal::conditional<</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  internal::is_lvalue<MatrixType>::value,</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  Scalar,</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">const</span> Scalar</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  >::type ScalarWithConstIfNotLvalue;</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">inline</span> ScalarWithConstIfNotLvalue* data() { <span class="keywordflow">return</span> &(m_matrix.const_cast_derived().coeffRef(rowOffset(), colOffset())); }</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">inline</span> <span class="keyword">const</span> Scalar* data()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> &(m_matrix.const_cast_derived().coeffRef(rowOffset(), colOffset())); }</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">inline</span> Scalar& coeffRef(Index row, Index)</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  {</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  EIGEN_STATIC_ASSERT_LVALUE(MatrixType)</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordflow">return</span> m_matrix.const_cast_derived().coeffRef(row+rowOffset(), row+colOffset());</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keyword">inline</span> <span class="keyword">const</span> Scalar& coeffRef(Index row, Index)<span class="keyword"> const</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">return</span> m_matrix.const_cast_derived().coeffRef(row+rowOffset(), row+colOffset());</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  }</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">inline</span> CoeffReturnType coeff(Index row, Index)<span class="keyword"> const</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">return</span> m_matrix.coeff(row+rowOffset(), row+colOffset());</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  }</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">inline</span> Scalar& coeffRef(Index idx)</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  {</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  EIGEN_STATIC_ASSERT_LVALUE(MatrixType)</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> m_matrix.const_cast_derived().coeffRef(idx+rowOffset(), idx+colOffset());</div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">inline</span> <span class="keyword">const</span> Scalar& coeffRef(Index idx)<span class="keyword"> const</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordflow">return</span> m_matrix.const_cast_derived().coeffRef(idx+rowOffset(), idx+colOffset());</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  }</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">inline</span> CoeffReturnType coeff(Index idx)<span class="keyword"> const</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="keywordflow">return</span> m_matrix.coeff(idx+rowOffset(), idx+colOffset());</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  }</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">const</span> <span class="keyword">typename</span> internal::remove_all<typename MatrixType::Nested>::type& </div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  nestedExpression()<span class="keyword"> const </span></div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> m_matrix;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keywordtype">int</span> index()<span class="keyword"> const</span></div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">return</span> m_index.value();</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  }</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">typename</span> MatrixType::Nested m_matrix;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <span class="keyword">const</span> internal::variable_if_dynamicindex<Index, DiagIndex> m_index;</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="comment">// some compilers may fail to optimize std::max etc in case of compile-time constants...</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  EIGEN_STRONG_INLINE Index absDiagIndex()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_index.value()>0 ? m_index.value() : -m_index.value(); }</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  EIGEN_STRONG_INLINE Index rowOffset()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_index.value()>0 ? 0 : -m_index.value(); }</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  EIGEN_STRONG_INLINE Index colOffset()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_index.value()>0 ? m_index.value() : 0; }</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="comment">// triger a compile time error is someone try to call packet</span></div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">template</span><<span class="keywordtype">int</span> LoadMode> <span class="keyword">typename</span> MatrixType::PacketReturnType packet(Index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keyword">template</span><<span class="keywordtype">int</span> LoadMode> <span class="keyword">typename</span> MatrixType::PacketReturnType packet(Index,Index) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> };</div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1Diagonal.html">MatrixBase<Derived>::DiagonalReturnType</a></div>
<div class="line"><a name="l00168"></a><span class="lineno"><a class="line" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25"> 168</a></span> <a class="code" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">MatrixBase<Derived>::diagonal</a>()</div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span> {</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">return</span> derived();</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> }</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1Transpose.html">MatrixBase<Derived>::ConstDiagonalReturnType</a></div>
<div class="line"><a name="l00176"></a><span class="lineno"><a class="line" href="classEigen_1_1MatrixBase.html#a2f6e454a7e934fb8212d269c099d0f7a"> 176</a></span> <a class="code" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">MatrixBase<Derived>::diagonal</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keyword"></span>{</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordflow">return</span> <a class="code" href="classEigen_1_1Transpose.html">ConstDiagonalReturnType</a>(derived());</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> }</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived>::template</a> DiagonalIndexReturnType<DynamicIndex>::Type</div>
<div class="line"><a name="l00194"></a><span class="lineno"><a class="line" href="classEigen_1_1MatrixBase.html#a18f8f447d5f4bd633df62a012f84df18"> 194</a></span> <a class="code" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">MatrixBase<Derived>::diagonal</a>(<a class="code" href="classEigen_1_1DenseBase.html#a4d4873e91be950c079f067fa97fd5c40">Index</a> index)</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> {</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  <span class="keywordflow">return</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1Diagonal.html">DiagonalIndexReturnType<DynamicIndex>::Type</a>(derived(), index);</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> }</div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived>::template</a> ConstDiagonalIndexReturnType<DynamicIndex>::Type</div>
<div class="line"><a name="l00202"></a><span class="lineno"><a class="line" href="classEigen_1_1MatrixBase.html#a0edef55998ac0f53d126506c955a26eb"> 202</a></span> <a class="code" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">MatrixBase<Derived>::diagonal</a>(<a class="code" href="classEigen_1_1DenseBase.html#a4d4873e91be950c079f067fa97fd5c40">Index</a> index)<span class="keyword"> const</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="keyword"></span>{</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordflow">return</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1Diagonal.html">ConstDiagonalIndexReturnType<DynamicIndex>::Type</a>(derived(), index);</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> }</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> </div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="keyword">template</span><<span class="keywordtype">int</span> Index></div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="classEigen_1_1MatrixBase.html">MatrixBase<Derived>::template</a> DiagonalIndexReturnType<Index>::Type</div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <a class="code" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">MatrixBase<Derived>::diagonal</a>()</div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> {</div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keywordflow">return</span> derived();</div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> }</div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">template</span><<span class="keyword">typename</span> Derived></div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="keyword">template</span><<span class="keywordtype">int</span> Index></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="keyword">inline</span> <span class="keyword">typename</span> MatrixBase<Derived>::template ConstDiagonalIndexReturnType<Index>::Type</div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <a class="code" href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">MatrixBase<Derived>::diagonal</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="keyword"></span>{</div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  <span class="keywordflow">return</span> derived();</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> }</div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> } <span class="comment">// end namespace Eigen</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="preprocessor">#endif // EIGEN_DIAGONAL_H</span></div>
<div class="ttc" id="namespaceEigen_html_abaee3972025110fb68546b12092203c0"><div class="ttname"><a href="namespaceEigen.html#abaee3972025110fb68546b12092203c0">Eigen::DynamicIndex</a></div><div class="ttdeci">const int DynamicIndex</div><div class="ttdef"><b>Definition:</b> Constants.h:26</div></div>
<div class="ttc" id="classEigen_1_1Transpose_html"><div class="ttname"><a href="classEigen_1_1Transpose.html">Eigen::Transpose</a></div><div class="ttdoc">Expression of the transpose of a matrix. </div><div class="ttdef"><b>Definition:</b> Transpose.h:57</div></div>
<div class="ttc" id="namespaceEigen_html_adc9da5be31bdce40c25a92c27999c0e3"><div class="ttname"><a href="namespaceEigen.html#adc9da5be31bdce40c25a92c27999c0e3">Eigen::Dynamic</a></div><div class="ttdeci">const int Dynamic</div><div class="ttdef"><b>Definition:</b> Constants.h:21</div></div>
<div class="ttc" id="group__flags_html_gab9799bf6feed77fc9fce0136ee55b99c"><div class="ttname"><a href="group__flags.html#gab9799bf6feed77fc9fce0136ee55b99c">Eigen::LinearAccessBit</a></div><div class="ttdeci">const unsigned int LinearAccessBit</div><div class="ttdef"><b>Definition:</b> Constants.h:117</div></div>
<div class="ttc" id="group__flags_html_ga64e21b7543bdedce27f013512a4403a3"><div class="ttname"><a href="group__flags.html#ga64e21b7543bdedce27f013512a4403a3">Eigen::LvalueBit</a></div><div class="ttdeci">const unsigned int LvalueBit</div><div class="ttdef"><b>Definition:</b> Constants.h:131</div></div>
<div class="ttc" id="classEigen_1_1MatrixBase_html_a0a45dd0ed5a44ec3f8f43239f2e4ac25"><div class="ttname"><a href="classEigen_1_1MatrixBase.html#a0a45dd0ed5a44ec3f8f43239f2e4ac25">Eigen::MatrixBase::diagonal</a></div><div class="ttdeci">DiagonalReturnType diagonal()</div><div class="ttdef"><b>Definition:</b> Diagonal.h:168</div></div>
<div class="ttc" id="classEigen_1_1DenseBase_html_a4d4873e91be950c079f067fa97fd5c40"><div class="ttname"><a href="classEigen_1_1DenseBase.html#a4d4873e91be950c079f067fa97fd5c40">Eigen::DenseBase::Index</a></div><div class="ttdeci">internal::traits< Derived >::Index Index</div><div class="ttdoc">The type of indices. </div><div class="ttdef"><b>Definition:</b> DenseBase.h:61</div></div>
<div class="ttc" id="group__flags_html_ga7bd49e7b260e869e10fb9dc4fd081a85"><div class="ttname"><a href="group__flags.html#ga7bd49e7b260e869e10fb9dc4fd081a85">Eigen::RowMajorBit</a></div><div class="ttdeci">const unsigned int RowMajorBit</div><div class="ttdef"><b>Definition:</b> Constants.h:53</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 class="ttc" id="classEigen_1_1Diagonal_html"><div class="ttname"><a href="classEigen_1_1Diagonal.html">Eigen::Diagonal</a></div><div class="ttdoc">Expression of a diagonal/subdiagonal/superdiagonal in a matrix. </div><div class="ttdef"><b>Definition:</b> Diagonal.h:64</div></div>
<div class="ttc" id="classEigen_1_1MatrixBase_html"><div class="ttname"><a href="classEigen_1_1MatrixBase.html">Eigen::MatrixBase</a></div><div class="ttdoc">Base class for all dense matrices, vectors, and expressions. </div><div class="ttdef"><b>Definition:</b> MatrixBase.h:48</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>Diagonal.h</b></li>
<li class="footer">Generated on Mon Oct 28 2013 11:04:23 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>
