<!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-unsupported: SkylineMatrix< _Scalar, _Options > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="eigendoxy.css" rel="stylesheet" type="text/css">
<!-- -->
<script type="text/javascript" src="eigen_navtree_hacks.js"></script>
<!-- <script type="text/javascript"> -->
<!-- </script> -->
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<!-- <a name="top"></a> -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="Eigen_Silly_Professor_64x64.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://eigen.tuxfamily.org">Eigen-unsupported</a>
 <span id="projectnumber">3.2.0</span>
</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classEigen_1_1SkylineMatrix.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>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="classEigen_1_1SkylineMatrix-members.html">List of all members</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">SkylineMatrix< _Scalar, _Options > Class Template Reference<div class="ingroups"><a class="el" href="group__Skyline__Module.html">Skyline module</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<typename _Scalar, int _Options><br/>
class Eigen::SkylineMatrix< _Scalar, _Options ></h3>
<p>The main skyline matrix class. </p>
<p>This class implements a skyline matrix using the very uncommon storage scheme.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">_Scalar</td><td>the scalar type, i.e. the type of the coefficients </td></tr>
<tr><td class="paramname">_Options</td><td>Union of bit flags controlling the storage scheme. Currently the only possibility is RowMajor. The default is 0 which means column-major. </td></tr>
</table>
</dd>
</dl>
</div><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SkylineMatrix< _Scalar, _Options >:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classEigen_1_1SkylineMatrix__inherit__graph.png" border="0" usemap="#SkylineMatrix_3_01__Scalar_00_01__Options_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="SkylineMatrix_3_01__Scalar_00_01__Options_01_4_inherit__map" id="SkylineMatrix_3_01__Scalar_00_01__Options_01_4_inherit__map">
<area shape="rect" id="node2" href="classEigen_1_1SkylineMatrixBase.html" title="{SkylineMatrixBase\<\l SkylineMatrix\< _Scalar,\l _Options \> \>\n|# m_isRValue\l|+ assignGeneric()\l+ cols()\l+ eval()\l+ evalTo()\l+ innerSize()\l+ isRValue()\l+ markAsRValue()\l+ nonZeros()\l+ operator*()\l+ operator=()\land 7 more...\l}" alt="" coords="4,5,168,259"/></map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac6c91e3542260895fca24299c04bac88"><td class="memItemLeft" align="right" valign="top">const internal::eval<br class="typebreak"/>
< <a class="el" href="classEigen_1_1SkylineMatrix.html">SkylineMatrix</a>< _Scalar, <br class="typebreak"/>
_Options >, IsSkyline >::type </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrixBase.html#ac6c91e3542260895fca24299c04bac88">eval</a> () const</td></tr>
<tr class="separator:ac6c91e3542260895fca24299c04bac88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32d626626eee0bc4ade146973f6abb1c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#a32d626626eee0bc4ade146973f6abb1c">finalize</a> ()</td></tr>
<tr class="separator:a32d626626eee0bc4ade146973f6abb1c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a273dc3bb58dff1c75d591d2b4c6cd67a"><td class="memItemLeft" align="right" valign="top">EIGEN_DONT_INLINE Scalar & </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#a273dc3bb58dff1c75d591d2b4c6cd67a">insert</a> (Index row, Index col)</td></tr>
<tr class="separator:a273dc3bb58dff1c75d591d2b4c6cd67a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe29bfb5f2d88cf2a50ffb577ec6f0a4"><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#abe29bfb5f2d88cf2a50ffb577ec6f0a4">nonZeros</a> () const </td></tr>
<tr class="separator:abe29bfb5f2d88cf2a50ffb577ec6f0a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3d35ccb0154f2b4bbc5d39b1bc0fb81"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#aa3d35ccb0154f2b4bbc5d39b1bc0fb81">reserve</a> (Index reserveSize, Index reserveUpperSize, Index reserveLowerSize)</td></tr>
<tr class="separator:aa3d35ccb0154f2b4bbc5d39b1bc0fb81"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0c46dfd7eb3dd84cd7f7f344a949af12"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#a0c46dfd7eb3dd84cd7f7f344a949af12">resize</a> (size_t rows, size_t cols)</td></tr>
<tr class="separator:a0c46dfd7eb3dd84cd7f7f344a949af12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47affd1a10b589811fc4828c1a2e0c6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#a47affd1a10b589811fc4828c1a2e0c6d">setZero</a> ()</td></tr>
<tr class="separator:a47affd1a10b589811fc4828c1a2e0c6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76f5bc8a03ec105ab4be1f2b91b7b5d5"><td class="memItemLeft" align="right" valign="top">Index </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrixBase.html#a76f5bc8a03ec105ab4be1f2b91b7b5d5">size</a> () const</td></tr>
<tr class="separator:a76f5bc8a03ec105ab4be1f2b91b7b5d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac3b6fc39aff6c333023c66d1d20efbd1"><td class="memItemLeft" align="right" valign="top">Scalar </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#ac3b6fc39aff6c333023c66d1d20efbd1">sum</a> () const </td></tr>
<tr class="separator:ac3b6fc39aff6c333023c66d1d20efbd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8dcadf12ac9d4bb2138aeed0157c679d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEigen_1_1SkylineMatrix.html#a8dcadf12ac9d4bb2138aeed0157c679d">~SkylineMatrix</a> ()</td></tr>
<tr class="separator:a8dcadf12ac9d4bb2138aeed0157c679d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a8dcadf12ac9d4bb2138aeed0157c679d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">~<a class="el" href="classEigen_1_1SkylineMatrix.html">SkylineMatrix</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac6c91e3542260895fca24299c04bac88"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const internal::eval<<a class="el" href="classEigen_1_1SkylineMatrix.html">SkylineMatrix</a>< _Scalar, _Options > , IsSkyline>::type eval </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the matrix or vector obtained by evaluating this expression.</dd></dl>
<p>Notice that in the case of a plain matrix or vector (not an expression) this function just returns a const reference, in order to avoid a useless copy. </p>
</div>
</div>
<a class="anchor" id="a32d626626eee0bc4ade146973f6abb1c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void finalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Must be called after inserting a set of non zero entries. </p>
</div>
</div>
<a class="anchor" id="a273dc3bb58dff1c75d591d2b4c6cd67a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">EIGEN_DONT_INLINE Scalar& insert </td>
<td>(</td>
<td class="paramtype">Index </td>
<td class="paramname"><em>row</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Index </td>
<td class="paramname"><em>col</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a reference to a novel non zero coefficient with coordinates <em>row</em> x <em>col</em>.</dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>This function can be extremely slow if the non zero coefficients are not inserted in a coherent order.</dd></dl>
<p>After an insertion session, you should call the <a class="el" href="classEigen_1_1SkylineMatrix.html#a32d626626eee0bc4ade146973f6abb1c">finalize()</a> function. </p>
</div>
</div>
<a class="anchor" id="abe29bfb5f2d88cf2a50ffb577ec6f0a4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Index nonZeros </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of non zero coefficients </dd></dl>
</div>
</div>
<a class="anchor" id="aa3d35ccb0154f2b4bbc5d39b1bc0fb81"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void reserve </td>
<td>(</td>
<td class="paramtype">Index </td>
<td class="paramname"><em>reserveSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Index </td>
<td class="paramname"><em>reserveUpperSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Index </td>
<td class="paramname"><em>reserveLowerSize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Preallocates <em>reserveSize</em> non zeros </p>
</div>
</div>
<a class="anchor" id="a0c46dfd7eb3dd84cd7f7f344a949af12"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void resize </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>rows</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>cols</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Resizes the matrix to a <em>rows</em> x <em>cols</em> matrix and initializes it to zero </p>
<dl class="section see"><dt>See Also</dt><dd>resizeNonZeros(Index), <a class="el" href="classEigen_1_1SkylineMatrix.html#aa3d35ccb0154f2b4bbc5d39b1bc0fb81">reserve()</a>, <a class="el" href="classEigen_1_1SkylineMatrix.html#a47affd1a10b589811fc4828c1a2e0c6d">setZero()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a47affd1a10b589811fc4828c1a2e0c6d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void setZero </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all non zeros </p>
</div>
</div>
<a class="anchor" id="a76f5bc8a03ec105ab4be1f2b91b7b5d5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Index size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">inherited</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the number of coefficients, which is <em><a class="el" href="classEigen_1_1SkylineMatrixBase.html#a5552abd83dbd03c85cea6d61fd8875a5">rows()</a>*cols</em>(). </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="classEigen_1_1SkylineMatrixBase.html#a5552abd83dbd03c85cea6d61fd8875a5">rows()</a>, <a class="el" href="classEigen_1_1SkylineMatrixBase.html#aaca1908a5ec508a25ff0a8bca803e5f3">cols()</a>, <a class="el" href="classEigen_1_1SkylineMatrixBase.html#adb49720dc49f7d4e4cf9adbf2948e409ab30be5c02d7a124ec165d2ab6c5b05ed">SizeAtCompileTime</a>. </dd></dl>
<p>References <a class="el" href="classEigen_1_1SkylineMatrixBase.html#aaca1908a5ec508a25ff0a8bca803e5f3">SkylineMatrixBase< Derived >::cols()</a>, and <a class="el" href="classEigen_1_1SkylineMatrixBase.html#a5552abd83dbd03c85cea6d61fd8875a5">SkylineMatrixBase< Derived >::rows()</a>.</p>
</div>
</div>
<a class="anchor" id="ac3b6fc39aff6c333023c66d1d20efbd1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Scalar sum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Overloaded for performance </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SkylineMatrix_8h_source.html">SkylineMatrix.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceEigen.html">Eigen</a></li><li class="navelem"><a class="el" href="classEigen_1_1SkylineMatrix.html">SkylineMatrix</a></li>
<li class="footer">Generated on Mon Oct 28 2013 11:05:27 for Eigen-unsupported 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>
