blob: 2c534e6cc1634125e3afd2148f8ec4565788788c [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RelSubset (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="RelSubset (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,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9,"i20":10,"i21":10,"i22":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/RelSubset.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 RelSubset" class="title">Class RelSubset</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">org.apache.calcite.rel.AbstractRelNode</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.plan.volcano.RelSubset</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Cloneable</code>, <code><a href="../RelOptNode.html" title="interface in org.apache.calcite.plan">RelOptNode</a></code>, <code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">RelSubset</span>
extends <a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></pre>
<div class="block">Subset of an equivalence class where all relational expressions have the
same physical properties.
<p>Physical properties are instances of the <a href="../RelTraitSet.html" title="class in org.apache.calcite.plan"><code>RelTraitSet</code></a>, and consist
of traits such as calling convention and collation (sort-order).
<p>For some traits, a relational expression can have more than one instance.
For example, R can be sorted on both [X] and [Y, Z]. In which case, R would
belong to the sub-sets for [X] and [Y, Z]; and also the leading edges [Y] and
[].</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a>,
<a href="RelSet.html" title="class in org.apache.calcite.plan.volcano"><code>RelSet</code></a>,
<a href="../RelTrait.html" title="interface in org.apache.calcite.plan"><code>RelTrait</code></a></dd>
</dl>
</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>(package private) static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelSubset.CheapestPlanReplacer.html" title="class in org.apache.calcite.plan.volcano">RelSubset.CheapestPlanReplacer</a></span></code></th>
<td class="colLast">
<div class="block">Visitor which walks over a tree of <a href="RelSet.html" title="class in org.apache.calcite.plan.volcano"><code>RelSet</code></a>s, replacing each node
with the cheapest implementation of the expression.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelSubset.DeadEndFinder.html" title="class in org.apache.calcite.plan.volcano">RelSubset.DeadEndFinder</a></span></code></th>
<td class="colLast">
<div class="block">Identifies the leaf-most non-implementable nodes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.rel.RelNode">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.rel.<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></h3>
<code><a href="../../rel/RelNode.Context.html" title="interface in org.apache.calcite.rel">RelNode.Context</a></code></li>
</ul>
</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) <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#best">best</a></span></code></th>
<td class="colLast">
<div class="block">best known plan</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) <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="#bestCost">bestCost</a></span></code></th>
<td class="colLast">
<div class="block">cost of best known plan (it may have improved since)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#boosted">boosted</a></span></code></th>
<td class="colLast">
<div class="block">Flag indicating whether this RelSubset's importance was artificially
boosted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private static org.slf4j.Logger</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#LOGGER">LOGGER</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>(package private) <a href="RelSet.html" title="class in org.apache.calcite.plan.volcano">RelSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set">set</a></span></code></th>
<td class="colLast">
<div class="block">The set this subset belongs to.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>(package private) long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#timestamp">timestamp</a></span></code></th>
<td class="colLast">
<div class="block">Timestamp for metadata validity</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.rel.AbstractRelNode">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.calcite.rel.<a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3>
<code><a href="../../rel/AbstractRelNode.html#digest">digest</a>, <a href="../../rel/AbstractRelNode.html#id">id</a>, <a href="../../rel/AbstractRelNode.html#rowType">rowType</a>, <a href="../../rel/AbstractRelNode.html#traitSet">traitSet</a></code></li>
</ul>
</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(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.volcano.RelSet,org.apache.calcite.plan.RelTraitSet)">RelSubset</a></span>&#8203;(<a href="../RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a>&nbsp;cluster,
<a href="RelSet.html" title="class in org.apache.calcite.plan.volcano">RelSet</a>&nbsp;set,
<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;traits)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(org.apache.calcite.rel.RelNode)">add</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
<td class="colLast">
<div class="block">Adds expression <code>rel</code> to this subset.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>(package private) <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#buildCheapestPlan(org.apache.calcite.plan.volcano.VolcanoPlanner)">buildCheapestPlan</a></span>&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block">Recursively builds a tree consisting of the cheapest plan at each node.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectVariablesSet(java.util.Set)">collectVariablesSet</a></span>&#8203;(java.util.Set&lt;<a href="../../rel/core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</code></th>
<td class="colLast">
<div class="block">Collects variables set by this expression.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a></span>&#8203;(java.util.Set&lt;<a href="../../rel/core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</code></th>
<td class="colLast">
<div class="block">Collects variables known to be used by this expression or its
descendants.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeBestCost(org.apache.calcite.plan.RelOptPlanner)">computeBestCost</a></span>&#8203;(<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block">Computes the best <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> in this subset.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#computeDigest()">computeDigest</a></span>()</code></th>
<td class="colLast">
<div class="block">Computes the digest.</div>
</td>
</tr>
<tr id="i6" 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="#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></span>&#8203;(<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Returns the cost of this plan (not including children).</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></span>&#8203;(<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;traitSet,
java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;inputs)</code></th>
<td class="colLast">
<div class="block">Creates a copy of this relational expression, perhaps changing traits and
inputs.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>protected <a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#deriveRowType()">deriveRowType</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></span>&#8203;(<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</code></th>
<td class="colLast">
<div class="block">Returns an estimate of the number of rows this relational expression will
return.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#explain(org.apache.calcite.rel.RelWriter)">explain</a></span>&#8203;(<a href="../../rel/RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a>&nbsp;pw)</code></th>
<td class="colLast">
<div class="block">Describes the inputs and attributes of this relational expression.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBest()">getBest</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOriginal()">getOriginal</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>java.util.Collection&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParentRels()">getParentRels</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a list of relational expressions one of whose children is this
subset.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>(package private) java.util.Set&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParents()">getParents</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the collection of RelNodes one of whose inputs is in this
subset.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>(package private) java.util.Set&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getParentSubsets(org.apache.calcite.plan.volcano.VolcanoPlanner)">getParentSubsets</a></span>&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">
<div class="block">Returns the collection of distinct subsets that contain a RelNode one
of whose inputs is in this subset.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelList()">getRelList</a></span>()</code></th>
<td class="colLast">
<div class="block">As <a href="#getRels()"><code>getRels()</code></a> but returns a list.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.Iterable&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRels()">getRels</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the rel nodes in this rel subset.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>(package private) <a href="RelSet.html" title="class in org.apache.calcite.plan.volcano">RelSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSet()">getSet</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>private static java.util.List&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#inputSubsets(org.apache.calcite.rel.RelNode)">inputSubsets</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;parent)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#propagateBoostRemoval(org.apache.calcite.plan.volcano.VolcanoPlanner)">propagateBoostRemoval</a></span>&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#propagateCostImprovements(org.apache.calcite.plan.volcano.VolcanoPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery,org.apache.calcite.rel.RelNode,java.util.Set)">propagateCostImprovements</a></span>&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner,
<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
java.util.Set&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;&nbsp;activeSet)</code></th>
<td class="colLast">
<div class="block">Checks whether a relexp has made its subset cheaper, and if it so,
recursively checks whether that subset's parents have gotten cheaper.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#propagateCostImprovements0(org.apache.calcite.plan.volcano.VolcanoPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery,org.apache.calcite.rel.RelNode,java.util.Set)">propagateCostImprovements0</a></span>&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner,
<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
java.util.Set&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;&nbsp;activeSet)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.rel.AbstractRelNode">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.rel.<a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></h3>
<code><a href="../../rel/AbstractRelNode.html#accept(org.apache.calcite.rel.RelShuttle)">accept</a>, <a href="../../rel/AbstractRelNode.html#accept(org.apache.calcite.rex.RexShuttle)">accept</a>, <a href="../../rel/AbstractRelNode.html#childrenAccept(org.apache.calcite.rel.RelVisitor)">childrenAccept</a>, <a href="../../rel/AbstractRelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner)">computeSelfCost</a>, <a href="../../rel/AbstractRelNode.html#equals(java.lang.Object)">equals</a>, <a href="../../rel/AbstractRelNode.html#explainTerms(org.apache.calcite.rel.RelWriter)">explainTerms</a>, <a href="../../rel/AbstractRelNode.html#getChildExps()">getChildExps</a>, <a href="../../rel/AbstractRelNode.html#getCluster()">getCluster</a>, <a href="../../rel/AbstractRelNode.html#getCollationList()">getCollationList</a>, <a href="../../rel/AbstractRelNode.html#getConvention()">getConvention</a>, <a href="../../rel/AbstractRelNode.html#getCorrelVariable()">getCorrelVariable</a>, <a href="../../rel/AbstractRelNode.html#getDescription()">getDescription</a>, <a href="../../rel/AbstractRelNode.html#getDigest()">getDigest</a>, <a href="../../rel/AbstractRelNode.html#getExpectedInputRowType(int)">getExpectedInputRowType</a>, <a href="../../rel/AbstractRelNode.html#getId()">getId</a>, <a href="../../rel/AbstractRelNode.html#getInput(int)">getInput</a>, <a href="../../rel/AbstractRelNode.html#getInputs()">getInputs</a>, <a href="../../rel/AbstractRelNode.html#getQuery()">getQuery</a>, <a href="../../rel/AbstractRelNode.html#getRelTypeName()">getRelTypeName</a>, <a href="../../rel/AbstractRelNode.html#getRows()">getRows</a>, <a href="../../rel/AbstractRelNode.html#getRowType()">getRowType</a>, <a href="../../rel/AbstractRelNode.html#getTable()">getTable</a>, <a href="../../rel/AbstractRelNode.html#getTraitSet()">getTraitSet</a>, <a href="../../rel/AbstractRelNode.html#getVariablesSet()">getVariablesSet</a>, <a href="../../rel/AbstractRelNode.html#getVariablesStopped()">getVariablesStopped</a>, <a href="../../rel/AbstractRelNode.html#hashCode()">hashCode</a>, <a href="../../rel/AbstractRelNode.html#isDistinct()">isDistinct</a>, <a href="../../rel/AbstractRelNode.html#isKey(org.apache.calcite.util.ImmutableBitSet)">isKey</a>, <a href="../../rel/AbstractRelNode.html#isValid(boolean)">isValid</a>, <a href="../../rel/AbstractRelNode.html#isValid(org.apache.calcite.util.Litmus,org.apache.calcite.rel.RelNode.Context)">isValid</a>, <a href="../../rel/AbstractRelNode.html#metadata(java.lang.Class,org.apache.calcite.rel.metadata.RelMetadataQuery)">metadata</a>, <a href="../../rel/AbstractRelNode.html#onRegister(org.apache.calcite.plan.RelOptPlanner)">onRegister</a>, <a href="../../rel/AbstractRelNode.html#recomputeDigest()">recomputeDigest</a>, <a href="../../rel/AbstractRelNode.html#register(org.apache.calcite.plan.RelOptPlanner)">register</a>, <a href="../../rel/AbstractRelNode.html#replaceInput(int,org.apache.calcite.rel.RelNode)">replaceInput</a>, <a href="../../rel/AbstractRelNode.html#sole(java.util.List)">sole</a>, <a href="../../rel/AbstractRelNode.html#toString()">toString</a></code></li>
</ul>
<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="LOGGER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>LOGGER</h4>
<pre>private static final&nbsp;org.slf4j.Logger LOGGER</pre>
</li>
</ul>
<a id="bestCost">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>bestCost</h4>
<pre><a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a> bestCost</pre>
<div class="block">cost of best known plan (it may have improved since)</div>
</li>
</ul>
<a id="set">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>final&nbsp;<a href="RelSet.html" title="class in org.apache.calcite.plan.volcano">RelSet</a> set</pre>
<div class="block">The set this subset belongs to.</div>
</li>
</ul>
<a id="best">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>best</h4>
<pre><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a> best</pre>
<div class="block">best known plan</div>
</li>
</ul>
<a id="timestamp">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>timestamp</h4>
<pre>long timestamp</pre>
<div class="block">Timestamp for metadata validity</div>
</li>
</ul>
<a id="boosted">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>boosted</h4>
<pre>boolean boosted</pre>
<div class="block">Flag indicating whether this RelSubset's importance was artificially
boosted.</div>
</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;(org.apache.calcite.plan.RelOptCluster,org.apache.calcite.plan.volcano.RelSet,org.apache.calcite.plan.RelTraitSet)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RelSubset</h4>
<pre>RelSubset&#8203;(<a href="../RelOptCluster.html" title="class in org.apache.calcite.plan">RelOptCluster</a>&nbsp;cluster,
<a href="RelSet.html" title="class in org.apache.calcite.plan.volcano">RelSet</a>&nbsp;set,
<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;traits)</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="computeBestCost(org.apache.calcite.plan.RelOptPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeBestCost</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;computeBestCost&#8203;(<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner)</pre>
<div class="block">Computes the best <a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel"><code>RelNode</code></a> in this subset.
<p>Only necessary when a subset is created in a set that has subsets that
subsume it. Rationale:</p>
<ol>
<li>If the are no subsuming subsets, the subset is initially empty.</li>
<li>After creation, <code>best</code> and <code>bestCost</code> are maintained
incrementally by <a href="#propagateCostImprovements0(org.apache.calcite.plan.volcano.VolcanoPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery,org.apache.calcite.rel.RelNode,java.util.Set)"><code>propagateCostImprovements0(org.apache.calcite.plan.volcano.VolcanoPlanner, org.apache.calcite.rel.metadata.RelMetadataQuery, org.apache.calcite.rel.RelNode, java.util.Set&lt;org.apache.calcite.plan.volcano.RelSubset&gt;)</code></a> and
<a href="RelSet.html#mergeWith(org.apache.calcite.plan.volcano.VolcanoPlanner,org.apache.calcite.plan.volcano.RelSet)"><code>RelSet.mergeWith(VolcanoPlanner, RelSet)</code></a>.</li>
</ol></div>
</li>
</ul>
<a id="getBest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBest</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;getBest()</pre>
</li>
</ul>
<a id="getOriginal()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOriginal</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;getOriginal()</pre>
</li>
</ul>
<a id="copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>copy</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;copy&#8203;(<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;traitSet,
java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;inputs)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../rel/RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">RelNode</a></code></span></div>
<div class="block">Creates a copy of this relational expression, perhaps changing traits and
inputs.
<p>Sub-classes with other important attributes are encouraged to create
variants of this method with more parameters.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../rel/RelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code>&nbsp;in interface&nbsp;<code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#copy(org.apache.calcite.plan.RelTraitSet,java.util.List)">copy</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>traitSet</code> - Trait set</dd>
<dd><code>inputs</code> - Inputs</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Copy of this relational expression, substituting traits and
inputs</dd>
</dl>
</li>
</ul>
<a id="computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeSelfCost</h4>
<pre class="methodSignature">public&nbsp;<a href="../RelOptCost.html" title="interface in org.apache.calcite.plan">RelOptCost</a>&nbsp;computeSelfCost&#8203;(<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a>&nbsp;planner,
<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../rel/RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div>
<div class="block">Returns the cost of this plan (not including children). The base
implementation throws an error; derived classes should override.
<p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use
<a href="../../rel/metadata/RelMetadataQuery.html#getNonCumulativeCost(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a
chance to override the rel's default ideas about cost.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../rel/RelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code>&nbsp;in interface&nbsp;<code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#computeSelfCost(org.apache.calcite.plan.RelOptPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery)">computeSelfCost</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planner</code> - Planner for cost calculation</dd>
<dd><code>mq</code> - Metadata query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Cost of this plan (not including children)</dd>
</dl>
</li>
</ul>
<a id="estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>estimateRowCount</h4>
<pre class="methodSignature">public&nbsp;double&nbsp;estimateRowCount&#8203;(<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../rel/RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">RelNode</a></code></span></div>
<div class="block">Returns an estimate of the number of rows this relational expression will
return.
<p>NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use
<a href="../../rel/metadata/RelMetadataQuery.html#getRowCount(org.apache.calcite.rel.RelNode)"><code>RelMetadataQuery.getRowCount(org.apache.calcite.rel.RelNode)</code></a>, which gives plugins a chance to
override the rel's default ideas about row count.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../rel/RelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code>&nbsp;in interface&nbsp;<code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#estimateRowCount(org.apache.calcite.rel.metadata.RelMetadataQuery)">estimateRowCount</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mq</code> - Metadata query</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Estimate of the number of rows this relational expression will
return</dd>
</dl>
</li>
</ul>
<a id="explain(org.apache.calcite.rel.RelWriter)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>explain</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;explain&#8203;(<a href="../../rel/RelWriter.html" title="interface in org.apache.calcite.rel">RelWriter</a>&nbsp;pw)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../rel/RelNode.html#explain(org.apache.calcite.rel.RelWriter)">RelNode</a></code></span></div>
<div class="block">Describes the inputs and attributes of this relational expression.
Each node should call <code>super.explain</code>, then call the
<a href="../../rel/RelWriter.html#input(java.lang.String,org.apache.calcite.rel.RelNode)"><code>RelWriter.input(String, RelNode)</code></a>
and
<a href="../../rel/externalize/RelWriterImpl.html#item(java.lang.String,java.lang.Object)"><code>RelWriterImpl.item(String, Object)</code></a>
methods for each input and attribute.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../rel/RelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a></code>&nbsp;in interface&nbsp;<code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#explain(org.apache.calcite.rel.RelWriter)">explain</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pw</code> - Plan writer</dd>
</dl>
</li>
</ul>
<a id="computeDigest()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>computeDigest</h4>
<pre class="methodSignature">protected&nbsp;java.lang.String&nbsp;computeDigest()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../rel/AbstractRelNode.html#computeDigest()">AbstractRelNode</a></code></span></div>
<div class="block">Computes the digest. Does not modify this object.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#computeDigest()">computeDigest</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Digest</dd>
</dl>
</li>
</ul>
<a id="deriveRowType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>deriveRowType</h4>
<pre class="methodSignature">protected&nbsp;<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&nbsp;deriveRowType()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#deriveRowType()">deriveRowType</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
</dl>
</li>
</ul>
<a id="getParents()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParents</h4>
<pre class="methodSignature">java.util.Set&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;getParents()</pre>
<div class="block">Returns the collection of RelNodes one of whose inputs is in this
subset.</div>
</li>
</ul>
<a id="getParentSubsets(org.apache.calcite.plan.volcano.VolcanoPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentSubsets</h4>
<pre class="methodSignature">java.util.Set&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;&nbsp;getParentSubsets&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner)</pre>
<div class="block">Returns the collection of distinct subsets that contain a RelNode one
of whose inputs is in this subset.</div>
</li>
</ul>
<a id="inputSubsets(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>inputSubsets</h4>
<pre class="methodSignature">private static&nbsp;java.util.List&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;&nbsp;inputSubsets&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;parent)</pre>
</li>
</ul>
<a id="getParentRels()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParentRels</h4>
<pre class="methodSignature">public&nbsp;java.util.Collection&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;getParentRels()</pre>
<div class="block">Returns a list of relational expressions one of whose children is this
subset. The elements of the list are distinct.</div>
</li>
</ul>
<a id="getSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSet</h4>
<pre class="methodSignature"><a href="RelSet.html" title="class in org.apache.calcite.plan.volcano">RelSet</a>&nbsp;getSet()</pre>
</li>
</ul>
<a id="add(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature">void&nbsp;add&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
<div class="block">Adds expression <code>rel</code> to this subset.</div>
</li>
</ul>
<a id="buildCheapestPlan(org.apache.calcite.plan.volcano.VolcanoPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildCheapestPlan</h4>
<pre class="methodSignature"><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;buildCheapestPlan&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner)</pre>
<div class="block">Recursively builds a tree consisting of the cheapest plan at each node.</div>
</li>
</ul>
<a id="propagateCostImprovements(org.apache.calcite.plan.volcano.VolcanoPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery,org.apache.calcite.rel.RelNode,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propagateCostImprovements</h4>
<pre class="methodSignature">void&nbsp;propagateCostImprovements&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner,
<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
java.util.Set&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;&nbsp;activeSet)</pre>
<div class="block">Checks whether a relexp has made its subset cheaper, and if it so,
recursively checks whether that subset's parents have gotten cheaper.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planner</code> - Planner</dd>
<dd><code>mq</code> - Metadata query</dd>
<dd><code>rel</code> - Relational expression whose cost has improved</dd>
<dd><code>activeSet</code> - Set of active subsets, for cycle detection</dd>
</dl>
</li>
</ul>
<a id="propagateCostImprovements0(org.apache.calcite.plan.volcano.VolcanoPlanner,org.apache.calcite.rel.metadata.RelMetadataQuery,org.apache.calcite.rel.RelNode,java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propagateCostImprovements0</h4>
<pre class="methodSignature">void&nbsp;propagateCostImprovements0&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner,
<a href="../../rel/metadata/RelMetadataQuery.html" title="class in org.apache.calcite.rel.metadata">RelMetadataQuery</a>&nbsp;mq,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
java.util.Set&lt;<a href="RelSubset.html" title="class in org.apache.calcite.plan.volcano">RelSubset</a>&gt;&nbsp;activeSet)</pre>
</li>
</ul>
<a id="propagateBoostRemoval(org.apache.calcite.plan.volcano.VolcanoPlanner)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propagateBoostRemoval</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;propagateBoostRemoval&#8203;(<a href="VolcanoPlanner.html" title="class in org.apache.calcite.plan.volcano">VolcanoPlanner</a>&nbsp;planner)</pre>
</li>
</ul>
<a id="collectVariablesUsed(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectVariablesUsed</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;collectVariablesUsed&#8203;(java.util.Set&lt;<a href="../../rel/core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../rel/RelNode.html#collectVariablesUsed(java.util.Set)">RelNode</a></code></span></div>
<div class="block">Collects variables known to be used by this expression or its
descendants. By default, no such information is available and must be
derived by analyzing sub-expressions, but some optimizer implementations
may insert special expressions which remember such information.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../rel/RelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a></code>&nbsp;in interface&nbsp;<code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#collectVariablesUsed(java.util.Set)">collectVariablesUsed</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableSet</code> - receives variables used</dd>
</dl>
</li>
</ul>
<a id="collectVariablesSet(java.util.Set)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectVariablesSet</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;collectVariablesSet&#8203;(java.util.Set&lt;<a href="../../rel/core/CorrelationId.html" title="class in org.apache.calcite.rel.core">CorrelationId</a>&gt;&nbsp;variableSet)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../rel/RelNode.html#collectVariablesSet(java.util.Set)">RelNode</a></code></span></div>
<div class="block">Collects variables set by this expression.
TODO: is this required?</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../rel/RelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a></code>&nbsp;in interface&nbsp;<code><a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../rel/AbstractRelNode.html#collectVariablesSet(java.util.Set)">collectVariablesSet</a></code>&nbsp;in class&nbsp;<code><a href="../../rel/AbstractRelNode.html" title="class in org.apache.calcite.rel">AbstractRelNode</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>variableSet</code> - receives variables known to be set by</dd>
</dl>
</li>
</ul>
<a id="getRels()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRels</h4>
<pre class="methodSignature">public&nbsp;java.lang.Iterable&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;getRels()</pre>
<div class="block">Returns the rel nodes in this rel subset. All rels must have the same
traits and are logically equivalent.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>all the rels in the subset</dd>
</dl>
</li>
</ul>
<a id="getRelList()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getRelList</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;getRelList()</pre>
<div class="block">As <a href="#getRels()"><code>getRels()</code></a> but returns a list.</div>
</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/RelSubset.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>