Files
ortools-clone/docs/java/PathOperator_8java_source.html

112 lines
33 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2019-06-13 02:45:44 +02:00
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>OR-Tools</title>
<meta http-equiv="Content-Type" content="text/html;"/>
<meta charset="utf-8"/>
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
2019-06-20 23:19:36 +02:00
<link rel="stylesheet" type="text/css" href="ortools.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
</head>
<body>
<div id="banner-container">
<div id="banner">
2019-08-07 18:01:08 -07:00
<span id="sfml">OR-Tools 7.3</span>
</div>
</div>
2019-06-26 12:16:47 +02:00
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
2019-08-07 18:01:08 -07:00
<div id="content" style="width: 100%; overflow: hidden;">
<div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
<h2>Reference</h2>
<h3>C++</h3>
<ul>
<li><a href="../cpp_algorithms/annotated.html">Algorithms</a></li>
<li><a href="../cpp_graph/annotated.html">Graph</a></li>
<li><a href="../cpp_routing/annotated.html">Routing</a></li>
<li><a href="../cpp_linear/annotated.html">Linear solver</a></li>
<li><a href="../cpp_sat/annotated.html">CP-SAT</a></li>
</ul>
<h3>Python</h3>
<ul>
<li><a href="../python/ortools/sat/python/cp_model.html">CP-SAT</a></li>
<li><a href="../python/ortools/util/sorted_interval_list.html">Domain</a></li>
<li><a href="../python/ortools/graph/pywrapgraph.html">Graph</a></li>
<li><a href="../python/ortools/algorithms/pywrapknapsack_solver.html">Knapsack solver</a></li>
<li><a href="../python/ortools/linear_solver/pywraplp.html">Linear solver</a></li>
<li><a href="../python/ortools/constraint_solver/pywrapcp.html">Routing</a></li>
</ul>
<h3 id="dotnet-documentation">DotNET</h3>
<ul>
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Sat.html">CP-SAT</a></li>
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Graph.html">Graph</a></li>
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Algorithms.html">Knapsack solver</a></li>
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1LinearSolver.html">Linear solver</a></li>
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1ConstraintSolver.html">Routing</a></li>
<li><a href="../dotnet/namespaceGoogle_1_1OrTools_1_1Util.html">Util</a></li>
</ul>
<h3 id="java-documentation">Java Documentation</h3>
<ul>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1sat.html">CP-SAT</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1graph.html">Graph</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1algorithms.html">Knapsack solver</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1linearsolver.html">Linear solver</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1constraintsolver.html">Routing</a></li>
<li><a href="../java/namespacecom_1_1google_1_1ortools_1_1util.html">Util</a></li>
</ul>
</div>
<div id="content">
2019-08-07 18:01:08 -07:00
<div align="center">
<h1 style="color: #145A32;">Java Reference</h1>
</div>
2019-06-13 02:45:44 +02:00
<!-- Generated by Doxygen 1.8.15 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
2019-07-15 17:42:24 -07:00
<li class="current"><a href="files.html"><span>Files</span></a></li>
2019-06-13 02:45:44 +02:00
</ul>
</div>
2019-08-07 18:01:08 -07:00
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
</ul>
</div>
2019-06-13 02:45:44 +02:00
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a7cc1eeded8f693d0da6c729bc88c45a.html">ortools</a></li><li class="navelem"><a class="el" href="dir_b2c6d49957bf5d0c7726edb4b829cd4d.html">gen</a></li><li class="navelem"><a class="el" href="dir_82da1734a9cb0f1cf40dbd95c2117ce5.html">com</a></li><li class="navelem"><a class="el" href="dir_1713cbfcde5229f242ac28be432e77c9.html">google</a></li><li class="navelem"><a class="el" href="dir_06c320066273db25e45ae140036401c9.html">ortools</a></li><li class="navelem"><a class="el" href="dir_81253d67c190c9baa2240dffd7ee8180.html">constraintsolver</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">PathOperator.java</div> </div>
</div><!--header-->
<div class="contents">
2019-08-07 18:01:08 -07:00
<a href="PathOperator_8java.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* ----------------------------------------------------------------------------</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * This file was automatically generated by SWIG (http://www.swig.org).</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Version 4.0.0</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Do not make changes to this file unless you know what you are doing--modify</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * the SWIG interface file instead.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * ----------------------------------------------------------------------------- */</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="keyword">package </span>com.google.ortools.constraintsolver;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// Used to wrap start_empty_path_class see:</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// https://docs.oracle.com/javase/8/docs/api/java/util/function/LongToIntFunction.html</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="keyword">import</span> java.util.function.LongToIntFunction;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html"> 18</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html">PathOperator</a> <span class="keyword">extends</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1IntVarLocalSearchOperator.html">IntVarLocalSearchOperator</a> {</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; <span class="keyword">private</span> <span class="keyword">transient</span> <span class="keywordtype">long</span> swigCPtr;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#aaf55dba7b4ac22f74b69090cab958ad3"> 21</a></span>&#160; <span class="keyword">protected</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#aaf55dba7b4ac22f74b69090cab958ad3">PathOperator</a>(<span class="keywordtype">long</span> cPtr, <span class="keywordtype">boolean</span> cMemoryOwn) {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; super(mainJNI.PathOperator_SWIGUpcast(cPtr), cMemoryOwn);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; swigCPtr = cPtr;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; }</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">protected</span> <span class="keyword">static</span> <span class="ke
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_a5c7b8f832b0c6e82657c41e87505b04d"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#a5c7b8f832b0c6e82657c41e87505b04d">com.google.ortools.constraintsolver.PathOperator.setNextBaseToIncrement</a></div><div class="ttdeci">void setNextBaseToIncrement(long base_index)</div><div class="ttdoc">Set the next base to increment on next iteration.</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00108">PathOperator.java:108</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_adcb8fbaa301064bd4b7b76626e381051"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#adcb8fbaa301064bd4b7b76626e381051">com.google.ortools.constraintsolver.PathOperator.PathOperator</a></div><div class="ttdeci">PathOperator(IntVar[] next_vars, IntVar[] path_vars, int number_of_base_nodes, boolean skip_locally_optimal_paths, LongToIntFunction start_empty_path_class)</div><div class="ttdoc">Builds an instance of PathOperator from next and path variables.</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00064">PathOperator.java:64</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_ad20897c5c8bd47f5d4005989bead0e55"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#ad20897c5c8bd47f5d4005989bead0e55">com.google.ortools.constraintsolver.PathOperator.reset</a></div><div class="ttdeci">void reset()</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00073">PathOperator.java:73</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_a3e123bf6148bbedeedc2e37f90c0276a"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#a3e123bf6148bbedeedc2e37f90c0276a">com.google.ortools.constraintsolver.PathOperator.neighbor</a></div><div class="ttdeci">boolean neighbor()</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00069">PathOperator.java:69</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1IntVar_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1IntVar.html">com.google.ortools.constraintsolver.IntVar</a></div><div class="ttdoc">The class IntVar is a subset of IntExpr.</div><div class="ttdef"><b>Definition:</b> <a href="gen_2com_2google_2ortools_2constraintsolver_2IntVar_8java_source.html#l00014">gen/com/google/ortools/constraintsolver/IntVar.java:14</a></div></div>
2019-08-07 18:01:08 -07:00
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_ad4b835b84e76e8d03a518291271069a9"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#ad4b835b84e76e8d03a518291271069a9">com.google.ortools.constraintsolver.PathOperator.swigTakeOwnership</a></div><div class="ttdeci">void swigTakeOwnership()</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00056">PathOperator.java:56</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html">com.google.ortools.constraintsolver.PathOperator</a></div><div class="ttdoc">Base class of the local search operators dedicated to path modifications (a path is a set of nodes li...</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00018">PathOperator.java:18</a></div></div>
2019-08-07 18:01:08 -07:00
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_abe8cec8d600000d8f1b8102b211bd515"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#abe8cec8d600000d8f1b8102b211bd515">com.google.ortools.constraintsolver.PathOperator.onSamePathAsPreviousBase</a></div><div class="ttdeci">boolean onSamePathAsPreviousBase(long base_index)</div><div class="ttdoc">Returns true if a base node has to be on the same path as the &quot;previous&quot; base node (base node of inde...</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00094">PathOperator.java:94</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_ab7a5cc37854f767daadf2daafc2c10a3"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#ab7a5cc37854f767daadf2daafc2c10a3">com.google.ortools.constraintsolver.PathOperator.restartAtPathStartOnSynchronize</a></div><div class="ttdeci">boolean restartAtPathStartOnSynchronize()</div><div class="ttdoc">When the operator is being synchronized with a new solution (when Start() is called),...</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00087">PathOperator.java:87</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_a71489e94aa126da236972db0ade7229a"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#a71489e94aa126da236972db0ade7229a">com.google.ortools.constraintsolver.PathOperator.swigReleaseOwnership</a></div><div class="ttdeci">void swigReleaseOwnership()</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00051">PathOperator.java:51</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_a1b7b0a1b4685cf9adf5ee381f34466d4"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#a1b7b0a1b4685cf9adf5ee381f34466d4">com.google.ortools.constraintsolver.PathOperator.getBaseNodeRestartPosition</a></div><div class="ttdeci">long getBaseNodeRestartPosition(int base_index)</div><div class="ttdoc">Returns the index of the node to which the base node of index base_index must be set to when it reach...</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00101">PathOperator.java:101</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_ae1dc5ccf59b73a81503ce4b440e42ef6"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#ae1dc5ccf59b73a81503ce4b440e42ef6">com.google.ortools.constraintsolver.PathOperator.initPosition</a></div><div class="ttdeci">boolean initPosition()</div><div class="ttdoc">Returns true if operator needs to restart its initial position at each call to Start()</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00115">PathOperator.java:115</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_ad4f30c46352bd8e3993b58253f151ea1"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#ad4f30c46352bd8e3993b58253f151ea1">com.google.ortools.constraintsolver.PathOperator.oneNeighbor</a></div><div class="ttdeci">boolean oneNeighbor()</div><div class="ttdoc">This method should not be overridden.</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00080">PathOperator.java:80</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator_html_aeb590aba470ae6ec1e69cdad7bb5961c"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1PathOperator.html#aeb590aba470ae6ec1e69cdad7bb5961c">com.google.ortools.constraintsolver.PathOperator.swigDirectorDisconnect</a></div><div class="ttdeci">void swigDirectorDisconnect()</div><div class="ttdef"><b>Definition:</b> <a href="PathOperator_8java_source.html#l00046">PathOperator.java:46</a></div></div>
2019-07-05 09:33:19 +02:00
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1IntVarLocalSearchOperator_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1IntVarLocalSearchOperator.html">com.google.ortools.constraintsolver.IntVarLocalSearchOperator</a></div><div class="ttdef"><b>Definition:</b> <a href="IntVarLocalSearchOperator_8java_source.html#l00011">IntVarLocalSearchOperator.java:11</a></div></div>
2019-06-13 02:45:44 +02:00
</div><!-- fragment --></div><!-- contents -->
2019-08-07 18:01:08 -07:00
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
2019-06-13 02:45:44 +02:00
</html>