Files
ortools-clone/docs/java/StopAfterNSolutionsSampleSat_8java_source.html
Laurent Perron b95e6bb4d6 build java doc
2019-06-13 02:45:44 +02:00

77 lines
20 KiB
HTML

<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OR-Tools: StopAfterNSolutionsSampleSat.java 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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="ortools.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">OR-Tools
&#160;<span id="projectnumber">7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- 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="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</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_dddac007a45022d9da6ea1dee012c3b9.html">sat</a></li><li class="navelem"><a class="el" href="dir_8005d2da67a7154daa1c0c8b69782d62.html">samples</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">StopAfterNSolutionsSampleSat.java</div> </div>
</div><!--header-->
<div class="contents">
<a href="StopAfterNSolutionsSampleSat_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">// Copyright 2010-2018 Google LLC</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">//</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</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;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">// limitations under the License.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.<a class="code" href="namespacecom_1_1google.html">google</a>.<a class="code" href="namespacecom_1_1google_1_1ortools.html">ortools</a>.<a class="code" href="namespacecom_1_1google_1_1ortools_1_1sat.html">sat</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html">CpModel</a>;</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.<a class="code" href="namespacecom_1_1google.html">google</a>.<a class="code" href="namespacecom_1_1google_1_1ortools.html">ortools</a>.<a class="code" href="namespacecom_1_1google_1_1ortools_1_1sat.html">sat</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html">CpSolver</a>;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.<a class="code" href="namespacecom_1_1google.html">google</a>.<a class="code" href="namespacecom_1_1google_1_1ortools.html">ortools</a>.<a class="code" href="namespacecom_1_1google_1_1ortools_1_1sat.html">sat</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html">CpSolverSolutionCallback</a>;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="keyword">import</span> <a class="code" href="namespacecom.html">com</a>.<a class="code" href="namespacecom_1_1google.html">google</a>.<a class="code" href="namespacecom_1_1google_1_1ortools.html">ortools</a>.<a class="code" href="namespacecom_1_1google_1_1ortools_1_1sat.html">sat</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="classStopAfterNSolutionsSampleSat.html"> 20</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classStopAfterNSolutionsSampleSat.html">StopAfterNSolutionsSampleSat</a> {</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; <span class="keyword">static</span> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; System.loadLibrary(<span class="stringliteral">&quot;jniortools&quot;</span>);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; }</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; <span class="keyword">static</span> <span class="keyword">class </span>VarArraySolutionPrinterWithLimit <span class="keyword">extends</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html">CpSolverSolutionCallback</a> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keyword">public</span> VarArraySolutionPrinterWithLimit(<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>[] variables, <span class="keywordtype">int</span> limit) {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; variableArray = variables;</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; solutionLimit = limit;</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"> 31</span>&#160; @Override</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">public</span> <span class="keywordtype">void</span> onSolutionCallback() {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; System.out.printf(<span class="stringliteral">&quot;Solution #%d: time = %.02f s%n&quot;</span>, solutionCount, wallTime());</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordflow">for</span> (<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a> v : variableArray) {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; System.out.printf(<span class="stringliteral">&quot; %s = %d%n&quot;</span>, v.getName(), value(v));</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; solutionCount++;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keywordflow">if</span> (solutionCount &gt;= solutionLimit) {</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; System.out.printf(<span class="stringliteral">&quot;Stop search after %d solutions%n&quot;</span>, solutionLimit);</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; stopSearch();</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; }</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; }</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">public</span> <span class="keywordtype">int</span> getSolutionCount() {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> solutionCount;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; }</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; <span class="keyword">private</span> <span class="keywordtype">int</span> solutionCount;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">private</span> <span class="keyword">final</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>[] variableArray;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">private</span> <span class="keyword">final</span> <span class="keywordtype">int</span> solutionLimit;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; }</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classStopAfterNSolutionsSampleSat.html#a8e39fb60ce7dd8044f57713d7db1adc3"> 53</a></span>&#160; <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classStopAfterNSolutionsSampleSat.html#a8e39fb60ce7dd8044f57713d7db1adc3">main</a>(String[] args) <span class="keywordflow">throws</span> Exception {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="comment">// Create the model.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html">CpModel</a> model = <span class="keyword">new</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html">CpModel</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="comment">// Create the variables.</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">int</span> numVals = 3;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a> x = model.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a78e6aa0bcdec9be8fc0d39c46b94d851">newIntVar</a>(0, numVals - 1, <span class="stringliteral">&quot;x&quot;</span>);</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a> y = model.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a78e6aa0bcdec9be8fc0d39c46b94d851">newIntVar</a>(0, numVals - 1, <span class="stringliteral">&quot;y&quot;</span>);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a> z = model.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a78e6aa0bcdec9be8fc0d39c46b94d851">newIntVar</a>(0, numVals - 1, <span class="stringliteral">&quot;z&quot;</span>);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">// Create a solver and solve the model.</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html">CpSolver</a> solver = <span class="keyword">new</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html">CpSolver</a>();</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; VarArraySolutionPrinterWithLimit cb =</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keyword">new</span> VarArraySolutionPrinterWithLimit(<span class="keyword">new</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a>[] {x, y, z}, 5);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; solver.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html#ad64fabf13468253f9f080e4eeb1d3655">searchAllSolutions</a>(model, cb);</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; System.out.println(cb.getSolutionCount() + <span class="stringliteral">&quot; solutions found.&quot;</span>);</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">if</span> (cb.getSolutionCount() != 5) {</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="keywordflow">throw</span> <span class="keyword">new</span> RuntimeException(<span class="stringliteral">&quot;Did not stop the search correctly.&quot;</span>);</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; }</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;}</div><div class="ttc" id="namespacecom_1_1google_1_1ortools_1_1sat_html"><div class="ttname"><a href="namespacecom_1_1google_1_1ortools_1_1sat.html">com.google.ortools.sat</a></div><div class="ttdef"><b>Definition:</b> <a href="AllDifferentConstraintProto_8java_source.html#l00004">AllDifferentConstraintProto.java:4</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html">com.google.ortools.sat.CpSolver</a></div><div class="ttdoc">Wrapper around the SAT solver.</div><div class="ttdef"><b>Definition:</b> <a href="CpSolver_8java_source.html#l00026">CpSolver.java:26</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a78e6aa0bcdec9be8fc0d39c46b94d851"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a78e6aa0bcdec9be8fc0d39c46b94d851">com.google.ortools.sat.CpModel.newIntVar</a></div><div class="ttdeci">IntVar newIntVar(long lb, long ub, String name)</div><div class="ttdoc">Creates an integer variable with domain [lb, ub].</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00069">CpModel.java:69</a></div></div>
<div class="ttc" id="classStopAfterNSolutionsSampleSat_html"><div class="ttname"><a href="classStopAfterNSolutionsSampleSat.html">StopAfterNSolutionsSampleSat</a></div><div class="ttdoc">Code sample that solves a model and displays a small number of solutions.</div><div class="ttdef"><b>Definition:</b> <a href="StopAfterNSolutionsSampleSat_8java_source.html#l00020">StopAfterNSolutionsSampleSat.java:20</a></div></div>
<div class="ttc" id="namespacecom_html"><div class="ttname"><a href="namespacecom.html">com</a></div></div>
<div class="ttc" id="namespacecom_1_1google_1_1ortools_html"><div class="ttname"><a href="namespacecom_1_1google_1_1ortools.html">com.google.ortools</a></div></div>
<div class="ttc" id="classStopAfterNSolutionsSampleSat_html_a8e39fb60ce7dd8044f57713d7db1adc3"><div class="ttname"><a href="classStopAfterNSolutionsSampleSat.html#a8e39fb60ce7dd8044f57713d7db1adc3">StopAfterNSolutionsSampleSat.main</a></div><div class="ttdeci">static void main(String[] args)</div><div class="ttdef"><b>Definition:</b> <a href="StopAfterNSolutionsSampleSat_8java_source.html#l00053">StopAfterNSolutionsSampleSat.java:53</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">com.google.ortools.sat.IntVar</a></div><div class="ttdoc">An integer variable.</div><div class="ttdef"><b>Definition:</b> <a href="com_2google_2ortools_2sat_2IntVar_8java_source.html#l00021">com/google/ortools/sat/IntVar.java:21</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html">com.google.ortools.sat.CpModel</a></div><div class="ttdoc">Main modeling class.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00040">CpModel.java:40</a></div></div>
<div class="ttc" id="namespacecom_1_1google_html"><div class="ttname"><a href="namespacecom_1_1google.html">com.google</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver_html_ad64fabf13468253f9f080e4eeb1d3655"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html#ad64fabf13468253f9f080e4eeb1d3655">com.google.ortools.sat.CpSolver.searchAllSolutions</a></div><div class="ttdeci">CpSolverStatus searchAllSolutions(CpModel model, CpSolverSolutionCallback cb)</div><div class="ttdoc">Searches for all solutions of a satisfiability problem.</div><div class="ttdef"><b>Definition:</b> <a href="CpSolver_8java_source.html#l00057">CpSolver.java:57</a></div></div>
<div class="ttc" id="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html">com.google.ortools.sat.CpSolverSolutionCallback</a></div><div class="ttdoc">Parent class to create a callback called at each solution.</div><div class="ttdef"><b>Definition:</b> <a href="CpSolverSolutionCallback_8java_source.html#l00039">CpSolverSolutionCallback.java:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>