358 lines
19 KiB
HTML
358 lines
19 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Thu Mar 03 21:59:09 CET 2022 -->
|
|
<title>LinearObjectiveOrBuilder (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: LinearObjectiveOrBuilder">
|
|
<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/LinearObjectiveOrBuilder.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 LinearObjectiveOrBuilder" class="title">Interface LinearObjectiveOrBuilder</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="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></code>, <code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">LinearObjectiveOrBuilder</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="#getCoefficients(int)" class="member-name-link">getCoefficients</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 int64 coefficients = 2;</code></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="#getCoefficientsCount()" class="member-name-link">getCoefficientsCount</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 int64 coefficients = 2;</code></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="#getCoefficientsList()" class="member-name-link">getCoefficientsList</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 int64 coefficients = 2;</code></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="#getLiterals(int)" class="member-name-link">getLiterals</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 goal is always to minimize the linear Boolean formula defined by these
|
|
two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
|
|
literal_i is true in a given assignment.</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="#getLiteralsCount()" class="member-name-link">getLiteralsCount</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 goal is always to minimize the linear Boolean formula defined by these
|
|
two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
|
|
literal_i is true in a given assignment.</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="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-tab3"><code><a href="#getLiteralsList()" class="member-name-link">getLiteralsList</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 goal is always to minimize the linear Boolean formula defined by these
|
|
two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
|
|
literal_i is true in a given assignment.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOffset()" class="member-name-link">getOffset</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 a given variable assignment, the "real" problem objective value is
|
|
'scaling_factor * (minimization_objective + offset)' where
|
|
'minimization_objective is the one defined just above.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getScalingFactor()" class="member-name-link">getScalingFactor</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>optional double scaling_factor = 4 [default = 1];</code></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="#hasOffset()" class="member-name-link">hasOffset</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 a given variable assignment, the "real" problem objective value is
|
|
'scaling_factor * (minimization_objective + offset)' where
|
|
'minimization_objective is the one defined just above.</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="#hasScalingFactor()" class="member-name-link">hasScalingFactor</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>optional double scaling_factor = 4 [default = 1];</code></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="getLiteralsList()">
|
|
<h3>getLiteralsList</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">getLiteralsList</span>()</div>
|
|
<div class="block"><pre>
|
|
The goal is always to minimize the linear Boolean formula defined by these
|
|
two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
|
|
literal_i is true in a given assignment.
|
|
Note that the same variable shouldn't appear twice and that zero
|
|
coefficients are not allowed.
|
|
</pre>
|
|
|
|
<code>repeated int32 literals = 1;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A list containing the literals.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLiteralsCount()">
|
|
<h3>getLiteralsCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getLiteralsCount</span>()</div>
|
|
<div class="block"><pre>
|
|
The goal is always to minimize the linear Boolean formula defined by these
|
|
two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
|
|
literal_i is true in a given assignment.
|
|
Note that the same variable shouldn't appear twice and that zero
|
|
coefficients are not allowed.
|
|
</pre>
|
|
|
|
<code>repeated int32 literals = 1;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The count of literals.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLiterals(int)">
|
|
<h3>getLiterals</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getLiterals</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><pre>
|
|
The goal is always to minimize the linear Boolean formula defined by these
|
|
two fields: sum_i literal_i * coefficient_i where literal_i is 1 iff
|
|
literal_i is true in a given assignment.
|
|
Note that the same variable shouldn't appear twice and that zero
|
|
coefficients are not allowed.
|
|
</pre>
|
|
|
|
<code>repeated int32 literals = 1;</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 literals at the given index.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCoefficientsList()">
|
|
<h3>getCoefficientsList</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">getCoefficientsList</span>()</div>
|
|
<div class="block"><code>repeated int64 coefficients = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>A list containing the coefficients.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCoefficientsCount()">
|
|
<h3>getCoefficientsCount</h3>
|
|
<div class="member-signature"><span class="return-type">int</span> <span class="element-name">getCoefficientsCount</span>()</div>
|
|
<div class="block"><code>repeated int64 coefficients = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The count of coefficients.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCoefficients(int)">
|
|
<h3>getCoefficients</h3>
|
|
<div class="member-signature"><span class="return-type">long</span> <span class="element-name">getCoefficients</span><wbr><span class="parameters">(int index)</span></div>
|
|
<div class="block"><code>repeated int64 coefficients = 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 coefficients at the given index.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasOffset()">
|
|
<h3>hasOffset</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasOffset</span>()</div>
|
|
<div class="block"><pre>
|
|
For a given variable assignment, the "real" problem objective value is
|
|
'scaling_factor * (minimization_objective + offset)' where
|
|
'minimization_objective is the one defined just above.
|
|
Note that this is not what we minimize, but it is what we display.
|
|
In particular if scaling_factor is negative, then the "real" problem is
|
|
a maximization problem, even if the "internal" objective is minimized.
|
|
</pre>
|
|
|
|
<code>optional double offset = 3 [default = 0];</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Whether the offset field is set.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getOffset()">
|
|
<h3>getOffset</h3>
|
|
<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getOffset</span>()</div>
|
|
<div class="block"><pre>
|
|
For a given variable assignment, the "real" problem objective value is
|
|
'scaling_factor * (minimization_objective + offset)' where
|
|
'minimization_objective is the one defined just above.
|
|
Note that this is not what we minimize, but it is what we display.
|
|
In particular if scaling_factor is negative, then the "real" problem is
|
|
a maximization problem, even if the "internal" objective is minimized.
|
|
</pre>
|
|
|
|
<code>optional double offset = 3 [default = 0];</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The offset.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasScalingFactor()">
|
|
<h3>hasScalingFactor</h3>
|
|
<div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">hasScalingFactor</span>()</div>
|
|
<div class="block"><code>optional double scaling_factor = 4 [default = 1];</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>Whether the scalingFactor field is set.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getScalingFactor()">
|
|
<h3>getScalingFactor</h3>
|
|
<div class="member-signature"><span class="return-type">double</span> <span class="element-name">getScalingFactor</span>()</div>
|
|
<div class="block"><code>optional double scaling_factor = 4 [default = 1];</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>The scalingFactor.</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>
|