Files
ortools-clone/docs/java/JavaDecisionBuilder_8java_source.html
2021-09-20 15:57:27 +02:00

105 lines
14 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"/>-->
<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="styleSheet.tmp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">Google OR-Tools 9.1</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.15 -->
<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('JavaDecisionBuilder_8java_source.html','');});
/* @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="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-2021 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="l00025"></a><span class="lineno"> 25</span>&#160; @Override</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a9ba50a5579516d79c417ba082fffee37"> 26</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="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keywordflow">try</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</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="l00029"></a><span class="lineno"> 29</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="l00030"></a><span class="lineno"> 30</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="l00031"></a><span class="lineno"> 31</span>&#160; }</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; }</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html#a8a2ee0ed3eb910ed40adc7d3928c9c93"> 36</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="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordflow">return</span> <span class="keyword">null</span>;</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;}</div><div class="ttc" id="classcom_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#l02504">Solver.java:2504</a></div></div>
<div class="ttc" id="classcom_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 class="ttc" id="classcom_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="classcom_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="classcom_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#l00036">JavaDecisionBuilder.java:36</a></div></div>
<div class="ttc" id="classcom_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="classcom_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="classcom_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#l00026">JavaDecisionBuilder.java:26</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div>
</div>
<div id="footer-container">
<div id="footer">
</div>
</div>
</body>
</html>