Files
ortools-clone/docs/cpp/classoperations__research_1_1SparsePermutation.html
2020-09-01 16:01:06 +02:00

407 lines
19 KiB
HTML

<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: SparsePermutation</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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="orLogo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">8.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classoperations__research_1_1SparsePermutation.html',''); initResizable(); });
/* @license-end */
</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)">
</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="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classoperations__research_1_1SparsePermutation-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SparsePermutation</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00027">27</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structoperations__research_1_1SparsePermutation_1_1Iterator.html">Iterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a1d5b283f6fa63b162d0dd2b58333ca19"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a1d5b283f6fa63b162d0dd2b58333ca19">SparsePermutation</a> (int size)</td></tr>
<tr class="separator:a1d5b283f6fa63b162d0dd2b58333ca19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24926108b770033792d015cb86aeffb3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a24926108b770033792d015cb86aeffb3">Size</a> () const</td></tr>
<tr class="separator:a24926108b770033792d015cb86aeffb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c5fc5af6e649a82d169f61e4dab5e33"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a8c5fc5af6e649a82d169f61e4dab5e33">NumCycles</a> () const</td></tr>
<tr class="separator:a8c5fc5af6e649a82d169f61e4dab5e33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab601acb5aed920b1e61210d497462976"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; int &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#ab601acb5aed920b1e61210d497462976">Support</a> () const</td></tr>
<tr class="separator:ab601acb5aed920b1e61210d497462976"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af567b4e287e268eb9ecee908f63e5b64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structoperations__research_1_1SparsePermutation_1_1Iterator.html">Iterator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#af567b4e287e268eb9ecee908f63e5b64">Cycle</a> (int i) const</td></tr>
<tr class="separator:af567b4e287e268eb9ecee908f63e5b64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68c2934475b5f68d6d6b9b2fdfb9955d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a68c2934475b5f68d6d6b9b2fdfb9955d">LastElementInCycle</a> (int i) const</td></tr>
<tr class="separator:a68c2934475b5f68d6d6b9b2fdfb9955d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a540c5f44963a3f25d264f41b643e0f57"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a540c5f44963a3f25d264f41b643e0f57">AddToCurrentCycle</a> (int x)</td></tr>
<tr class="separator:a540c5f44963a3f25d264f41b643e0f57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a709f5ccee8651229a29a54b3c9e14681"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a709f5ccee8651229a29a54b3c9e14681">CloseCurrentCycle</a> ()</td></tr>
<tr class="separator:a709f5ccee8651229a29a54b3c9e14681"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9add43490c45e4334099bb15b6e6eab0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a9add43490c45e4334099bb15b6e6eab0">RemoveCycles</a> (const std::vector&lt; int &gt; &amp;cycle_indices)</td></tr>
<tr class="separator:a9add43490c45e4334099bb15b6e6eab0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a764be64f3029f8b8e23511061d8de355"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classoperations__research_1_1SparsePermutation.html#a764be64f3029f8b8e23511061d8de355">DebugString</a> () const</td></tr>
<tr class="separator:a764be64f3029f8b8e23511061d8de355"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1d5b283f6fa63b162d0dd2b58333ca19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d5b283f6fa63b162d0dd2b58333ca19">&#9670;&nbsp;</a></span>SparsePermutation()</h2>
<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="classoperations__research_1_1SparsePermutation.html">SparsePermutation</a> </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00029">29</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a540c5f44963a3f25d264f41b643e0f57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a540c5f44963a3f25d264f41b643e0f57">&#9670;&nbsp;</a></span>AddToCurrentCycle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void AddToCurrentCycle </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>x</em></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 class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00084">84</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<a id="a709f5ccee8651229a29a54b3c9e14681"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a709f5ccee8651229a29a54b3c9e14681">&#9670;&nbsp;</a></span>CloseCurrentCycle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CloseCurrentCycle </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 class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00090">90</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<a id="af567b4e287e268eb9ecee908f63e5b64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af567b4e287e268eb9ecee908f63e5b64">&#9670;&nbsp;</a></span>Cycle()</h2>
<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="structoperations__research_1_1SparsePermutation_1_1Iterator.html">SparsePermutation::Iterator</a> Cycle </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em></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">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00117">117</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<a id="a764be64f3029f8b8e23511061d8de355"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a764be64f3029f8b8e23511061d8de355">&#9670;&nbsp;</a></span>DebugString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string DebugString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8cc_source.html#l00052">52</a> of file <a class="el" href="sparse__permutation_8cc_source.html">sparse_permutation.cc</a>.</p>
</div>
</div>
<a id="a68c2934475b5f68d6d6b9b2fdfb9955d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68c2934475b5f68d6d6b9b2fdfb9955d">&#9670;&nbsp;</a></span>LastElementInCycle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int LastElementInCycle </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>i</em></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">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00124">124</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<a id="a8c5fc5af6e649a82d169f61e4dab5e33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c5fc5af6e649a82d169f61e4dab5e33">&#9670;&nbsp;</a></span>NumCycles()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int NumCycles </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">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00033">33</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<a id="a9add43490c45e4334099bb15b6e6eab0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9add43490c45e4334099bb15b6e6eab0">&#9670;&nbsp;</a></span>RemoveCycles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void RemoveCycles </td>
<td>(</td>
<td class="paramtype">const std::vector&lt; int &gt; &amp;&#160;</td>
<td class="paramname"><em>cycle_indices</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8cc_source.html#l00023">23</a> of file <a class="el" href="sparse__permutation_8cc_source.html">sparse_permutation.cc</a>.</p>
</div>
</div>
<a id="a24926108b770033792d015cb86aeffb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24926108b770033792d015cb86aeffb3">&#9670;&nbsp;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int 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> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00032">32</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<a id="ab601acb5aed920b1e61210d497462976"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab601acb5aed920b1e61210d497462976">&#9670;&nbsp;</a></span>Support()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt;int&gt;&amp; Support </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">
<p class="definition">Definition at line <a class="el" href="sparse__permutation_8h_source.html#l00037">37</a> of file <a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="sparse__permutation_8h_source.html">sparse_permutation.h</a></li>
<li><a class="el" href="sparse__permutation_8cc_source.html">sparse_permutation.cc</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceoperations__research.html">operations_research</a></li><li class="navelem"><a class="el" href="classoperations__research_1_1SparsePermutation.html">SparsePermutation</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.18 </li>
</ul>
</div>
</body>
</html>