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

136 lines
17 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">
2022-03-04 00:11:33 +01:00
<span id="sfml">Google OR-Tools 9.3</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>
2022-01-17 21:42:14 +01:00
<!-- Generated by Doxygen 1.9.3 -->
2020-09-01 16:00:33 +02:00
<script type="text/javascript">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
2020-09-01 16:00:33 +02:00
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
2020-09-01 16:00:33 +02:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2022-01-17 21:42:14 +01:00
/* @license-end */
</script>
2020-09-01 16:00:33 +02:00
<div id="main-nav"></div>
2019-06-13 02:45:44 +02:00
</div><!-- top -->
2020-09-01 16:00:33 +02:00
<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">
2022-01-17 21:42:14 +01:00
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('namespaces.html',''); initResizable(); });
2020-09-01 16:00:33 +02:00
/* @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">
2022-01-17 21:42:14 +01:00
<div class="headertitle"><div class="title">Packages</div></div>
2019-06-13 02:45:44 +02:00
</div><!--header-->
<div class="contents">
2020-09-01 16:00:33 +02:00
<div class="textblock">Here are the packages with brief descriptions (if available):</div><div class="directory">
2022-03-04 00:11:33 +01:00
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span><span onclick="javascript:toggleLevel(5);">5</span><span onclick="javascript:toggleLevel(6);">6</span>]</div><table class="directory">
2022-01-17 21:42:14 +01:00
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>com</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>google</b></td><td class="desc"></td></tr>
2021-09-20 15:57:27 +02:00
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_0_0_0_" class="arrow" onclick="toggleFolder('0_0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacecom_1_1google_1_1ortools.html" target="_self">ortools</a></td><td class="desc"></td></tr>
2022-03-04 00:11:33 +01:00
<tr id="row_0_0_0_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span id="arr_0_0_0_0_" class="arrow" onclick="toggleFolder('0_0_0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacecom_1_1google_1_1ortools_1_1constraintsolver.html" target="_self">constraintsolver</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_0_0_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1constraintsolver_1_1IntIntToLongFunction.html" target="_self">IntIntToLongFunction</a></td><td class="desc">Represents a function that accepts two int-valued arguments and produces a long-valued result </td></tr>
<tr id="row_0_0_0_0_1_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1constraintsolver_1_1JavaDecisionBuilder.html" target="_self">JavaDecisionBuilder</a></td><td class="desc">This class acts as a intermediate step between a c++ decision builder and a java one </td></tr>
<tr id="row_0_0_0_0_2_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1constraintsolver_1_1LongTernaryOperator.html" target="_self">LongTernaryOperator</a></td><td class="desc">Represents an operation upon three <code class="JavaDocCode">long</code>-valued operands and producing a <code class="JavaDocCode">long</code>-valued result </td></tr>
<tr id="row_0_0_0_0_3_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1constraintsolver_1_1LongTernaryPredicate.html" target="_self">LongTernaryPredicate</a></td><td class="desc">Represents a predicate (boolean-valued function) uppon three <code class="JavaDocCode">long</code>-valued operands </td></tr>
<tr id="row_0_0_0_1_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span id="arr_0_0_0_1_" class="arrow" onclick="toggleFolder('0_0_0_1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacecom_1_1google_1_1ortools_1_1sat.html" target="_self">sat</a></td><td class="desc"></td></tr>
<tr id="row_0_0_0_1_0_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1AffineExpression.html" target="_self">AffineExpression</a></td><td class="desc">A specialized linear expression: a * x + b </td></tr>
<tr id="row_0_0_0_1_1_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1AutomatonConstraint.html" target="_self">AutomatonConstraint</a></td><td class="desc">Specialized automaton constraint </td></tr>
<tr id="row_0_0_0_1_2_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1BoolVar.html" target="_self">BoolVar</a></td><td class="desc">An Boolean variable </td></tr>
<tr id="row_0_0_0_1_3_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CircuitConstraint.html" target="_self">CircuitConstraint</a></td><td class="desc">Specialized circuit constraint </td></tr>
<tr id="row_0_0_0_1_4_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1ConstantExpression.html" target="_self">ConstantExpression</a></td><td class="desc">A specialized constant linear expression </td></tr>
<tr id="row_0_0_0_1_5_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1Constraint.html" target="_self">Constraint</a></td><td class="desc">Wrapper around a ConstraintProto </td></tr>
<tr id="row_0_0_0_1_6_"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span id="arr_0_0_0_1_6_" class="arrow" onclick="toggleFolder('0_0_0_1_6_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel.html" target="_self">CpModel</a></td><td class="desc">Main modeling class </td></tr>
<tr id="row_0_0_0_1_6_0_" class="even"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel_1_1MismatchedArrayLengths.html" target="_self">MismatchedArrayLengths</a></td><td class="desc">Exception thrown when parallel arrays have mismatched lengths </td></tr>
<tr id="row_0_0_0_1_6_1_"><td class="entry"><span style="width:96px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpModel_1_1WrongLength.html" target="_self">WrongLength</a></td><td class="desc">Exception thrown when an array has a wrong length </td></tr>
<tr id="row_0_0_0_1_7_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolver.html" target="_self">CpSolver</a></td><td class="desc">Wrapper around the SAT solver </td></tr>
<tr id="row_0_0_0_1_8_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CpSolverSolutionCallback.html" target="_self">CpSolverSolutionCallback</a></td><td class="desc">Parent class to create a callback called at each solution </td></tr>
<tr id="row_0_0_0_1_9_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1CumulativeConstraint.html" target="_self">CumulativeConstraint</a></td><td class="desc">Specialized cumulative constraint </td></tr>
<tr id="row_0_0_0_1_10_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1DoubleLinearExpr.html" target="_self">DoubleLinearExpr</a></td><td class="desc">A linear expression interface that can be parsed </td></tr>
<tr id="row_0_0_0_1_11_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntervalVar.html" target="_self">IntervalVar</a></td><td class="desc">An interval variable </td></tr>
<tr id="row_0_0_0_1_12_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1IntVar.html" target="_self">IntVar</a></td><td class="desc">An integer variable </td></tr>
<tr id="row_0_0_0_1_13_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearArgument.html" target="_self">LinearArgument</a></td><td class="desc">A object that can build a <a class="el" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html" title="A linear expression (sum (ai * xi) + b).">LinearExpr</a> object </td></tr>
<tr id="row_0_0_0_1_14_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html" target="_self">LinearExpr</a></td><td class="desc">A linear expression (sum (ai * xi) + b) </td></tr>
<tr id="row_0_0_0_1_15_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1LinearExprBuilder.html" target="_self">LinearExprBuilder</a></td><td class="desc">Builder class for the <a class="el" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1LinearExpr.html" title="A linear expression (sum (ai * xi) + b).">LinearExpr</a> container </td></tr>
<tr id="row_0_0_0_1_16_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="interfacecom_1_1google_1_1ortools_1_1sat_1_1Literal.html" target="_self">Literal</a></td><td class="desc">Interface to describe a boolean variable or its negation </td></tr>
<tr id="row_0_0_0_1_17_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1MultipleCircuitConstraint.html" target="_self">MultipleCircuitConstraint</a></td><td class="desc">Specialized multiple circuit constraint </td></tr>
<tr id="row_0_0_0_1_18_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1NoOverlap2dConstraint.html" target="_self">NoOverlap2dConstraint</a></td><td class="desc">Specialized NoOverlap2D constraint </td></tr>
<tr id="row_0_0_0_1_19_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1NotBoolVar.html" target="_self">NotBoolVar</a></td><td class="desc">The negation of a boolean variable </td></tr>
<tr id="row_0_0_0_1_20_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1ReservoirConstraint.html" target="_self">ReservoirConstraint</a></td><td class="desc">Specialized reservoir constraint </td></tr>
<tr id="row_0_0_0_1_21_" class="even"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1TableConstraint.html" target="_self">TableConstraint</a></td><td class="desc">Specialized assignment constraint </td></tr>
<tr id="row_0_0_0_1_22_"><td class="entry"><span style="width:80px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1sat_1_1WeightedSumExpression.html" target="_self">WeightedSumExpression</a></td><td class="desc">A specialized linear expression: sum(ai * xi) + b </td></tr>
<tr id="row_0_0_0_2_" class="even"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcom_1_1google_1_1ortools_1_1Loader.html" target="_self">Loader</a></td><td class="desc">Load native libraries needed for using ortools-java </td></tr>
2019-06-13 02:45:44 +02:00
</table>
</div><!-- directory -->
</div><!-- contents -->
2020-09-01 16:00:33 +02:00
</div><!-- doc-content -->
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>