JavaDecisionBuilder_8java_source.html 13 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
<!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">Google OR-Tools 7.7</span>
            </div>
        </div>
        <div id="content" style="width: 100%; overflow: hidden;">
        <div style="margin-left: 15px; margin-top: 5px; float: left; color: #145A32;">
        <h2>Java Reference</h2>
        <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">
            <div align="center">
                <h1 style="color: #145A32;">Java Reference</h1>
            </div>
<!-- Generated by Doxygen 1.8.18 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <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_fd73d91b70701748781c9404941baa63.html">java</a></li><li class="navelem"><a class="el" href="dir_a564db54e4252fbd4e4cd0fe58816985.html">com</a></li><li class="navelem"><a class="el" href="dir_265fd14d4e9a0ce57ad38de5d64bb540.html">google</a></li><li class="navelem"><a class="el" href="dir_a1e24e541e9f26a83a2ba9a841f0bcf8.html">ortools</a></li><li class="navelem"><a class="el" href="dir_a515ab52e7d6f77ddc8659140a08db8f.html">constraintsolver</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">JavaDecisionBuilder.java</div>  </div>
</div><!--header-->
<div class="contents">
<a href="JavaDecisionBuilder_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">package </span>com.google.ortools.constraintsolver;</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html">   23</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_1JavaDecisionBuilder.html">JavaDecisionBuilder</a> <span class="keyword">extends</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1DecisionBuilder.html">DecisionBuilder</a> {</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a9ba50a5579516d79c417ba082fffee37">   27</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">final</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Decision.html">Decision</a> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a9ba50a5579516d79c417ba082fffee37">nextWrap</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html">Solver</a> solver) {</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    <span class="keywordflow">try</span> {</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;      <span class="keywordflow">return</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a8a2ee0ed3eb910ed40adc7d3928c9c93">next</a>(solver);</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    } <span class="keywordflow">catch</span> (<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html">Solver</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver_1_1FailException.html">FailException</a> e) {</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;      <span class="keywordflow">return</span> solver.<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html#a064c1e51e76edc2017d336e7c5bf2a9d">makeFailDecision</a>();</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    }</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;  }</div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a8a2ee0ed3eb910ed40adc7d3928c9c93">   37</a></span>&#160;  <span class="keyword">public</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Decision.html">Decision</a> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a8a2ee0ed3eb910ed40adc7d3928c9c93">next</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html">Solver</a> solver) <span class="keywordflow">throws</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html">Solver</a>.<a class="code" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver_1_1FailException.html">FailException</a> {</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    <span class="keywordflow">return</span> <span class="keyword">null</span>;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  }</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder_html_a8a2ee0ed3eb910ed40adc7d3928c9c93"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a8a2ee0ed3eb910ed40adc7d3928c9c93">com.google.ortools.constraintsolver.JavaDecisionBuilder.next</a></div><div class="ttdeci">Decision next(Solver solver)</div><div class="ttdoc">This is the new method to subclass when defining a java decision builder.</div><div class="ttdef"><b>Definition:</b> <a href="JavaDecisionBuilder_8java_source.html#l00037">JavaDecisionBuilder.java:37</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder_html_a9ba50a5579516d79c417ba082fffee37"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a9ba50a5579516d79c417ba082fffee37">com.google.ortools.constraintsolver.JavaDecisionBuilder.nextWrap</a></div><div class="ttdeci">final Decision nextWrap(Solver solver)</div><div class="ttdoc">This methods wraps the calls to next() and catches fail exceptions.</div><div class="ttdef"><b>Definition:</b> <a href="JavaDecisionBuilder_8java_source.html#l00027">JavaDecisionBuilder.java:27</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver_html_a064c1e51e76edc2017d336e7c5bf2a9d"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html#a064c1e51e76edc2017d336e7c5bf2a9d">com.google.ortools.constraintsolver.Solver.makeFailDecision</a></div><div class="ttdeci">Decision makeFailDecision()</div><div class="ttdef"><b>Definition:</b> <a href="Solver_8java_source.html#l02476">Solver.java:2476</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1DecisionBuilder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1DecisionBuilder.html">com.google.ortools.constraintsolver.DecisionBuilder</a></div><div class="ttdoc">A DecisionBuilder is responsible for creating the search tree.</div><div class="ttdef"><b>Definition:</b> <a href="DecisionBuilder_8java_source.html#l00014">DecisionBuilder.java:14</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver_1_1FailException_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver_1_1FailException.html">com.google.ortools.constraintsolver.Solver.FailException</a></div><div class="ttdoc">This exceptions signal that a failure has been raised in the C++ world.</div><div class="ttdef"><b>Definition:</b> <a href="Solver_8java_source.html#l00088">Solver.java:88</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1Decision_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Decision.html">com.google.ortools.constraintsolver.Decision</a></div><div class="ttdoc">A Decision represents a choice point in the search tree.</div><div class="ttdef"><b>Definition:</b> <a href="Decision_8java_source.html#l00014">Decision.java:14</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html">com.google.ortools.constraintsolver.JavaDecisionBuilder</a></div><div class="ttdoc">This class acts as a intermediate step between a c++ decision builder and a java one.</div><div class="ttdef"><b>Definition:</b> <a href="JavaDecisionBuilder_8java_source.html#l00023">JavaDecisionBuilder.java:23</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1Solver.html">com.google.ortools.constraintsolver.Solver</a></div><div class="ttdoc">Solver Class A solver represents the main computation engine.</div><div class="ttdef"><b>Definition:</b> <a href="Solver_8java_source.html#l00057">Solver.java:57</a></div></div>
        </div>
        </div>
        <div id="footer-container">
            <div id="footer">
            </div>
        </div>
    </body>
</html>