Google Git
Sign in
apache / calcite-site / 9b57fedab8ff10b94b4ee232beb15b45701f505c / . / apidocs / org / apache / calcite / plan / volcano / VolcanoCost.html
blob: 7126f6fd3ef85806906b9ea78e6bb775c4e174f7 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>VolcanoCost (Apache Calcite API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="VolcanoCost (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/VolcanoCost.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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="subNavList">
<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>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.plan.volcano</a></div>
<h2 title="Class VolcanoCost" class="title">Class VolcanoCost</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.plan.volcano.VolcanoCost</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></dd>
</dl>
<hr>
<pre>class <span class="typeNameLabel">VolcanoCost</span>
extends java.lang.Object
implements <a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></pre>
<div class="block"><code>VolcanoCost</code> represents the cost of a plan node.
<p>This class is immutable: none of the methods modify any member
variables.</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="VolcanoCost.Factory.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost.Factory</a></span></code></th>
<td class="colLast">
<div class="block">Implementation of <a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan"><code>RelOptCostFactory</code></a>
that creates <a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano"><code>VolcanoCost</code></a>s.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cpu">cpu</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FACTORY">FACTORY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static <a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#HUGE">HUGE</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) static <a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#INFINITY">INFINITY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#io">io</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rowCount">rowCount</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) static <a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#TINY">TINY</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) static <a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ZERO">ZERO</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(double,double,double)">VolcanoCost</a></span>&#8203;(double&nbsp;rowCount,
double&nbsp;cpu,
double&nbsp;io)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#divideBy(org.apache.calcite.plan.RelOptCost)">divideBy</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;cost)</code></th>
<td class="colLast">
<div class="block">Computes the ratio between this cost and another cost.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>&#8203;(java.lang.Object&nbsp;obj)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(org.apache.calcite.plan.RelOptCost)">equals</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Compares this to another cost.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCpu()">getCpu</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getIo()">getIo</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRows()">getRows</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEqWithEpsilon(org.apache.calcite.plan.RelOptCost)">isEqWithEpsilon</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Compares this to another cost, allowing for slight roundoff errors.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isInfinite()">isInfinite</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLe(org.apache.calcite.plan.RelOptCost)">isLe</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Compares this to another cost.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isLt(org.apache.calcite.plan.RelOptCost)">isLt</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Compares this to another cost.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#minus(org.apache.calcite.plan.RelOptCost)">minus</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Subtracts another cost from this.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#multiplyBy(double)">multiplyBy</a></span>&#8203;(double&nbsp;factor)</code></th>
<td class="colLast">
<div class="block">Multiplies this cost by a scalar factor.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#plus(org.apache.calcite.plan.RelOptCost)">plus</a></span>&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</code></th>
<td class="colLast">
<div class="block">Adds another cost to this.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">
<div class="block">Forces implementations to override <code>Object.toString()</code> and provide a
good cost rendering to use during tracing.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="INFINITY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INFINITY</h4>
<pre>static final&nbsp;<a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a> INFINITY</pre>
</li>
</ul>
<a id="HUGE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HUGE</h4>
<pre>static final&nbsp;<a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a> HUGE</pre>
</li>
</ul>
<a id="ZERO">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZERO</h4>
<pre>static final&nbsp;<a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a> ZERO</pre>
</li>
</ul>
<a id="TINY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TINY</h4>
<pre>static final&nbsp;<a href="VolcanoCost.html" title="class in org.apache.calcite.plan.volcano">VolcanoCost</a> TINY</pre>
</li>
</ul>
<a id="FACTORY">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FACTORY</h4>
<pre>public static final&nbsp;<a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a> FACTORY</pre>
</li>
</ul>
<a id="cpu">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cpu</h4>
<pre>final&nbsp;double cpu</pre>
</li>
</ul>
<a id="io">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>io</h4>
<pre>final&nbsp;double io</pre>
</li>
</ul>
<a id="rowCount">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rowCount</h4>
<pre>final&nbsp;double rowCount</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(double,double,double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VolcanoCost</h4>
<pre>VolcanoCost&#8203;(double&nbsp;rowCount,
double&nbsp;cpu,
double&nbsp;io)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getCpu()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCpu</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getCpu()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>usage of CPU resources</dd>
</dl>
</li>
</ul>
<a id="isInfinite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isInfinite</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isInfinite()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff 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</dd>
</dl>
</li>
</ul>
<a id="getIo()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIo</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getIo()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>usage of I/O resources</dd>
</dl>
</li>
</ul>
<a id="isLe(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLe</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isLe&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff this is less than or equal to other cost</dd>
</dl>
</li>
</ul>
<a id="isLt(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLt</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isLt&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff this is strictly less than other cost</dd>
</dl>
</li>
</ul>
<a id="getRows()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRows</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;getRows()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>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>)</dd>
</dl>
</li>
</ul>
<a id="hashCode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hashCode</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;hashCode()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="equals(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff this is exactly equal to other cost</dd>
</dl>
</li>
</ul>
<a id="equals(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;equals&#8203;(java.lang.Object&nbsp;obj)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a id="isEqWithEpsilon(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEqWithEpsilon</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isEqWithEpsilon&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true iff this is the same as the other cost within a roundoff
margin of error</dd>
</dl>
</li>
</ul>
<a id="minus(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>minus</h4>
<pre class="methodSignature">public&nbsp;<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;minus&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>difference between this and other cost</dd>
</dl>
</li>
</ul>
<a id="multiplyBy(double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>multiplyBy</h4>
<pre class="methodSignature">public&nbsp;<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;multiplyBy&#8203;(double&nbsp;factor)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>factor</code> - scalar factor</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>scalar product of this and factor</dd>
</dl>
</li>
</ul>
<a id="divideBy(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>divideBy</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;divideBy&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;cost)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>cost</code> - Other cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ratio between costs</dd>
</dl>
</li>
</ul>
<a id="plus(org.apache.calcite.plan.RelOptCost)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>plus</h4>
<pre class="methodSignature">public&nbsp;<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;plus&#8203;(<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;other)</pre>
<div class="block"><span class="descfrmTypeLabel">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>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="paramLabel">Parameters:</span></dt>
<dd><code>other</code> - another cost</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>sum of this and other cost</dd>
</dl>
</li>
</ul>
<a id="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;toString()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptCost.html#toString()">RelOptCost</a></code></span></div>
<div class="block">Forces implementations to override <code>Object.toString()</code> and provide a
good cost rendering to use during tracing.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></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><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/VolcanoCost.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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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="subNavList">
<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>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>