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

136 lines
15 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"/>-->
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
2020-09-01 16:00:33 +02:00
<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">
2020-11-18 14:53:30 +01:00
<span id="sfml">Google OR-Tools 8.1</span>
</div>
</div>
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;">
2019-08-12 09:16:03 -07:00
<h2>Java Reference</h2>
2019-08-07 18:01:08 -07:00
<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>
2020-10-09 12:00:09 +02:00
<!-- Generated by Doxygen 1.8.20 -->
2020-09-01 16:00:33 +02:00
<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">
2019-06-13 02:45:44 +02:00
</div>
</div>
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('CpSolverSolutionCallback_8java_source.html',''); initResizable(); });
/* @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>
2019-06-13 02:45:44 +02:00
<div class="header">
<div class="headertitle">
<div class="title">CpSolverSolutionCallback.java</div> </div>
</div><!--header-->
<div class="contents">
2019-11-14 13:52:51 -08:00
<a href="CpSolverSolutionCallback_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.sat;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
2020-01-31 17:05:16 +01:00
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html"> 39</a></span>&#160;<span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html">CpSolverSolutionCallback</a> <span class="keyword">extends</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback.html">SolutionCallback</a> {</div>
2019-11-14 13:52:51 -08:00
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#a61e7d175c0ca4cd5a12965af3fe358c4"> 41</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">long</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#a61e7d175c0ca4cd5a12965af3fe358c4">value</a>(<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html">IntVar</a> var) {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keywordtype">int</span> index = var.<a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>();</div>
2020-01-31 17:05:16 +01:00
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback.html#a3d16eb05922bf42e541c5cc331679ef1">solutionIntegerValue</a>(index);</div>
2019-11-14 13:52:51 -08:00
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#af090e0f2ac5bdfda82b62d7541e5fe86"> 47</a></span>&#160; <span class="keyword">public</span> Boolean <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#af090e0f2ac5bdfda82b62d7541e5fe86">booleanValue</a>(<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">Literal</a> literal) {</div>
2020-01-31 17:05:16 +01:00
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback.html#a50aaa4b1d065156a10cdf6689d6f141f">solutionBooleanValue</a>(literal.<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>());</div>
2019-11-14 13:52:51 -08:00
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; @Override</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#a4cb3ffdfd02cc63f767833ed23e89c81"> 53</a></span>&#160; <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#a4cb3ffdfd02cc63f767833ed23e89c81">onSolutionCallback</a>() {}</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;}</div>
2019-06-13 02:45:44 +02:00
</div><!-- fragment --></div><!-- contents -->
2020-09-01 16:00:33 +02:00
</div><!-- doc-content -->
2019-11-14 13:52:51 -08:00
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback_html_a61e7d175c0ca4cd5a12965af3fe358c4"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#a61e7d175c0ca4cd5a12965af3fe358c4">com.google.ortools.sat.CpSolverSolutionCallback.value</a></div><div class="ttdeci">long value(IntVar var)</div><div class="ttdoc">Returns the value of the variable in the current solution.</div><div class="ttdef"><b>Definition:</b> <a href="CpSolverSolutionCallback_8java_source.html#l00041">CpSolverSolutionCallback.java:41</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback_html_a4cb3ffdfd02cc63f767833ed23e89c81"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#a4cb3ffdfd02cc63f767833ed23e89c81">com.google.ortools.sat.CpSolverSolutionCallback.onSolutionCallback</a></div><div class="ttdeci">void onSolutionCallback()</div><div class="ttdoc">Callback method to override.</div><div class="ttdef"><b>Definition:</b> <a href="CpSolverSolutionCallback_8java_source.html#l00053">CpSolverSolutionCallback.java:53</a></div></div>
2020-01-31 17:05:16 +01:00
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback_html_a3d16eb05922bf42e541c5cc331679ef1"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback.html#a3d16eb05922bf42e541c5cc331679ef1">com.google.ortools.sat.SolutionCallback.solutionIntegerValue</a></div><div class="ttdeci">long solutionIntegerValue(int index)</div><div class="ttdef"><b>Definition:</b> <a href="SolutionCallback_8java_source.html#l00094">SolutionCallback.java:94</a></div></div>
2019-11-14 13:52:51 -08:00
<div class="ttc" id="aclasscom_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 class="ttc" id="ainterfacecom_1_1google_1_1ortools_1_1sat_1_1Literal_html"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html">com.google.ortools.sat.Literal</a></div><div class="ttdoc">Interface to describe a boolean variable or its negation.</div><div class="ttdef"><b>Definition:</b> <a href="Literal_8java_source.html#l00017">Literal.java:17</a></div></div>
2020-01-31 17:05:16 +01:00
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback.html">com.google.ortools.sat.SolutionCallback</a></div><div class="ttdef"><b>Definition:</b> <a href="SolutionCallback_8java_source.html#l00011">SolutionCallback.java:11</a></div></div>
2019-11-14 13:52:51 -08:00
<div class="ttc" id="ainterfacecom_1_1google_1_1ortools_1_1sat_1_1Literal_html_a59d053c950ff1e9f8a004d493f34e754"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">com.google.ortools.sat.Literal.getIndex</a></div><div class="ttdeci">int getIndex()</div></div>
2020-01-31 17:05:16 +01:00
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1IntVar_html_a59d053c950ff1e9f8a004d493f34e754"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html#a59d053c950ff1e9f8a004d493f34e754">com.google.ortools.sat.IntVar.getIndex</a></div><div class="ttdeci">int getIndex()</div><div class="ttdoc">Internal, returns the index of the variable in the underlying CpModelProto.</div><div class="ttdef"><b>Definition:</b> <a href="java_2com_2google_2ortools_2sat_2IntVar_8java_source.html#l00045">java/com/google/ortools/sat/IntVar.java:45</a></div></div>
<div class="ttc" id="aclasscom_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="java_2com_2google_2ortools_2sat_2IntVar_8java_source.html#l00021">java/com/google/ortools/sat/IntVar.java:21</a></div></div>
2019-11-14 13:52:51 -08:00
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback_html_af090e0f2ac5bdfda82b62d7541e5fe86"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html#af090e0f2ac5bdfda82b62d7541e5fe86">com.google.ortools.sat.CpSolverSolutionCallback.booleanValue</a></div><div class="ttdeci">Boolean booleanValue(Literal literal)</div><div class="ttdoc">Returns the Boolean value of the literal in the current solution.</div><div class="ttdef"><b>Definition:</b> <a href="CpSolverSolutionCallback_8java_source.html#l00047">CpSolverSolutionCallback.java:47</a></div></div>
2020-01-31 17:05:16 +01:00
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback_html_a50aaa4b1d065156a10cdf6689d6f141f"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SolutionCallback.html#a50aaa4b1d065156a10cdf6689d6f141f">com.google.ortools.sat.SolutionCallback.solutionBooleanValue</a></div><div class="ttdeci">boolean solutionBooleanValue(int index)</div><div class="ttdef"><b>Definition:</b> <a href="SolutionCallback_8java_source.html#l00098">SolutionCallback.java:98</a></div></div>
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>