286 lines
14 KiB
HTML
286 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Thu Mar 03 21:59:09 CET 2022 -->
|
|
<title>IntegerVariableProtoOrBuilder (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: IntegerVariableProtoOrBuilder">
|
|
<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/IntegerVariableProtoOrBuilder.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 IntegerVariableProtoOrBuilder" class="title">Interface IntegerVariableProtoOrBuilder</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="IntegerVariableProto.html" title="class in com.google.ortools.sat">IntegerVariableProto</a></code>, <code><a href="IntegerVariableProto.Builder.html" title="class in com.google.ortools.sat">IntegerVariableProto.Builder</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IntegerVariableProtoOrBuilder</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>long</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDomain(int)" class="member-name-link">getDomain</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 variable domain given as a sorted list of n disjoint intervals
|
|
[min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].</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="#getDomainCount()" class="member-name-link">getDomainCount</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 variable domain given as a sorted list of n disjoint intervals
|
|
[min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].</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/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDomainList()" class="member-name-link">getDomainList</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 variable domain given as a sorted list of n disjoint intervals
|
|
[min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].</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/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-tab3"><code><a href="#getName()" class="member-name-link">getName</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>com.google.protobuf.ByteString</code></div>
|
|
<div class="col-second even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
|
|
<div class="block">
|
|
For debug/logging only.</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="getDomainList()">
|
|
<h3>getDomainList</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/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">getDomainList</span>()</div>
|
|
<div class="block"><pre>
|
|
The variable domain given as a sorted list of n disjoint intervals
|
|
[min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].
|
|
The most common example being just [min, max].
|
|
If min == max, then this is a constant variable.
|
|
We have:
|
|
- domain_size() is always even.
|
|
- min == domain.front();
|
|
- max == domain.back();
|
|
- for all i < n : min_i <= max_i
|
|
- for all i < n-1 : max_i + 1 < min_{i+1}.
|
|
Note that we check at validation that a variable domain is small enough so
|
|
that we don't run into integer overflow in our algorithms. Because of that,
|
|
you cannot just have "unbounded" variable like [0, kint64max] and should
|
|
try to specify tighter domains.
|
|
</pre>
|
|
|
|
<code>repeated int64 domain = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A list containing the domain.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDomainCount()">
|
|
<h3>getDomainCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getDomainCount</span>()</div>
|
|
<div class="block"><pre>
|
|
The variable domain given as a sorted list of n disjoint intervals
|
|
[min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].
|
|
The most common example being just [min, max].
|
|
If min == max, then this is a constant variable.
|
|
We have:
|
|
- domain_size() is always even.
|
|
- min == domain.front();
|
|
- max == domain.back();
|
|
- for all i < n : min_i <= max_i
|
|
- for all i < n-1 : max_i + 1 < min_{i+1}.
|
|
Note that we check at validation that a variable domain is small enough so
|
|
that we don't run into integer overflow in our algorithms. Because of that,
|
|
you cannot just have "unbounded" variable like [0, kint64max] and should
|
|
try to specify tighter domains.
|
|
</pre>
|
|
|
|
<code>repeated int64 domain = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The count of domain.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDomain(int)">
|
|
<h3>getDomain</h3>
|
|
<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getDomain</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
The variable domain given as a sorted list of n disjoint intervals
|
|
[min, max] and encoded as [min_0, max_0, ..., min_{n-1}, max_{n-1}].
|
|
The most common example being just [min, max].
|
|
If min == max, then this is a constant variable.
|
|
We have:
|
|
- domain_size() is always even.
|
|
- min == domain.front();
|
|
- max == domain.back();
|
|
- for all i < n : min_i <= max_i
|
|
- for all i < n-1 : max_i + 1 < min_{i+1}.
|
|
Note that we check at validation that a variable domain is small enough so
|
|
that we don't run into integer overflow in our algorithms. Because of that,
|
|
you cannot just have "unbounded" variable like [0, kint64max] and should
|
|
try to specify tighter domains.
|
|
</pre>
|
|
|
|
<code>repeated int64 domain = 2;</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 domain at the given index.</dd>
|
|
</dl>
|
|
</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>
|