979 lines
73 KiB
HTML
979 lines
73 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (17) on Thu Mar 03 21:59:09 CET 2022 -->
|
|
<title>LinearObjective.Builder (com.google.ortools:ortools-java 9.3.10440 API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2022-03-03">
|
|
<meta name="description" content="declaration: package: com.google.ortools.sat, class: LinearObjective, class: Builder">
|
|
<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/LinearObjective.Builder.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="Class LinearObjective.Builder" class="title">Class LinearObjective.Builder</h1>
|
|
</div>
|
|
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">com.google.protobuf.AbstractMessageLite.Builder
|
|
<div class="inheritance">com.google.protobuf.AbstractMessage.Builder<BuilderType>
|
|
<div class="inheritance">com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>>
|
|
<div class="inheritance">com.google.ortools.sat.LinearObjective.Builder</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<dl class="notes">
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code>, <code>com.google.protobuf.Message.Builder</code>, <code>com.google.protobuf.MessageLite.Builder</code>, <code>com.google.protobuf.MessageLiteOrBuilder</code>, <code>com.google.protobuf.MessageOrBuilder</code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code></dd>
|
|
</dl>
|
|
<dl class="notes">
|
|
<dt>Enclosing class:</dt>
|
|
<dd><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public static final class </span><span class="element-name type-name-label">LinearObjective.Builder</span>
|
|
<span class="extends-implements">extends com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>>
|
|
implements <a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></span></div>
|
|
<div class="block"><pre>
|
|
The objective of an optimization problem.
|
|
</pre>
|
|
|
|
Protobuf type <code>operations_research.sat.LinearObjective</code></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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel">
|
|
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
|
|
<div class="table-header col-first">Modifier and Type</div>
|
|
<div class="table-header col-second">Method</div>
|
|
<div class="table-header col-last">Description</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAllCoefficients(java.lang.Iterable)" class="member-name-link">addAllCoefficients</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <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>> values)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addAllLiterals(java.lang.Iterable)" class="member-name-link">addAllLiterals</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <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>> values)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addCoefficients(long)" class="member-name-link">addCoefficients</a><wbr>(long value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addLiterals(int)" class="member-name-link">addLiterals</a><wbr>(int value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object)" class="member-name-link">addRepeatedField</a><wbr>(com.google.protobuf.Descriptors.FieldDescriptor field,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#build()" class="member-name-link">build</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildPartial()" class="member-name-link">buildPartial</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearCoefficients()" class="member-name-link">clearCoefficients</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearField(com.google.protobuf.Descriptors.FieldDescriptor)" class="member-name-link">clearField</a><wbr>(com.google.protobuf.Descriptors.FieldDescriptor field)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearLiterals()" class="member-name-link">clearLiterals</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearOffset()" class="member-name-link">clearOffset</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearOneof(com.google.protobuf.Descriptors.OneofDescriptor)" class="member-name-link">clearOneof</a><wbr>(com.google.protobuf.Descriptors.OneofDescriptor oneof)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clearScalingFactor()" class="member-name-link">clearScalingFactor</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoefficients(int)" class="member-name-link">getCoefficients</a><wbr>(int index)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoefficientsCount()" class="member-name-link">getCoefficientsCount</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCoefficientsList()" class="member-name-link">getCoefficientsList</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDefaultInstanceForType()" class="member-name-link">getDefaultInstanceForType</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static final com.google.protobuf.Descriptors.Descriptor</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDescriptor()" class="member-name-link">getDescriptor</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>com.google.protobuf.Descriptors.Descriptor</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescriptorForType()" class="member-name-link">getDescriptorForType</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
|
|
<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-tab4"><code>int</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
|
|
<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-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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-tab4">
|
|
<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-tab4"><code>double</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#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-tab4">
|
|
<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-tab4"><code>double</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
|
|
<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-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
|
|
<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-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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-tab4">
|
|
<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-tab4"><code>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#internalGetFieldAccessorTable()" class="member-name-link">internalGetFieldAccessorTable</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isInitialized()" class="member-name-link">isInitialized</a>()</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mergeFrom(com.google.ortools.sat.LinearObjective)" class="member-name-link">mergeFrom</a><wbr>(<a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a> other)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mergeFrom(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)" class="member-name-link">mergeFrom</a><wbr>(com.google.protobuf.CodedInputStream input,
|
|
com.google.protobuf.ExtensionRegistryLite extensionRegistry)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mergeFrom(com.google.protobuf.Message)" class="member-name-link">mergeFrom</a><wbr>(com.google.protobuf.Message other)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final <a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#mergeUnknownFields(com.google.protobuf.UnknownFieldSet)" class="member-name-link">mergeUnknownFields</a><wbr>(com.google.protobuf.UnknownFieldSet unknownFields)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCoefficients(int,long)" class="member-name-link">setCoefficients</a><wbr>(int index,
|
|
long value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setField(com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object)" class="member-name-link">setField</a><wbr>(com.google.protobuf.Descriptors.FieldDescriptor field,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLiterals(int,int)" class="member-name-link">setLiterals</a><wbr>(int index,
|
|
int value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOffset(double)" class="member-name-link">setOffset</a><wbr>(double value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,int,java.lang.Object)" class="member-name-link">setRepeatedField</a><wbr>(com.google.protobuf.Descriptors.FieldDescriptor field,
|
|
int index,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setScalingFactor(double)" class="member-name-link">setScalingFactor</a><wbr>(double value)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<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-tab4"><code>final <a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUnknownFields(com.google.protobuf.UnknownFieldSet)" class="member-name-link">setUnknownFields</a><wbr>(com.google.protobuf.UnknownFieldSet unknownFields)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.protobuf.GeneratedMessageV3.Builder">Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder</h3>
|
|
<code>getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.protobuf.AbstractMessage.Builder">Methods inherited from class com.google.protobuf.AbstractMessage.Builder</h3>
|
|
<code>findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.protobuf.AbstractMessageLite.Builder">Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder</h3>
|
|
<code>addAll, addAll, mergeFrom, newUninitializedMessageException</code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-com.google.protobuf.MessageLite.Builder">Methods inherited from interface com.google.protobuf.MessageLite.Builder</h3>
|
|
<code>mergeFrom</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, 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="getDescriptor()">
|
|
<h3>getDescriptor</h3>
|
|
<div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">com.google.protobuf.Descriptors.Descriptor</span> <span class="element-name">getDescriptor</span>()</div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="internalGetFieldAccessorTable()">
|
|
<h3>internalGetFieldAccessorTable</h3>
|
|
<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">com.google.protobuf.GeneratedMessageV3.FieldAccessorTable</span> <span class="element-name">internalGetFieldAccessorTable</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>internalGetFieldAccessorTable</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clear()">
|
|
<h3>clear</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clear</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>clear</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>clear</code> in interface <code>com.google.protobuf.MessageLite.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>clear</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDescriptorForType()">
|
|
<h3>getDescriptorForType</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">com.google.protobuf.Descriptors.Descriptor</span> <span class="element-name">getDescriptorForType</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>getDescriptorForType</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>getDescriptorForType</code> in interface <code>com.google.protobuf.MessageOrBuilder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>getDescriptorForType</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getDefaultInstanceForType()">
|
|
<h3>getDefaultInstanceForType</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></span> <span class="element-name">getDefaultInstanceForType</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>getDefaultInstanceForType</code> in interface <code>com.google.protobuf.MessageLiteOrBuilder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>getDefaultInstanceForType</code> in interface <code>com.google.protobuf.MessageOrBuilder</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="build()">
|
|
<h3>build</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></span> <span class="element-name">build</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>build</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>build</code> in interface <code>com.google.protobuf.MessageLite.Builder</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="buildPartial()">
|
|
<h3>buildPartial</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a></span> <span class="element-name">buildPartial</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>buildPartial</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>buildPartial</code> in interface <code>com.google.protobuf.MessageLite.Builder</code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clone()">
|
|
<h3>clone</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clone</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>clone</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>clone</code> in interface <code>com.google.protobuf.MessageLite.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>clone</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setField(com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object)">
|
|
<h3>setField</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setField</span><wbr><span class="parameters">(com.google.protobuf.Descriptors.FieldDescriptor field,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>setField</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>setField</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clearField(com.google.protobuf.Descriptors.FieldDescriptor)">
|
|
<h3>clearField</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clearField</span><wbr><span class="parameters">(com.google.protobuf.Descriptors.FieldDescriptor field)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>clearField</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>clearField</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clearOneof(com.google.protobuf.Descriptors.OneofDescriptor)">
|
|
<h3>clearOneof</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clearOneof</span><wbr><span class="parameters">(com.google.protobuf.Descriptors.OneofDescriptor oneof)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>clearOneof</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>clearOneof</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,int,java.lang.Object)">
|
|
<h3>setRepeatedField</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setRepeatedField</span><wbr><span class="parameters">(com.google.protobuf.Descriptors.FieldDescriptor field,
|
|
int index,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>setRepeatedField</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>setRepeatedField</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object)">
|
|
<h3>addRepeatedField</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">addRepeatedField</span><wbr><span class="parameters">(com.google.protobuf.Descriptors.FieldDescriptor field,
|
|
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> value)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>addRepeatedField</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>addRepeatedField</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="mergeFrom(com.google.protobuf.Message)">
|
|
<h3>mergeFrom</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">mergeFrom</span><wbr><span class="parameters">(com.google.protobuf.Message other)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>mergeFrom</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>mergeFrom</code> in class <code>com.google.protobuf.AbstractMessage.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="mergeFrom(com.google.ortools.sat.LinearObjective)">
|
|
<h3>mergeFrom</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">mergeFrom</span><wbr><span class="parameters">(<a href="LinearObjective.html" title="class in com.google.ortools.sat">LinearObjective</a> other)</span></div>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="isInitialized()">
|
|
<h3>isInitialized</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name">isInitialized</span>()</div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>isInitialized</code> in interface <code>com.google.protobuf.MessageLiteOrBuilder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>isInitialized</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="mergeFrom(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)">
|
|
<h3>mergeFrom</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">mergeFrom</span><wbr><span class="parameters">(com.google.protobuf.CodedInputStream input,
|
|
com.google.protobuf.ExtensionRegistryLite extensionRegistry)</span>
|
|
throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>mergeFrom</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Specified by:</dt>
|
|
<dd><code>mergeFrom</code> in interface <code>com.google.protobuf.MessageLite.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>mergeFrom</code> in class <code>com.google.protobuf.AbstractMessage.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
<dt>Throws:</dt>
|
|
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getLiteralsList()">
|
|
<h3>getLiteralsList</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>></span> <span class="element-name">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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getLiteralsList()">getLiteralsList</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getLiteralsCount()">getLiteralsCount</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getLiterals(int)">getLiterals</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="setLiterals(int,int)">
|
|
<h3>setLiterals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setLiterals</span><wbr><span class="parameters">(int index,
|
|
int value)</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 to set the value at.</dd>
|
|
<dd><code>value</code> - The literals to set.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addLiterals(int)">
|
|
<h3>addLiterals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">addLiterals</span><wbr><span class="parameters">(int value)</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>value</code> - The literals to add.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addAllLiterals(java.lang.Iterable)">
|
|
<h3>addAllLiterals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">addAllLiterals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <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>> values)</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>values</code> - The literals to add.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clearLiterals()">
|
|
<h3>clearLiterals</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clearLiterals</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>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="getCoefficientsList()">
|
|
<h3>getCoefficientsList</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getCoefficientsList()">getCoefficientsList</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getCoefficientsCount()">getCoefficientsCount</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getCoefficients(int)">getCoefficients</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="setCoefficients(int,long)">
|
|
<h3>setCoefficients</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setCoefficients</span><wbr><span class="parameters">(int index,
|
|
long value)</span></div>
|
|
<div class="block"><code>repeated int64 coefficients = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>index</code> - The index to set the value at.</dd>
|
|
<dd><code>value</code> - The coefficients to set.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addCoefficients(long)">
|
|
<h3>addCoefficients</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">addCoefficients</span><wbr><span class="parameters">(long value)</span></div>
|
|
<div class="block"><code>repeated int64 coefficients = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - The coefficients to add.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="addAllCoefficients(java.lang.Iterable)">
|
|
<h3>addAllCoefficients</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">addAllCoefficients</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><? extends <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>> values)</span></div>
|
|
<div class="block"><code>repeated int64 coefficients = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>values</code> - The coefficients to add.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clearCoefficients()">
|
|
<h3>clearCoefficients</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clearCoefficients</span>()</div>
|
|
<div class="block"><code>repeated int64 coefficients = 2;</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasOffset()">
|
|
<h3>hasOffset</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#hasOffset()">hasOffset</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getOffset()">getOffset</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The offset.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setOffset(double)">
|
|
<h3>setOffset</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setOffset</span><wbr><span class="parameters">(double value)</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>Parameters:</dt>
|
|
<dd><code>value</code> - The offset to set.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clearOffset()">
|
|
<h3>clearOffset</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clearOffset</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>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="hasScalingFactor()">
|
|
<h3>hasScalingFactor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#hasScalingFactor()">hasScalingFactor</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<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="modifiers">public</span> <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>Specified by:</dt>
|
|
<dd><code><a href="LinearObjectiveOrBuilder.html#getScalingFactor()">getScalingFactor</a></code> in interface <code><a href="LinearObjectiveOrBuilder.html" title="interface in com.google.ortools.sat">LinearObjectiveOrBuilder</a></code></dd>
|
|
<dt>Returns:</dt>
|
|
<dd>The scalingFactor.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setScalingFactor(double)">
|
|
<h3>setScalingFactor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setScalingFactor</span><wbr><span class="parameters">(double value)</span></div>
|
|
<div class="block"><code>optional double scaling_factor = 4 [default = 1];</code></div>
|
|
<dl class="notes">
|
|
<dt>Parameters:</dt>
|
|
<dd><code>value</code> - The scalingFactor to set.</dd>
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="clearScalingFactor()">
|
|
<h3>clearScalingFactor</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">clearScalingFactor</span>()</div>
|
|
<div class="block"><code>optional double scaling_factor = 4 [default = 1];</code></div>
|
|
<dl class="notes">
|
|
<dt>Returns:</dt>
|
|
<dd>This builder for chaining.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="setUnknownFields(com.google.protobuf.UnknownFieldSet)">
|
|
<h3>setUnknownFields</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">setUnknownFields</span><wbr><span class="parameters">(com.google.protobuf.UnknownFieldSet unknownFields)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>setUnknownFields</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>setUnknownFields</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="mergeUnknownFields(com.google.protobuf.UnknownFieldSet)">
|
|
<h3>mergeUnknownFields</h3>
|
|
<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type"><a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a></span> <span class="element-name">mergeUnknownFields</span><wbr><span class="parameters">(com.google.protobuf.UnknownFieldSet unknownFields)</span></div>
|
|
<dl class="notes">
|
|
<dt>Specified by:</dt>
|
|
<dd><code>mergeUnknownFields</code> in interface <code>com.google.protobuf.Message.Builder</code></dd>
|
|
<dt>Overrides:</dt>
|
|
<dd><code>mergeUnknownFields</code> in class <code>com.google.protobuf.GeneratedMessageV3.Builder<<a href="LinearObjective.Builder.html" title="class in com.google.ortools.sat">LinearObjective.Builder</a>></code></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>
|