846 lines
52 KiB
HTML
846 lines
52 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Thu Mar 03 21:59:09 CET 2022 -->
|
|
<title>CpModelProtoOrBuilder (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, interface: CpModelProtoOrBuilder">
|
|
<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/CpModelProtoOrBuilder.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>Constr | </li>
|
|
<li><a href="#method-summary">Method</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li>Constr | </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="Interface CpModelProtoOrBuilder" class="title">Interface CpModelProtoOrBuilder</h1>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Superinterfaces:</dt>
|
|
<dd><code>com.google.protobuf.MessageLiteOrBuilder</code>, <code>com.google.protobuf.MessageOrBuilder</code></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>All Known Implementing Classes:</dt>
|
|
<dd><code><a href="CpModelProto.html" title="class in com.google.ortools.sat">CpModelProto</a></code>, <code><a href="CpModelProto.Builder.html" title="class in com.google.ortools.sat">CpModelProto.Builder</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">CpModelProtoOrBuilder</span><span class="extends-implements">
|
|
extends com.google.protobuf.MessageOrBuilder</span></div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ========== 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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssumptions(int)" class="member-name-link">getAssumptions</a><wbr>(int index)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
A list of literals.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssumptionsCount()" class="member-name-link">getAssumptionsCount</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
A list of literals.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getAssumptionsList()" class="member-name-link">getAssumptionsList</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
A list of literals.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConstraintProto.html" title="class in com.google.ortools.sat">ConstraintProto</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConstraints(int)" class="member-name-link">getConstraints</a><wbr>(int index)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConstraintsCount()" class="member-name-link">getConstraintsCount</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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="ConstraintProto.html" title="class in com.google.ortools.sat">ConstraintProto</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConstraintsList()" class="member-name-link">getConstraintsList</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="ConstraintProtoOrBuilder.html" title="interface in com.google.ortools.sat">ConstraintProtoOrBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConstraintsOrBuilder(int)" class="member-name-link">getConstraintsOrBuilder</a><wbr>(int index)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><? extends <a href="ConstraintProtoOrBuilder.html" title="interface in com.google.ortools.sat">ConstraintProtoOrBuilder</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getConstraintsOrBuilderList()" class="member-name-link">getConstraintsOrBuilderList</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FloatObjectiveProto.html" title="class in com.google.ortools.sat">FloatObjectiveProto</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFloatingPointObjective()" class="member-name-link">getFloatingPointObjective</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Advanced usage.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="FloatObjectiveProtoOrBuilder.html" title="interface in com.google.ortools.sat">FloatObjectiveProtoOrBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFloatingPointObjectiveOrBuilder()" class="member-name-link">getFloatingPointObjectiveOrBuilder</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Advanced usage.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><code><a href="#getName()" class="member-name-link">getName</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
For debug/logging only.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>com.google.protobuf.ByteString</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNameBytes()" class="member-name-link">getNameBytes</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
For debug/logging only.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="CpObjectiveProto.html" title="class in com.google.ortools.sat">CpObjectiveProto</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getObjective()" class="member-name-link">getObjective</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The objective to minimize.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="CpObjectiveProtoOrBuilder.html" title="interface in com.google.ortools.sat">CpObjectiveProtoOrBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getObjectiveOrBuilder()" class="member-name-link">getObjectiveOrBuilder</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The objective to minimize.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DecisionStrategyProto.html" title="class in com.google.ortools.sat">DecisionStrategyProto</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSearchStrategy(int)" class="member-name-link">getSearchStrategy</a><wbr>(int index)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSearchStrategyCount()" class="member-name-link">getSearchStrategyCount</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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="DecisionStrategyProto.html" title="class in com.google.ortools.sat">DecisionStrategyProto</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSearchStrategyList()" class="member-name-link">getSearchStrategyList</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="DecisionStrategyProtoOrBuilder.html" title="interface in com.google.ortools.sat">DecisionStrategyProtoOrBuilder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSearchStrategyOrBuilder(int)" class="member-name-link">getSearchStrategyOrBuilder</a><wbr>(int index)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><? extends <a href="DecisionStrategyProtoOrBuilder.html" title="interface in com.google.ortools.sat">DecisionStrategyProtoOrBuilder</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSearchStrategyOrBuilderList()" class="member-name-link">getSearchStrategyOrBuilderList</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PartialVariableAssignment.html" title="class in com.google.ortools.sat">PartialVariableAssignment</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSolutionHint()" class="member-name-link">getSolutionHint</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Solution hint.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="PartialVariableAssignmentOrBuilder.html" title="interface in com.google.ortools.sat">PartialVariableAssignmentOrBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSolutionHintOrBuilder()" class="member-name-link">getSolutionHintOrBuilder</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Solution hint.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SymmetryProto.html" title="class in com.google.ortools.sat">SymmetryProto</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSymmetry()" class="member-name-link">getSymmetry</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
For now, this is not meant to be filled by a client writing a model, but
|
|
by our preprocessing step.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="SymmetryProtoOrBuilder.html" title="interface in com.google.ortools.sat">SymmetryProtoOrBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getSymmetryOrBuilder()" class="member-name-link">getSymmetryOrBuilder</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
For now, this is not meant to be filled by a client writing a model, but
|
|
by our preprocessing step.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IntegerVariableProto.html" title="class in com.google.ortools.sat">IntegerVariableProto</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVariables(int)" class="member-name-link">getVariables</a><wbr>(int index)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The associated Protos should be referred by their index in these fields.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVariablesCount()" class="member-name-link">getVariablesCount</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The associated Protos should be referred by their index in these fields.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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="IntegerVariableProto.html" title="class in com.google.ortools.sat">IntegerVariableProto</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVariablesList()" class="member-name-link">getVariablesList</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The associated Protos should be referred by their index in these fields.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="IntegerVariableProtoOrBuilder.html" title="interface in com.google.ortools.sat">IntegerVariableProtoOrBuilder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVariablesOrBuilder(int)" class="member-name-link">getVariablesOrBuilder</a><wbr>(int index)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The associated Protos should be referred by their index in these fields.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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><? extends <a href="IntegerVariableProtoOrBuilder.html" title="interface in com.google.ortools.sat">IntegerVariableProtoOrBuilder</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getVariablesOrBuilderList()" class="member-name-link">getVariablesOrBuilderList</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The associated Protos should be referred by their index in these fields.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasFloatingPointObjective()" class="member-name-link">hasFloatingPointObjective</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Advanced usage.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasObjective()" class="member-name-link">hasObjective</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
The objective to minimize.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasSolutionHint()" class="member-name-link">hasSolutionHint</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
Solution hint.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasSymmetry()" class="member-name-link">hasSymmetry</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
For now, this is not meant to be filled by a client writing a model, but
|
|
by our preprocessing step.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.protobuf.MessageLiteOrBuilder">Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder</h3>
|
|
<code>isInitialized</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.protobuf.MessageOrBuilder">Methods inherited from interface com.google.protobuf.MessageOrBuilder</h3>
|
|
<code>findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof</code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Method Details</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="getName()">
|
|
<h3>getName</h3>
|
|
<div class="member-signature"><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">getName</span>()</div>
|
|
<div class="block"><pre>
|
|
For debug/logging only. Can be empty.
|
|
</pre>
|
|
|
|
<code>string name = 1;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The name.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getNameBytes()">
|
|
<h3>getNameBytes</h3>
|
|
<div class="member-signature"><span class="return-type">com.google.protobuf.ByteString</span> <span class="element-name">getNameBytes</span>()</div>
|
|
<div class="block"><pre>
|
|
For debug/logging only. Can be empty.
|
|
</pre>
|
|
|
|
<code>string name = 1;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The bytes for name.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getVariablesList()">
|
|
<h3>getVariablesList</h3>
|
|
<div class="member-signature"><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="IntegerVariableProto.html" title="class in com.google.ortools.sat">IntegerVariableProto</a>></span> <span class="element-name">getVariablesList</span>()</div>
|
|
<div class="block"><pre>
|
|
The associated Protos should be referred by their index in these fields.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.IntegerVariableProto variables = 2;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getVariables(int)">
|
|
<h3>getVariables</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="IntegerVariableProto.html" title="class in com.google.ortools.sat">IntegerVariableProto</a></span> <span class="element-name">getVariables</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
The associated Protos should be referred by their index in these fields.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.IntegerVariableProto variables = 2;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getVariablesCount()">
|
|
<h3>getVariablesCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getVariablesCount</span>()</div>
|
|
<div class="block"><pre>
|
|
The associated Protos should be referred by their index in these fields.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.IntegerVariableProto variables = 2;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getVariablesOrBuilderList()">
|
|
<h3>getVariablesOrBuilderList</h3>
|
|
<div class="member-signature"><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><? extends <a href="IntegerVariableProtoOrBuilder.html" title="interface in com.google.ortools.sat">IntegerVariableProtoOrBuilder</a>></span> <span class="element-name">getVariablesOrBuilderList</span>()</div>
|
|
<div class="block"><pre>
|
|
The associated Protos should be referred by their index in these fields.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.IntegerVariableProto variables = 2;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getVariablesOrBuilder(int)">
|
|
<h3>getVariablesOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="IntegerVariableProtoOrBuilder.html" title="interface in com.google.ortools.sat">IntegerVariableProtoOrBuilder</a></span> <span class="element-name">getVariablesOrBuilder</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
The associated Protos should be referred by their index in these fields.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.IntegerVariableProto variables = 2;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConstraintsList()">
|
|
<h3>getConstraintsList</h3>
|
|
<div class="member-signature"><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="ConstraintProto.html" title="class in com.google.ortools.sat">ConstraintProto</a>></span> <span class="element-name">getConstraintsList</span>()</div>
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConstraints(int)">
|
|
<h3>getConstraints</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ConstraintProto.html" title="class in com.google.ortools.sat">ConstraintProto</a></span> <span class="element-name">getConstraints</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConstraintsCount()">
|
|
<h3>getConstraintsCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getConstraintsCount</span>()</div>
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConstraintsOrBuilderList()">
|
|
<h3>getConstraintsOrBuilderList</h3>
|
|
<div class="member-signature"><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><? extends <a href="ConstraintProtoOrBuilder.html" title="interface in com.google.ortools.sat">ConstraintProtoOrBuilder</a>></span> <span class="element-name">getConstraintsOrBuilderList</span>()</div>
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getConstraintsOrBuilder(int)">
|
|
<h3>getConstraintsOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="ConstraintProtoOrBuilder.html" title="interface in com.google.ortools.sat">ConstraintProtoOrBuilder</a></span> <span class="element-name">getConstraintsOrBuilder</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><code>repeated .operations_research.sat.ConstraintProto constraints = 3;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasObjective()">
|
|
<h3>hasObjective</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasObjective</span>()</div>
|
|
<div class="block"><pre>
|
|
The objective to minimize. Can be empty for pure decision problems.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.CpObjectiveProto objective = 4;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Whether the objective field is set.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getObjective()">
|
|
<h3>getObjective</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="CpObjectiveProto.html" title="class in com.google.ortools.sat">CpObjectiveProto</a></span> <span class="element-name">getObjective</span>()</div>
|
|
<div class="block"><pre>
|
|
The objective to minimize. Can be empty for pure decision problems.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.CpObjectiveProto objective = 4;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The objective.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getObjectiveOrBuilder()">
|
|
<h3>getObjectiveOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="CpObjectiveProtoOrBuilder.html" title="interface in com.google.ortools.sat">CpObjectiveProtoOrBuilder</a></span> <span class="element-name">getObjectiveOrBuilder</span>()</div>
|
|
<div class="block"><pre>
|
|
The objective to minimize. Can be empty for pure decision problems.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.CpObjectiveProto objective = 4;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasFloatingPointObjective()">
|
|
<h3>hasFloatingPointObjective</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasFloatingPointObjective</span>()</div>
|
|
<div class="block"><pre>
|
|
Advanced usage.
|
|
It is invalid to have both an objective and a floating point objective.
|
|
The objective of the model, in floating point format. The solver will
|
|
automatically scale this to integer during expansion and thus convert it to
|
|
a normal CpObjectiveProto. See the mip* parameters to control how this is
|
|
scaled. In most situation the precision will be good enough, but you can
|
|
see the logs to see what are the precision guaranteed when this is
|
|
converted to a fixed point representation.
|
|
Note that even if the precision is bad, the returned objective_value and
|
|
best_objective_bound will be computed correctly. So at the end of the solve
|
|
you can check the gap if you only want precise optimal.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.FloatObjectiveProto floating_point_objective = 9;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Whether the floatingPointObjective field is set.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFloatingPointObjective()">
|
|
<h3>getFloatingPointObjective</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="FloatObjectiveProto.html" title="class in com.google.ortools.sat">FloatObjectiveProto</a></span> <span class="element-name">getFloatingPointObjective</span>()</div>
|
|
<div class="block"><pre>
|
|
Advanced usage.
|
|
It is invalid to have both an objective and a floating point objective.
|
|
The objective of the model, in floating point format. The solver will
|
|
automatically scale this to integer during expansion and thus convert it to
|
|
a normal CpObjectiveProto. See the mip* parameters to control how this is
|
|
scaled. In most situation the precision will be good enough, but you can
|
|
see the logs to see what are the precision guaranteed when this is
|
|
converted to a fixed point representation.
|
|
Note that even if the precision is bad, the returned objective_value and
|
|
best_objective_bound will be computed correctly. So at the end of the solve
|
|
you can check the gap if you only want precise optimal.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.FloatObjectiveProto floating_point_objective = 9;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The floatingPointObjective.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getFloatingPointObjectiveOrBuilder()">
|
|
<h3>getFloatingPointObjectiveOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="FloatObjectiveProtoOrBuilder.html" title="interface in com.google.ortools.sat">FloatObjectiveProtoOrBuilder</a></span> <span class="element-name">getFloatingPointObjectiveOrBuilder</span>()</div>
|
|
<div class="block"><pre>
|
|
Advanced usage.
|
|
It is invalid to have both an objective and a floating point objective.
|
|
The objective of the model, in floating point format. The solver will
|
|
automatically scale this to integer during expansion and thus convert it to
|
|
a normal CpObjectiveProto. See the mip* parameters to control how this is
|
|
scaled. In most situation the precision will be good enough, but you can
|
|
see the logs to see what are the precision guaranteed when this is
|
|
converted to a fixed point representation.
|
|
Note that even if the precision is bad, the returned objective_value and
|
|
best_objective_bound will be computed correctly. So at the end of the solve
|
|
you can check the gap if you only want precise optimal.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.FloatObjectiveProto floating_point_objective = 9;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSearchStrategyList()">
|
|
<h3>getSearchStrategyList</h3>
|
|
<div class="member-signature"><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="DecisionStrategyProto.html" title="class in com.google.ortools.sat">DecisionStrategyProto</a>></span> <span class="element-name">getSearchStrategyList</span>()</div>
|
|
<div class="block"><pre>
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
|
|
is also used as a heuristic when we are not in fixed search.
|
|
Advanced Usage: if not all variables appears and the parameter
|
|
"instantiate_all_variables" is set to false, then the solver will not try
|
|
to instantiate the variables that do not appear. Thus, at the end of the
|
|
search, not all variables may be fixed. Currently, we will set them to
|
|
their lower bound in the solution.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSearchStrategy(int)">
|
|
<h3>getSearchStrategy</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DecisionStrategyProto.html" title="class in com.google.ortools.sat">DecisionStrategyProto</a></span> <span class="element-name">getSearchStrategy</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
|
|
is also used as a heuristic when we are not in fixed search.
|
|
Advanced Usage: if not all variables appears and the parameter
|
|
"instantiate_all_variables" is set to false, then the solver will not try
|
|
to instantiate the variables that do not appear. Thus, at the end of the
|
|
search, not all variables may be fixed. Currently, we will set them to
|
|
their lower bound in the solution.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSearchStrategyCount()">
|
|
<h3>getSearchStrategyCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getSearchStrategyCount</span>()</div>
|
|
<div class="block"><pre>
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
|
|
is also used as a heuristic when we are not in fixed search.
|
|
Advanced Usage: if not all variables appears and the parameter
|
|
"instantiate_all_variables" is set to false, then the solver will not try
|
|
to instantiate the variables that do not appear. Thus, at the end of the
|
|
search, not all variables may be fixed. Currently, we will set them to
|
|
their lower bound in the solution.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSearchStrategyOrBuilderList()">
|
|
<h3>getSearchStrategyOrBuilderList</h3>
|
|
<div class="member-signature"><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><? extends <a href="DecisionStrategyProtoOrBuilder.html" title="interface in com.google.ortools.sat">DecisionStrategyProtoOrBuilder</a>></span> <span class="element-name">getSearchStrategyOrBuilderList</span>()</div>
|
|
<div class="block"><pre>
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
|
|
is also used as a heuristic when we are not in fixed search.
|
|
Advanced Usage: if not all variables appears and the parameter
|
|
"instantiate_all_variables" is set to false, then the solver will not try
|
|
to instantiate the variables that do not appear. Thus, at the end of the
|
|
search, not all variables may be fixed. Currently, we will set them to
|
|
their lower bound in the solution.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSearchStrategyOrBuilder(int)">
|
|
<h3>getSearchStrategyOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="DecisionStrategyProtoOrBuilder.html" title="interface in com.google.ortools.sat">DecisionStrategyProtoOrBuilder</a></span> <span class="element-name">getSearchStrategyOrBuilder</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
Defines the strategy that the solver should follow when the
|
|
search_branching parameter is set to FIXED_SEARCH. Note that this strategy
|
|
is also used as a heuristic when we are not in fixed search.
|
|
Advanced Usage: if not all variables appears and the parameter
|
|
"instantiate_all_variables" is set to false, then the solver will not try
|
|
to instantiate the variables that do not appear. Thus, at the end of the
|
|
search, not all variables may be fixed. Currently, we will set them to
|
|
their lower bound in the solution.
|
|
</pre>
|
|
|
|
<code>repeated .operations_research.sat.DecisionStrategyProto search_strategy = 5;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasSolutionHint()">
|
|
<h3>hasSolutionHint</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasSolutionHint</span>()</div>
|
|
<div class="block"><pre>
|
|
Solution hint.
|
|
If a feasible or almost-feasible solution to the problem is already known,
|
|
it may be helpful to pass it to the solver so that it can be used. The
|
|
solver will try to use this information to create its initial feasible
|
|
solution.
|
|
Note that it may not always be faster to give a hint like this to the
|
|
solver. There is also no guarantee that the solver will use this hint or
|
|
try to return a solution "close" to this assignment in case of multiple
|
|
optimal solutions.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.PartialVariableAssignment solution_hint = 6;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Whether the solutionHint field is set.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSolutionHint()">
|
|
<h3>getSolutionHint</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="PartialVariableAssignment.html" title="class in com.google.ortools.sat">PartialVariableAssignment</a></span> <span class="element-name">getSolutionHint</span>()</div>
|
|
<div class="block"><pre>
|
|
Solution hint.
|
|
If a feasible or almost-feasible solution to the problem is already known,
|
|
it may be helpful to pass it to the solver so that it can be used. The
|
|
solver will try to use this information to create its initial feasible
|
|
solution.
|
|
Note that it may not always be faster to give a hint like this to the
|
|
solver. There is also no guarantee that the solver will use this hint or
|
|
try to return a solution "close" to this assignment in case of multiple
|
|
optimal solutions.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.PartialVariableAssignment solution_hint = 6;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The solutionHint.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSolutionHintOrBuilder()">
|
|
<h3>getSolutionHintOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="PartialVariableAssignmentOrBuilder.html" title="interface in com.google.ortools.sat">PartialVariableAssignmentOrBuilder</a></span> <span class="element-name">getSolutionHintOrBuilder</span>()</div>
|
|
<div class="block"><pre>
|
|
Solution hint.
|
|
If a feasible or almost-feasible solution to the problem is already known,
|
|
it may be helpful to pass it to the solver so that it can be used. The
|
|
solver will try to use this information to create its initial feasible
|
|
solution.
|
|
Note that it may not always be faster to give a hint like this to the
|
|
solver. There is also no guarantee that the solver will use this hint or
|
|
try to return a solution "close" to this assignment in case of multiple
|
|
optimal solutions.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.PartialVariableAssignment solution_hint = 6;</code></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAssumptionsList()">
|
|
<h3>getAssumptionsList</h3>
|
|
<div class="member-signature"><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">getAssumptionsList</span>()</div>
|
|
<div class="block"><pre>
|
|
A list of literals. The model will be solved assuming all these literals
|
|
are true. Compared to just fixing the domain of these literals, using this
|
|
mechanism is slower but allows in case the model is INFEASIBLE to get a
|
|
potentially small subset of them that can be used to explain the
|
|
infeasibility.
|
|
Think (IIS), except when you are only concerned by the provided
|
|
assumptions. This is powerful as it allows to group a set of logically
|
|
related constraint under only one enforcement literal which can potentially
|
|
give you a good and interpretable explanation for infeasiblity.
|
|
Such infeasibility explanation will be available in the
|
|
sufficient_assumptions_for_infeasibility response field.
|
|
</pre>
|
|
|
|
<code>repeated int32 assumptions = 7;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A list containing the assumptions.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAssumptionsCount()">
|
|
<h3>getAssumptionsCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getAssumptionsCount</span>()</div>
|
|
<div class="block"><pre>
|
|
A list of literals. The model will be solved assuming all these literals
|
|
are true. Compared to just fixing the domain of these literals, using this
|
|
mechanism is slower but allows in case the model is INFEASIBLE to get a
|
|
potentially small subset of them that can be used to explain the
|
|
infeasibility.
|
|
Think (IIS), except when you are only concerned by the provided
|
|
assumptions. This is powerful as it allows to group a set of logically
|
|
related constraint under only one enforcement literal which can potentially
|
|
give you a good and interpretable explanation for infeasiblity.
|
|
Such infeasibility explanation will be available in the
|
|
sufficient_assumptions_for_infeasibility response field.
|
|
</pre>
|
|
|
|
<code>repeated int32 assumptions = 7;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The count of assumptions.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getAssumptions(int)">
|
|
<h3>getAssumptions</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getAssumptions</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
A list of literals. The model will be solved assuming all these literals
|
|
are true. Compared to just fixing the domain of these literals, using this
|
|
mechanism is slower but allows in case the model is INFEASIBLE to get a
|
|
potentially small subset of them that can be used to explain the
|
|
infeasibility.
|
|
Think (IIS), except when you are only concerned by the provided
|
|
assumptions. This is powerful as it allows to group a set of logically
|
|
related constraint under only one enforcement literal which can potentially
|
|
give you a good and interpretable explanation for infeasiblity.
|
|
Such infeasibility explanation will be available in the
|
|
sufficient_assumptions_for_infeasibility response field.
|
|
</pre>
|
|
|
|
<code>repeated int32 assumptions = 7;</code></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>index</code> - The index of the element to return.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The assumptions at the given index.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasSymmetry()">
|
|
<h3>hasSymmetry</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasSymmetry</span>()</div>
|
|
<div class="block"><pre>
|
|
For now, this is not meant to be filled by a client writing a model, but
|
|
by our preprocessing step.
|
|
Information about the symmetries of the feasible solution space.
|
|
These usually leaves the objective invariant.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.SymmetryProto symmetry = 8;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Whether the symmetry field is set.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSymmetry()">
|
|
<h3>getSymmetry</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="SymmetryProto.html" title="class in com.google.ortools.sat">SymmetryProto</a></span> <span class="element-name">getSymmetry</span>()</div>
|
|
<div class="block"><pre>
|
|
For now, this is not meant to be filled by a client writing a model, but
|
|
by our preprocessing step.
|
|
Information about the symmetries of the feasible solution space.
|
|
These usually leaves the objective invariant.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.SymmetryProto symmetry = 8;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The symmetry.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getSymmetryOrBuilder()">
|
|
<h3>getSymmetryOrBuilder</h3>
|
|
<div class="member-signature"><span class="return-type"><a href="SymmetryProtoOrBuilder.html" title="interface in com.google.ortools.sat">SymmetryProtoOrBuilder</a></span> <span class="element-name">getSymmetryOrBuilder</span>()</div>
|
|
<div class="block"><pre>
|
|
For now, this is not meant to be filled by a client writing a model, but
|
|
by our preprocessing step.
|
|
Information about the symmetries of the feasible solution space.
|
|
These usually leaves the objective invariant.
|
|
</pre>
|
|
|
|
<code>.operations_research.sat.SymmetryProto symmetry = 8;</code></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>
|