Files
ortools-clone/docs/java/SolutionPool_8java_source.html
Laurent Perron 0ac3fa17eb more linear doc
2019-07-15 17:42:24 -07:00

56 lines
17 KiB
HTML

<!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>
<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"/>-->
<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">
<span id="sfml">OR-Tools 7.2</span>
</div>
</div>
<link rel="icon" href="https://developers.google.com/optimization/images/orLogo.png">
<div id="content">
<!-- 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>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<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">SolutionPool.java</div> </div>
</div><!--header-->
<div class="contents">
<a href="SolutionPool_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="l00014"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html"> 14</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_1SolutionPool.html">SolutionPool</a> <span class="keyword">extends</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1BaseObject.html">BaseObject</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keyword">private</span> <span class="keyword">transient</span> <span class="keywordtype">long</span> swigCPtr;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#ab8f469ca6c932d4cc135e46e59fd8e2e"> 17</a></span>&#160; <span class="keyword">protected</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#ab8f469ca6c932d4cc135e46e59fd8e2e">SolutionPool</a>(<span class="keywordtype">long</span> cPtr, <span class="keywordtype">boolean</span> cMemoryOwn) {</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; super(mainJNI.SolutionPool_SWIGUpcast(cPtr), cMemoryOwn);</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; swigCPtr = cPtr;</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"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keywordtype">long</span> getCPtr(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html">SolutionPool</a> obj) {</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> (obj == <span class="keyword">null</span>) ? 0 : obj.swigCPtr;</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; @SuppressWarnings(<span class="stringliteral">&quot;deprecation&quot;</span>)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; protected <span class="keywordtype">void</span> finalize() {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keyword">delete</span>();</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; }</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a84699fa53245a4a2cde152be0bc6f076"> 31</a></span>&#160; <span class="keyword">public</span> <span class="keyword">synchronized</span> <span class="keywordtype">void</span> <span class="keyword">delete</span>() {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keywordflow">if</span> (swigCPtr != 0) {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">if</span> (swigCMemOwn) {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; swigCMemOwn = <span class="keyword">false</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; mainJNI.delete_SolutionPool(swigCPtr);</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; swigCPtr = 0;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; super.delete();</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; }</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#ac26e9b7e1aa336ac6307102a6491e6d8"> 45</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#ac26e9b7e1aa336ac6307102a6491e6d8">initialize</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a> assignment) {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; mainJNI.SolutionPool_initialize(swigCPtr, <span class="keyword">this</span>, <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a>.getCPtr(assignment), assignment);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a832a7bc6b8411ea49522407ba45e0987"> 52</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a832a7bc6b8411ea49522407ba45e0987">registerNewSolution</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a> assignment) {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; mainJNI.SolutionPool_registerNewSolution(swigCPtr, <span class="keyword">this</span>, <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a>.getCPtr(assignment), assignment);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a916f07d35eec6654cf7cfcffdd7ffb20"> 59</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a916f07d35eec6654cf7cfcffdd7ffb20">getNextSolution</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a> assignment) {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; mainJNI.SolutionPool_getNextSolution(swigCPtr, <span class="keyword">this</span>, <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a>.getCPtr(assignment), assignment);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a6a3a0af4fae66d29ced18b6a6e53aa2c"> 66</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">boolean</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a6a3a0af4fae66d29ced18b6a6e53aa2c">syncNeeded</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a> local_assignment) {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> mainJNI.SolutionPool_syncNeeded(swigCPtr, <span class="keyword">this</span>, <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">Assignment</a>.getCPtr(local_assignment), local_assignment);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; }</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}</div><div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1BaseObject_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1BaseObject.html">com.google.ortools.constraintsolver.BaseObject</a></div><div class="ttdoc">A BaseObject is the root of all reversibly allocated objects.</div><div class="ttdef"><b>Definition:</b> <a href="BaseObject_8java_source.html#l00014">BaseObject.java:14</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool_html_ab8f469ca6c932d4cc135e46e59fd8e2e"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#ab8f469ca6c932d4cc135e46e59fd8e2e">com.google.ortools.constraintsolver.SolutionPool.SolutionPool</a></div><div class="ttdeci">SolutionPool(long cPtr, boolean cMemoryOwn)</div><div class="ttdef"><b>Definition:</b> <a href="SolutionPool_8java_source.html#l00017">SolutionPool.java:17</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool_html_a916f07d35eec6654cf7cfcffdd7ffb20"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a916f07d35eec6654cf7cfcffdd7ffb20">com.google.ortools.constraintsolver.SolutionPool.getNextSolution</a></div><div class="ttdeci">void getNextSolution(Assignment assignment)</div><div class="ttdoc">This method is called when the local search starts a new neighborhood to initialize the default assig...</div><div class="ttdef"><b>Definition:</b> <a href="SolutionPool_8java_source.html#l00059">SolutionPool.java:59</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool_html_a832a7bc6b8411ea49522407ba45e0987"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a832a7bc6b8411ea49522407ba45e0987">com.google.ortools.constraintsolver.SolutionPool.registerNewSolution</a></div><div class="ttdeci">void registerNewSolution(Assignment assignment)</div><div class="ttdoc">This method is called when a new solution has been accepted by the local search.</div><div class="ttdef"><b>Definition:</b> <a href="SolutionPool_8java_source.html#l00052">SolutionPool.java:52</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html">com.google.ortools.constraintsolver.SolutionPool</a></div><div class="ttdoc">This class is used to manage a pool of solutions.</div><div class="ttdef"><b>Definition:</b> <a href="SolutionPool_8java_source.html#l00014">SolutionPool.java:14</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Assignment.html">com.google.ortools.constraintsolver.Assignment</a></div><div class="ttdoc">An Assignment is a variable -&gt; domains mapping, used to report solutions to the user.</div><div class="ttdef"><b>Definition:</b> <a href="Assignment_8java_source.html#l00014">Assignment.java:14</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool_html_ac26e9b7e1aa336ac6307102a6491e6d8"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#ac26e9b7e1aa336ac6307102a6491e6d8">com.google.ortools.constraintsolver.SolutionPool.initialize</a></div><div class="ttdeci">void initialize(Assignment assignment)</div><div class="ttdoc">This method is called to initialize the solution pool with the assignment from the local search.</div><div class="ttdef"><b>Definition:</b> <a href="SolutionPool_8java_source.html#l00045">SolutionPool.java:45</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool_html_a6a3a0af4fae66d29ced18b6a6e53aa2c"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1SolutionPool.html#a6a3a0af4fae66d29ced18b6a6e53aa2c">com.google.ortools.constraintsolver.SolutionPool.syncNeeded</a></div><div class="ttdeci">boolean syncNeeded(Assignment local_assignment)</div><div class="ttdoc">This method checks if the local solution needs to be updated with an external one.</div><div class="ttdef"><b>Definition:</b> <a href="SolutionPool_8java_source.html#l00066">SolutionPool.java:66</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>