always-cautious/ortools-clone
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
Corentin Le Molgat
2020-04-23 15:34:43 +02:00
parent aab96e610e
commit b670dc9daa
4098 changed files with 132830 additions and 75618 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/java/CpModel_8java_source.html
View File

@@ -31,7 +31,7 @@
<div align="center">
<h1 style="color: #145A32;">Java Reference</h1>
</div>
<!-- Generated by Doxygen 1.8.18 -->
<!-- Generated by Doxygen 1.8.16 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
@@ -801,7 +801,7 @@
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1Constraint_html_ae49c1e99145157c8aa8cce5897e6a6bc"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html#ae49c1e99145157c8aa8cce5897e6a6bc">com.google.ortools.sat.Constraint.onlyEnforceIf</a></div><div class="ttdeci">void onlyEnforceIf(Literal lit)</div><div class="ttdoc">Adds a literal to the constraint.</div><div class="ttdef"><b>Definition:</b> <a href="java_2com_2google_2ortools_2sat_2Constraint_8java_source.html#l00032">java/com/google/ortools/sat/Constraint.java:32</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1NoOverlap2DConstraintProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1NoOverlap2DConstraintProto_1_1Builder.html">com.google.ortools.sat.NoOverlap2DConstraintProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="NoOverlap2DConstraintProto_8java_source.html#l00437">NoOverlap2DConstraintProto.java:437</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a4005900c34d265fa7fd60e622d533cfa"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a4005900c34d265fa7fd60e622d533cfa">com.google.ortools.sat.CpModel.newOptionalFixedInterval</a></div><div class="ttdeci">IntervalVar newOptionalFixedInterval(long start, long size, Literal isPresent, String name)</div><div class="ttdoc">Creates an optional fixed interval from start and size.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00809">CpModel.java:809</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto.html">com.google.ortools.sat.CircuitConstraintProto</a></div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraintProto_8java_source.html#l00019">CircuitConstraintProto.java:19</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto.html">com.google.ortools.sat.CircuitConstraintProto</a></div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraintProto_8java_source.html#l00020">CircuitConstraintProto.java:20</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a5fbb526d9d241b398980965a6ad29cf8"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a5fbb526d9d241b398980965a6ad29cf8">com.google.ortools.sat.CpModel.addDivisionEquality</a></div><div class="ttdeci">Constraint addDivisionEquality(IntVar target, IntVar num, IntVar denom)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00646">CpModel.java:646</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_aad5ca472d8bb1c3fba559aeb41e1dd91"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#aad5ca472d8bb1c3fba559aeb41e1dd91">com.google.ortools.sat.CpModel.addLessThan</a></div><div class="ttdeci">Constraint addLessThan(LinearExpr left, LinearExpr right)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00183">CpModel.java:183</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>
@@ -822,7 +822,7 @@
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1IntegerArgumentProto_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1IntegerArgumentProto.html">com.google.ortools.sat.IntegerArgumentProto</a></div><div class="ttdef"><b>Definition:</b> <a href="IntegerArgumentProto_8java_source.html#l00013">IntegerArgumentProto.java:13</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_ab85f26d65b25672b7d59ad39dbca4e03"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#ab85f26d65b25672b7d59ad39dbca4e03">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="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_acb22618b9c5bf942f2994e9226df0cd2"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#acb22618b9c5bf942f2994e9226df0cd2">com.google.ortools.sat.CpModel.addForbiddenAssignments</a></div><div class="ttdeci">Constraint addForbiddenAssignments(IntVar[] variables, long[][] tuplesList)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00402">CpModel.java:402</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_html_a011585ec9c8d9882de1b5278fe028ede"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html#a011585ec9c8d9882de1b5278fe028ede">com.google.ortools.sat.CpModelProto.getVariablesCount</a></div><div class="ttdeci">int getVariablesCount()</div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00234">CpModelProto.java:234</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_html_a011585ec9c8d9882de1b5278fe028ede"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html#a011585ec9c8d9882de1b5278fe028ede">com.google.ortools.sat.CpModelProto.getVariablesCount</a></div><div class="ttdeci">int getVariablesCount()</div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00259">CpModelProto.java:259</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a65c5e85798b91fc39bbcc8ee35e7d808"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a65c5e85798b91fc39bbcc8ee35e7d808">com.google.ortools.sat.CpModel.addReservoirConstraint</a></div><div class="ttdeci">Constraint addReservoirConstraint(IntVar[] times, int[] demands, long minLevel, long maxLevel)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00549">CpModel.java:549</a></div></div>
<div class="ttc" id="aenumcom_1_1google_1_1ortools_1_1sat_1_1DecisionStrategyProto_1_1DomainReductionStrategy_html"><div class="ttname"><a href="enumcom_1_1google_1_1ortools_1_1sat_1_1DecisionStrategyProto_1_1DomainReductionStrategy.html">com.google.ortools.sat.DecisionStrategyProto.DomainReductionStrategy</a></div><div class="ttdef"><b>Definition:</b> <a href="DecisionStrategyProto_8java_source.html#l00287">DecisionStrategyProto.java:287</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a9961466ef8371e502084fb8a2d20b806"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a9961466ef8371e502084fb8a2d20b806">com.google.ortools.sat.CpModel.addCumulative</a></div><div class="ttdeci">Constraint addCumulative(IntervalVar[] intervals, int[] demands, IntVar capacity)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00906">CpModel.java:906</a></div></div>
@@ -832,7 +832,7 @@
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1AutomatonConstraintProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1AutomatonConstraintProto_1_1Builder.html">com.google.ortools.sat.AutomatonConstraintProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="AutomatonConstraintProto_8java_source.html#l00703">AutomatonConstraintProto.java:703</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_ad4bcd2a7566c6fe77e5bc5fe0606aa9e"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#ad4bcd2a7566c6fe77e5bc5fe0606aa9e">com.google.ortools.sat.CpModel.addGreaterOrEqualWithOffset</a></div><div class="ttdeci">Constraint addGreaterOrEqualWithOffset(LinearExpr left, LinearExpr right, long offset)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00214">CpModel.java:214</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1SatHelper_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1SatHelper.html">com.google.ortools.sat.SatHelper</a></div><div class="ttdef"><b>Definition:</b> <a href="SatHelper_8java_source.html#l00013">SatHelper.java:13</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder.html">com.google.ortools.sat.CpModelProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00715">CpModelProto.java:715</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_1_1Builder.html">com.google.ortools.sat.CpModelProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00837">CpModelProto.java:837</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_acec0e451f95863176e68a4e97fef3b77"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#acec0e451f95863176e68a4e97fef3b77">com.google.ortools.sat.CpModel.addEquality</a></div><div class="ttdeci">Constraint addEquality(LinearExpr expr, long value)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00153">CpModel.java:153</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a97d3588502ef710ff9ed2ae05e00bcae"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a97d3588502ef710ff9ed2ae05e00bcae">com.google.ortools.sat.CpModel.newIntervalVar</a></div><div class="ttdeci">IntervalVar newIntervalVar(IntVar start, IntVar size, long end, String name)</div><div class="ttdoc">Creates an interval variable with a fixed end.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00721">CpModel.java:721</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a7dc263b0a9e76a937e4e96c764e85eae"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a7dc263b0a9e76a937e4e96c764e85eae">com.google.ortools.sat.CpModel.newOptionalIntervalVar</a></div><div class="ttdeci">IntervalVar newOptionalIntervalVar(IntVar start, IntVar size, IntVar end, Literal isPresent, String name)</div><div class="ttdoc">Creates an optional interval variable from start, size, end, and isPresent.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00769">CpModel.java:769</a></div></div>
@@ -855,14 +855,14 @@
<div class="ttc" id="aclasscom_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="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a054656b2feb903624f2f2c9ebb26b227"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a054656b2feb903624f2f2c9ebb26b227">com.google.ortools.sat.CpModel.addDifferent</a></div><div class="ttdeci">Constraint addDifferent(IntVar left, IntVar right)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00227">CpModel.java:227</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_ac186197ab1a1d6ee6fafd4fa65444b86"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#ac186197ab1a1d6ee6fafd4fa65444b86">com.google.ortools.sat.CpModel.addInverse</a></div><div class="ttdeci">Constraint addInverse(IntVar[] variables, IntVar[] inverseVariables)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00487">CpModel.java:487</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder.html">com.google.ortools.sat.CircuitConstraintProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraintProto_8java_source.html#l00489">CircuitConstraintProto.java:489</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder_html"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraintProto_1_1Builder.html">com.google.ortools.sat.CircuitConstraintProto.Builder</a></div><div class="ttdef"><b>Definition:</b> <a href="CircuitConstraintProto_8java_source.html#l00491">CircuitConstraintProto.java:491</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_1util_1_1Domain_html_a8350d3549edfadb84f04fcf3496a7d55"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1util_1_1Domain.html#a8350d3549edfadb84f04fcf3496a7d55">com.google.ortools.util.Domain.fromFlatIntervals</a></div><div class="ttdeci">static Domain fromFlatIntervals(long[] flat_intervals)</div><div class="ttdoc">This method is available in Python, Java and .NET.</div><div class="ttdef"><b>Definition:</b> <a href="Domain_8java_source.html#l00100">Domain.java:100</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a5ebe6f90377f06adcb4a95eca060bcb6"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a5ebe6f90377f06adcb4a95eca060bcb6">com.google.ortools.sat.CpModel.minimize</a></div><div class="ttdeci">void minimize(LinearExpr expr)</div><div class="ttdoc">Adds a minimization objective of a linear expression.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00964">CpModel.java:964</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_a7383b73106c0c44d04316bfdd15c12f8"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#a7383b73106c0c44d04316bfdd15c12f8">com.google.ortools.sat.CpModel.addHint</a></div><div class="ttdeci">void addHint(IntVar var, long value)</div><div class="ttdoc">Adds hinting to a variable.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00956">CpModel.java:956</a></div></div>
<div class="ttc" id="anamespacecom_1_1google_html"><div class="ttname"><a href="namespacecom_1_1google.html">com.google</a></div></div>
<div class="ttc" id="anamespacecom_html"><div class="ttname"><a href="namespacecom.html">com</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_html_aeff24d3f13ca1e88dc9427c640b64314"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html#aeff24d3f13ca1e88dc9427c640b64314">com.google.ortools.sat.CpModelProto.newBuilder</a></div><div class="ttdeci">static Builder newBuilder()</div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00690">CpModelProto.java:690</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModelProto_html_aeff24d3f13ca1e88dc9427c640b64314"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModelProto.html#aeff24d3f13ca1e88dc9427c640b64314">com.google.ortools.sat.CpModelProto.newBuilder</a></div><div class="ttdeci">static Builder newBuilder()</div><div class="ttdef"><b>Definition:</b> <a href="CpModelProto_8java_source.html#l00812">CpModelProto.java:812</a></div></div>
<div class="ttc" id="aclasscom_1_1google_1_1ortools_1_1sat_1_1CpModel_html_aa63aa7077e593323893f87e70e538685"><div class="ttname"><a href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html#aa63aa7077e593323893f87e70e538685">com.google.ortools.sat.CpModel.addBoolXor</a></div><div class="ttdeci">Constraint addBoolXor(Literal[] literals)</div><div class="ttdoc">Adds.</div><div class="ttdef"><b>Definition:</b> <a href="CpModel_8java_source.html#l00117">CpModel.java:117</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="ainterfacecom_1_1google_1_1ortools_1_1sat_1_1Literal_html_a9e2c0b0299cf2164e32a7fbc543a7ea6"><div class="ttname"><a href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html#a9e2c0b0299cf2164e32a7fbc543a7ea6">com.google.ortools.sat.Literal.not</a></div><div class="ttdeci">Literal not()</div><div class="ttdoc">Returns the Boolean negation of the current literal.</div></div>