Update java doc

This commit is contained in:
Corentin Le Molgat
2020-01-31 17:05:16 +01:00
parent 659db10ccc
commit 5d6b4560e8
1196 changed files with 264393 additions and 29125 deletions

View File

@@ -12,7 +12,7 @@
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">Google OR-Tools 7.4</span>
<span id="sfml">Google OR-Tools 7.5</span>
</div>
</div>
<div id="content" style="width: 100%; overflow: hidden;">
@@ -31,7 +31,7 @@
<div align="center">
<h1 style="color: #145A32;">Java Reference</h1>
</div>
<!-- Generated by Doxygen 1.8.16 -->
<!-- Generated by Doxygen 1.8.18 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
@@ -41,7 +41,7 @@
</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_ed7866a075c77e634cb451a432014e49.html">com</a></li><li class="navelem"><a class="el" href="dir_ed93e231cce03906e5c9f1a0e4259679.html">google</a></li><li class="navelem"><a class="el" href="dir_e79f93676144f0f6b8f1180b80d43c5b.html">ortools</a></li><li class="navelem"><a class="el" href="dir_e5ee533e9c8def55a36155ecb53c6410.html">sat</a></li> </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_0070805acb68ef04688e7c31a1e72654.html">sat</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
@@ -64,14 +64,14 @@
<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>
<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> SolutionCallback {</div>
<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>
<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>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> solutionIntegerValue(index);</div>
<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>
<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>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keywordflow">return</span> solutionBooleanValue(literal.<a class="code" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a59d053c950ff1e9f8a004d493f34e754">getIndex</a>());</div>
<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>
<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>
@@ -80,12 +80,15 @@
</div><!-- fragment --></div><!-- contents -->
<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>
<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>
<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>
<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>
<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>
<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="com_2google_2ortools_2sat_2IntVar_8java_source.html#l00045">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="com_2google_2ortools_2sat_2IntVar_8java_source.html#l00021">com/google/ortools/sat/IntVar.java:21</a></div></div>
<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>
<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>
<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>
</div>
</div>
<div id="footer-container">