blob: fb9c9ebc21f39990cab60fb7ccdc616c6e34660f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>RelOptCostImpl (Apache Calcite 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="description" content="declaration: package: org.apache.calcite.plan, class: RelOptCostImpl">
<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>
<div class="about-language"><b>Apache Calcite</b></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="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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.plan</a></div>
<h1 title="Class RelOptCostImpl" class="title">Class RelOptCostImpl</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.plan.RelOptCostImpl</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RelOptCostImpl</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span></div>
<div class="block">RelOptCostImpl provides a default implementation for the <a href="RelOptCost.html" title="interface in org.apache.calcite.plan"><code>RelOptCost</code></a>
interface. It it defined in terms of a single scalar quantity; somewhat
arbitrarily, it returns this scalar for rows processed and zero for both CPU
and I/O.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final <a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></div>
<div class="col-second even-row-color"><code><a href="#FACTORY" class="member-name-link">FACTORY</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double)" class="member-name-link">RelOptCostImpl</a><wbr>(double&nbsp;value)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#divideBy(org.apache.calcite.plan.RelOptCost)" class="member-name-link">divideBy</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;cost)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Computes the ratio between this cost and another cost.</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="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#equals(org.apache.calcite.plan.RelOptCost)" class="member-name-link">equals</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this to another cost.</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="#getCpu()" class="member-name-link">getCpu</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns usage of CPU resources.</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="#getIo()" class="member-name-link">getIo</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns usage of I/O resources.</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="#getRows()" class="member-name-link">getRows</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the number of rows processed; this should not be
confused with the row count produced by a relational expression
(<a href="../rel/RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>RelNode.estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)</code></a>).</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="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</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="#isEqWithEpsilon(org.apache.calcite.plan.RelOptCost)" class="member-name-link">isEqWithEpsilon</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this to another cost, allowing for slight roundoff errors.</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="#isInfinite()" class="member-name-link">isInfinite</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns whether this cost represents an expression that hasn't actually
been implemented (e.g.</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="#isLe(org.apache.calcite.plan.RelOptCost)" class="member-name-link">isLe</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this to another cost.</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="#isLt(org.apache.calcite.plan.RelOptCost)" class="member-name-link">isLt</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Compares this to another cost.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#minus(org.apache.calcite.plan.RelOptCost)" class="member-name-link">minus</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Subtracts another cost from this.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#multiplyBy(double)" class="member-name-link">multiplyBy</a><wbr>(double&nbsp;factor)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Multiplies this cost by a scalar factor.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#plus(org.apache.calcite.plan.RelOptCost)" class="member-name-link">plus</a><wbr>(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds another cost to this.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Forces implementations to override <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link"><code>Object.toString()</code></a> and provide a
good cost rendering to use during tracing.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="FACTORY">
<h3>FACTORY</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></span>&nbsp;<span class="element-name">FACTORY</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(double)">
<h3>RelOptCostImpl</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RelOptCostImpl</span><wbr><span class="parameters">(double&nbsp;value)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getRows()">
<h3>getRows</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getRows</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#getRows()">RelOptCost</a></code></span></div>
<div class="block">Returns the number of rows processed; this should not be
confused with the row count produced by a relational expression
(<a href="../rel/RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)"><code>RelNode.estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)</code></a>).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#getRows()">getRows</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getIo()">
<h3>getIo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getIo</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#getIo()">RelOptCost</a></code></span></div>
<div class="block">Returns usage of I/O resources.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#getIo()">getIo</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getCpu()">
<h3>getCpu</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getCpu</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#getCpu()">RelOptCost</a></code></span></div>
<div class="block">Returns usage of CPU resources.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#getCpu()">getCpu</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isInfinite()">
<h3>isInfinite</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isInfinite</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#isInfinite()">RelOptCost</a></code></span></div>
<div class="block">Returns whether this cost represents an expression that hasn't actually
been implemented (e.g. a pure relational algebra expression) or can't
actually be implemented, e.g. a transfer of data between two disconnected
sites.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#isInfinite()">isInfinite</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isLe(org.apache.calcite.plan.RelOptCost)">
<h3>isLe</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isLe</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#isLe(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Compares this to another cost.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#isLe(org.apache.calcite.plan.RelOptCost)">isLe</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - another cost</dd>
<dt>Returns:</dt>
<dd>true iff this is less than or equal to other cost</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isLt(org.apache.calcite.plan.RelOptCost)">
<h3>isLt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isLt</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#isLt(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Compares this to another cost.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#isLt(org.apache.calcite.plan.RelOptCost)">isLt</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - another cost</dd>
<dt>Returns:</dt>
<dd>true iff this is strictly less than other cost</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(org.apache.calcite.plan.RelOptCost)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#equals(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Compares this to another cost.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#equals(org.apache.calcite.plan.RelOptCost)">equals</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - another cost</dd>
<dt>Returns:</dt>
<dd>true iff this is exactly equal to other cost</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isEqWithEpsilon(org.apache.calcite.plan.RelOptCost)">
<h3>isEqWithEpsilon</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isEqWithEpsilon</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#isEqWithEpsilon(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Compares this to another cost, allowing for slight roundoff errors.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#isEqWithEpsilon(org.apache.calcite.plan.RelOptCost)">isEqWithEpsilon</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - another cost</dd>
<dt>Returns:</dt>
<dd>true iff this is the same as the other cost within a roundoff
margin of error</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="minus(org.apache.calcite.plan.RelOptCost)">
<h3>minus</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span>&nbsp;<span class="element-name">minus</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#minus(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Subtracts another cost from this.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#minus(org.apache.calcite.plan.RelOptCost)">minus</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - another cost</dd>
<dt>Returns:</dt>
<dd>difference between this and other cost</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="plus(org.apache.calcite.plan.RelOptCost)">
<h3>plus</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span>&nbsp;<span class="element-name">plus</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#plus(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Adds another cost to this.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#plus(org.apache.calcite.plan.RelOptCost)">plus</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>other</code> - another cost</dd>
<dt>Returns:</dt>
<dd>sum of this and other cost</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="multiplyBy(double)">
<h3>multiplyBy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></span>&nbsp;<span class="element-name">multiplyBy</span><wbr><span class="parameters">(double&nbsp;factor)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#multiplyBy(double)">RelOptCost</a></code></span></div>
<div class="block">Multiplies this cost by a scalar factor.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#multiplyBy(double)">multiplyBy</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>factor</code> - scalar factor</dd>
<dt>Returns:</dt>
<dd>scalar product of this and factor</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="divideBy(org.apache.calcite.plan.RelOptCost)">
<h3>divideBy</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">divideBy</span><wbr><span class="parameters">(<a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;cost)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#divideBy(org.apache.calcite.plan.RelOptCost)">RelOptCost</a></code></span></div>
<div class="block">Computes the ratio between this cost and another cost.
<p>divideBy is the inverse of <a href="RelOptCost.html#multiplyBy(double)"><code>RelOptCost.multiplyBy(double)</code></a>. For any
finite, non-zero cost and factor f, <code>
cost.divideBy(cost.multiplyBy(f))</code> yields <code>1 / f</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#divideBy(org.apache.calcite.plan.RelOptCost)">divideBy</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Parameters:</dt>
<dd><code>cost</code> - Other cost</dd>
<dt>Returns:</dt>
<dd>Ratio between costs</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="RelOptCost.html#toString()">RelOptCost</a></code></span></div>
<div class="block">Forces implementations to override <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link"><code>Object.toString()</code></a> and provide a
good cost rendering to use during tracing.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RelOptCost.html#toString()">toString</a></code>&nbsp;in interface&nbsp;<code><a href="RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</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 &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>