427 lines
33 KiB
HTML
427 lines
33 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Thu Mar 03 21:59:09 CET 2022 -->
|
|
<title>CpSolver (com.google.ortools:ortools-java 9.3.10440 API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2022-03-03">
|
|
<meta name="description" content="declaration: package: com.google.ortools.sat, class: CpSolver">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
|
|
<script type="text/javascript" src="../../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var evenRowColor = "even-row-color";
|
|
var oddRowColor = "odd-row-color";
|
|
var tableTab = "table-tab";
|
|
var activeTableTab = "active-table-tab";
|
|
var pathtoroot = "../../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top">
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../../index.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Class</li>
|
|
<li><a href="class-use/CpSolver.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html#class">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div>
|
|
<ul class="sub-nav-list">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-summary">Constr</a> | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor-detail">Constr</a> | </li>
|
|
<li><a href="#method-detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
|
|
<input type="text" id="search-input" value="search" disabled="disabled">
|
|
<input type="reset" id="reset-button" value="reset" disabled="disabled">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.google.ortools.sat</a></div>
|
|
<h1 title="Class CpSolver" class="title">Class CpSolver</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">com.google.ortools.sat.CpSolver</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">CpSolver</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">Wrapper around the SAT solver.
|
|
|
|
<p>This class proposes different solve() methods, as well as accessors to get the values of
|
|
variables in the best solution, as well as general statistics of the search.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Constructor Summary</h2>
|
|
<div class="caption"><span>Constructors</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Constructor</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CpSolver</a>()</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Main construction of the CpSolver class.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Method Summary</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#bestObjectiveBound()" class="member-name-link">bestObjectiveBound</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the best lower bound found when minimizing, of the best upper bound found when
|
|
maximizing.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#booleanValue(com.google.ortools.sat.Literal)" class="member-name-link">booleanValue</a><wbr>(<a href="Literal.html" title="interface in com.google.ortools.sat">Literal</a> var)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the Boolean value of a literal in the last solution found.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="SatParameters.Builder.html" title="class in com.google.ortools.sat">SatParameters.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParameters()" class="member-name-link">getParameters</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the builder of the parameters of the SAT solver for modification.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSolutionInfo()" class="member-name-link">getSolutionInfo</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns some information on how the solution was found, or the reason why the model or the
|
|
parameters are invalid.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#numBranches()" class="member-name-link">numBranches</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the number of branches explored during search.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#numConflicts()" class="member-name-link">numConflicts</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the number of conflicts created during search.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#objectiveValue()" class="member-name-link">objectiveValue</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the best objective value found during search.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CpSolverResponse.html" title="class in com.google.ortools.sat">CpSolverResponse</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#response()" class="member-name-link">response</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the internal response protobuf that is returned internally by the SAT solver.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#responseStats()" class="member-name-link">responseStats</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns some statistics on the solution found as a string.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#searchAllSolutions(com.google.ortools.sat.CpModel,com.google.ortools.sat.CpSolverSolutionCallback)" class="member-name-link">searchAllSolutions</a><wbr>(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model,
|
|
<a href="CpSolverSolutionCallback.html" title="class in com.google.ortools.sat">CpSolverSolutionCallback</a> cb)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use the solve() method with the same signature, after setting the
|
|
enumerate_all_solution parameter to true.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLogCallback(java.util.function.Consumer)" class="member-name-link">setLogCallback</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> cb)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Sets the log callback for the solver.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#solve(com.google.ortools.sat.CpModel)" class="member-name-link">solve</a><wbr>(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Solves the given model, and returns the solve status.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#solve(com.google.ortools.sat.CpModel,com.google.ortools.sat.CpSolverSolutionCallback)" class="member-name-link">solve</a><wbr>(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model,
|
|
<a href="CpSolverSolutionCallback.html" title="class in com.google.ortools.sat">CpSolverSolutionCallback</a> cb)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Solves the given model, calls the solution callback at each incumbent solution, and returns the
|
|
solve status.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#solveWithSolutionCallback(com.google.ortools.sat.CpModel,com.google.ortools.sat.CpSolverSolutionCallback)" class="member-name-link">solveWithSolutionCallback</a><wbr>(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model,
|
|
<a href="CpSolverSolutionCallback.html" title="class in com.google.ortools.sat">CpSolverSolutionCallback</a> cb)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
|
|
<div class="block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use the solve() method with the same signature.</div>
|
|
</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopSearch()" class="member-name-link">stopSearch</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Stops the search asynchronously.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sufficientAssumptionsForInfeasibility()" class="member-name-link">sufficientAssumptionsForInfeasibility</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#userTime()" class="member-name-link">userTime</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the user time of the search.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#value(com.google.ortools.sat.LinearArgument)" class="member-name-link">value</a><wbr>(<a href="LinearArgument.html" title="interface in com.google.ortools.sat">LinearArgument</a> expr)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the value of a linear expression in the last solution found.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#wallTime()" class="member-name-link">wallTime</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Returns the wall time of the search.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Constructor Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>()">
|
|
<h3>CpSolver</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CpSolver</span>()</div>
|
|
<div class="block">Main construction of the CpSolver class.</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="solve(com.google.ortools.sat.CpModel)">
|
|
<h3>solve</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></span> <span class="element-name">solve</span><wbr><span class="parameters">(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model)</span></div>
|
|
<div class="block">Solves the given model, and returns the solve status.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="solve(com.google.ortools.sat.CpModel,com.google.ortools.sat.CpSolverSolutionCallback)">
|
|
<h3>solve</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></span> <span class="element-name">solve</span><wbr><span class="parameters">(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model,
|
|
<a href="CpSolverSolutionCallback.html" title="class in com.google.ortools.sat">CpSolverSolutionCallback</a> cb)</span></div>
|
|
<div class="block">Solves the given model, calls the solution callback at each incumbent solution, and returns the
|
|
solve status.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="solveWithSolutionCallback(com.google.ortools.sat.CpModel,com.google.ortools.sat.CpSolverSolutionCallback)">
|
|
<h3>solveWithSolutionCallback</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></span> <span class="element-name">solveWithSolutionCallback</span><wbr><span class="parameters">(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model,
|
|
<a href="CpSolverSolutionCallback.html" title="class in com.google.ortools.sat">CpSolverSolutionCallback</a> cb)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use the solve() method with the same signature.</div>
|
|
</div>
|
|
<div class="block">Solves the given model, passes each incumber solution to the solution callback if not null, and
|
|
returns the solve status.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="searchAllSolutions(com.google.ortools.sat.CpModel,com.google.ortools.sat.CpSolverSolutionCallback)">
|
|
<h3>searchAllSolutions</h3>
|
|
<div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
|
|
</span><span class="modifiers">public</span> <span class="return-type"><a href="CpSolverStatus.html" title="enum in com.google.ortools.sat">CpSolverStatus</a></span> <span class="element-name">searchAllSolutions</span><wbr><span class="parameters">(<a href="CpModel.html" title="class in com.google.ortools.sat">CpModel</a> model,
|
|
<a href="CpSolverSolutionCallback.html" title="class in com.google.ortools.sat">CpSolverSolutionCallback</a> cb)</span></div>
|
|
<div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
|
|
<div class="deprecation-comment">Use the solve() method with the same signature, after setting the
|
|
enumerate_all_solution parameter to true.</div>
|
|
</div>
|
|
<div class="block">Searches for all solutions of a satisfiability problem.
|
|
|
|
<p>This method searches for all feasible solutions of a given model. Then it feeds the
|
|
solutions to the callback.
|
|
|
|
<p>Note that the model cannot have an objective.</div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>model</code> - the model to solve</dd>
|
|
<dd><code>cb</code> - the callback that will be called at each solution</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>the status of the solve (FEASIBLE, INFEASIBLE...)</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="stopSearch()">
|
|
<h3>stopSearch</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">stopSearch</span>()</div>
|
|
<div class="block">Stops the search asynchronously.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="objectiveValue()">
|
|
<h3>objectiveValue</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">objectiveValue</span>()</div>
|
|
<div class="block">Returns the best objective value found during search.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="bestObjectiveBound()">
|
|
<h3>bestObjectiveBound</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">bestObjectiveBound</span>()</div>
|
|
<div class="block">Returns the best lower bound found when minimizing, of the best upper bound found when
|
|
maximizing.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="value(com.google.ortools.sat.LinearArgument)">
|
|
<h3>value</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">value</span><wbr><span class="parameters">(<a href="LinearArgument.html" title="interface in com.google.ortools.sat">LinearArgument</a> expr)</span></div>
|
|
<div class="block">Returns the value of a linear expression in the last solution found.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="booleanValue(com.google.ortools.sat.Literal)">
|
|
<h3>booleanValue</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html" title="class or interface in java.lang" class="external-link">Boolean</a></span> <span class="element-name">booleanValue</span><wbr><span class="parameters">(<a href="Literal.html" title="interface in com.google.ortools.sat">Literal</a> var)</span></div>
|
|
<div class="block">Returns the Boolean value of a literal in the last solution found.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="response()">
|
|
<h3>response</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="CpSolverResponse.html" title="class in com.google.ortools.sat">CpSolverResponse</a></span> <span class="element-name">response</span>()</div>
|
|
<div class="block">Returns the internal response protobuf that is returned internally by the SAT solver.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="numBranches()">
|
|
<h3>numBranches</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">numBranches</span>()</div>
|
|
<div class="block">Returns the number of branches explored during search.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="numConflicts()">
|
|
<h3>numConflicts</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">numConflicts</span>()</div>
|
|
<div class="block">Returns the number of conflicts created during search.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="wallTime()">
|
|
<h3>wallTime</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">wallTime</span>()</div>
|
|
<div class="block">Returns the wall time of the search.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="userTime()">
|
|
<h3>userTime</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">userTime</span>()</div>
|
|
<div class="block">Returns the user time of the search.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="sufficientAssumptionsForInfeasibility()">
|
|
<h3>sufficientAssumptionsForInfeasibility</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">sufficientAssumptionsForInfeasibility</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getParameters()">
|
|
<h3>getParameters</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="SatParameters.Builder.html" title="class in com.google.ortools.sat">SatParameters.Builder</a></span> <span class="element-name">getParameters</span>()</div>
|
|
<div class="block">Returns the builder of the parameters of the SAT solver for modification.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setLogCallback(java.util.function.Consumer)">
|
|
<h3>setLogCallback</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setLogCallback</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html" title="class or interface in java.util.function" class="external-link">Consumer</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> cb)</span></div>
|
|
<div class="block">Sets the log callback for the solver.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="responseStats()">
|
|
<h3>responseStats</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">responseStats</span>()</div>
|
|
<div class="block">Returns some statistics on the solution found as a string.</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSolutionInfo()">
|
|
<h3>getSolutionInfo</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getSolutionInfo</span>()</div>
|
|
<div class="block">Returns some information on how the solution was found, or the reason why the model or the
|
|
parameters are invalid.</div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 2022. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|