blob: b34a87d8d02cc0a2acb791ef8196ea2fb4b18a8f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>HepPlanner (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="HepPlanner (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":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":9,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":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/HepPlanner.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.hep</a></div>
<h2 title="Class HepPlanner" class="title">Class HepPlanner</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">org.apache.calcite.plan.AbstractRelOptPlanner</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.plan.hep.HepPlanner</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">HepPlanner</span>
extends <a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></pre>
<div class="block">HepPlanner is a heuristic implementation of the <a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan"><code>RelOptPlanner</code></a>
interface.</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>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.org.apache.calcite.plan.RelOptPlanner">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.calcite.plan.<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3>
<code><a href="../RelOptPlanner.CannotPlanException.html" title="class in org.apache.calcite.plan">RelOptPlanner.CannotPlanException</a>, <a href="../RelOptPlanner.Executor.html" title="interface in org.apache.calcite.plan">RelOptPlanner.Executor</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>private java.util.Set&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allRules">allRules</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#currentProgram">currentProgram</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../util/graph/DirectedGraph.html" title="interface in org.apache.calcite.util.graph">DirectedGraph</a>&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>,&#8203;<a href="../../util/graph/DefaultEdge.html" title="class in org.apache.calcite.util.graph">DefaultEdge</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#graph">graph</a></span></code></th>
<td class="colLast">
<div class="block">Query graph, with edges directed from parent to child.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#graphSizeLastGC">graphSizeLastGC</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mainProgram">mainProgram</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.util.Map&lt;<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;java.lang.String,&#8203;<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;,&#8203;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#mapDigestToVertex">mapDigestToVertex</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.util.List&lt;<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#materializations">materializations</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#noDag">noDag</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nTransformations">nTransformations</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nTransformationsLastGC">nTransformationsLastGC</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a>&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;java.lang.Void&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onCopyHook">onCopyHook</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#requestedRootTraits">requestedRootTraits</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#root">root</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.plan.AbstractRelOptPlanner">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.calcite.plan.<a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></h3>
<code><a href="../AbstractRelOptPlanner.html#context">context</a>, <a href="../AbstractRelOptPlanner.html#costFactory">costFactory</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.plan.RelOptPlanner">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;org.apache.calcite.plan.<a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></h3>
<code><a href="../RelOptPlanner.html#LOGGER">LOGGER</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.hep.HepProgram)">HepPlanner</a></span>&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program)</code></th>
<td class="colLast">
<div class="block">Creates a new HepPlanner that allows DAG.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.hep.HepProgram,org.apache.calcite.plan.Context)">HepPlanner</a></span>&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program,
<a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Creates a new HepPlanner that allows DAG.</div>
</td>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.plan.hep.HepProgram,org.apache.calcite.plan.Context,boolean,org.apache.calcite.linq4j.function.Function2,org.apache.calcite.plan.RelOptCostFactory)">HepPlanner</a></span>&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program,
<a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;context,
boolean&nbsp;noDag,
<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a>&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;java.lang.Void&gt;&nbsp;onCopyHook,
<a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;costFactory)</code></th>
<td class="colLast">
<div class="block">Creates a new HepPlanner with the option to keep the graph a
tree (noDag = true) or allow DAG (noDag = false).</div>
</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>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></span>&#8203;(<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&nbsp;materialization)</code></th>
<td class="colLast">
<div class="block">Defines a pair of relational expressions that are equivalent.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>private <a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addRelToGraph(org.apache.calcite.rel.RelNode)">addRelToGraph</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</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="#addRule(org.apache.calcite.plan.RelOptRule)">addRule</a></span>&#8203;(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</code></th>
<td class="colLast">
<div class="block">Registers a rule.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>private <a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyRule(org.apache.calcite.plan.RelOptRule,org.apache.calcite.plan.hep.HepRelVertex,boolean)">applyRule</a></span>&#8203;(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule,
<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex,
boolean&nbsp;forceConversions)</code></th>
<td class="colLast">&nbsp;</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="#applyRules(java.util.Collection,boolean)">applyRules</a></span>&#8203;(java.util.Collection&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;forceConversions)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>private <a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#applyTransformationResults(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.plan.hep.HepRuleCall,org.apache.calcite.plan.RelTrait)">applyTransformationResults</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex,
<a href="HepRuleCall.html" title="class in org.apache.calcite.plan.hep">HepRuleCall</a>&nbsp;call,
<a href="../RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;parentTrait)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#assertNoCycles()">assertNoCycles</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#belongsToDag(org.apache.calcite.plan.hep.HepRelVertex)">belongsToDag</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</code></th>
<td class="colLast">
<div class="block">Returns whether the vertex is valid.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>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="#buildFinalPlan(org.apache.calcite.plan.hep.HepRelVertex)">buildFinalPlan</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" 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="#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">changeTraits</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;toTraits)</code></th>
<td class="colLast">
<div class="block">Changes a relational expression to an equivalent one with a different set
of traits.</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="#clear()">clear</a></span>()</code></th>
<td class="colLast">
<div class="block">Removes all internal state, including all registered rules,
materialized views, and lattices.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#collectGarbage()">collectGarbage</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contractVertices(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.plan.hep.HepRelVertex,java.util.List)">contractVertices</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;preservedVertex,
<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;discardedVertex,
java.util.List&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;&nbsp;parents)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>private int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#depthFirstApply(java.util.Iterator,java.util.Collection,boolean,int)">depthFirstApply</a></span>&#8203;(java.util.Iterator&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;&nbsp;iter,
java.util.Collection&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;forceConversions,
int&nbsp;nMatches)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#doesConverterApply(org.apache.calcite.rel.convert.ConverterRule,org.apache.calcite.plan.hep.HepRelVertex)">doesConverterApply</a></span>&#8203;(<a href="../../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&nbsp;converterRule,
<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dumpGraph()">dumpGraph</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i16" 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="#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">ensureRegistered</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;equivRel)</code></th>
<td class="colLast">
<div class="block">Registers a relational expression if it is not already registered.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.BeginGroup)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.BeginGroup.html" title="class in org.apache.calcite.plan.hep">HepInstruction.BeginGroup</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.CommonRelSubExprRules)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.CommonRelSubExprRules.html" title="class in org.apache.calcite.plan.hep">HepInstruction.CommonRelSubExprRules</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.ConverterRules)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.ConverterRules.html" title="class in org.apache.calcite.plan.hep">HepInstruction.ConverterRules</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.EndGroup)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.EndGroup.html" title="class in org.apache.calcite.plan.hep">HepInstruction.EndGroup</a>&nbsp;instruction)</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="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.MatchLimit)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.MatchLimit.html" title="class in org.apache.calcite.plan.hep">HepInstruction.MatchLimit</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</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="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.MatchOrder)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.MatchOrder.html" title="class in org.apache.calcite.plan.hep">HepInstruction.MatchOrder</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.RuleClass)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.RuleClass.html" title="class in org.apache.calcite.plan.hep">HepInstruction.RuleClass</a>&lt;?&gt;&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.RuleCollection)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.RuleCollection.html" title="class in org.apache.calcite.plan.hep">HepInstruction.RuleCollection</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.RuleInstance)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.RuleInstance.html" title="class in org.apache.calcite.plan.hep">HepInstruction.RuleInstance</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>(package private) void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeInstruction(org.apache.calcite.plan.hep.HepInstruction.Subprogram)">executeInstruction</a></span>&#8203;(<a href="HepInstruction.Subprogram.html" title="class in org.apache.calcite.plan.hep">HepInstruction.Subprogram</a>&nbsp;instruction)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#executeProgram(org.apache.calcite.plan.hep.HepProgram)">executeProgram</a></span>&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i28" 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="#findBestExp()">findBestExp</a></span>()</code></th>
<td class="colLast">
<div class="block">Finds the most efficient expression to implement this query.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>private java.util.Iterator&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGraphIterator(org.apache.calcite.plan.hep.HepRelVertex)">getGraphIterator</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;start)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>com.google.common.collect.ImmutableList&lt;<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaterializations()">getMaterializations</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the materializations that have been registered with the planner.</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</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">Gets a timestamp for a given rel's metadata.</div>
</td>
</tr>
<tr id="i32" 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="#getRoot()">getRoot</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the root node of this query.</div>
</td>
</tr>
<tr id="i33" class="rowColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRules()">getRules</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the list of all registered rules.</div>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>private java.util.List&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getVertexParents(org.apache.calcite.plan.hep.HepRelVertex)">getVertexParents</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</code></th>
<td class="colLast">
<div class="block">Retrieves the parent vertices of a vertex.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isRegistered(org.apache.calcite.rel.RelNode)">isRegistered</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">Determines whether a relational expression has been registered.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<td class="colFirst"><code>private static <a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;java.lang.String,&#8203;<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#key(org.apache.calcite.rel.RelNode)">key</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i37" class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#matchOperands(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.rel.RelNode,java.util.List,java.util.Map)">matchOperands</a></span>&#8203;(<a href="../RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>&nbsp;operand,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;bindings,
java.util.Map&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&gt;&nbsp;nodeChildren)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i38" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;newRel)</code></th>
<td class="colLast">
<div class="block">Called when a relational expression is copied to a similar expression.</div>
</td>
</tr>
<tr id="i39" 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="#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">register</a></span>&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;equivRel)</code></th>
<td class="colLast">
<div class="block">Registers a relational expression in the expression bank.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></span>&#8203;(java.util.List&lt;<a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&gt;&nbsp;list)</code></th>
<td class="colLast">
<div class="block">Gives this planner a chance to register one or more
<a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata"><code>RelMetadataProvider</code></a>s in the chain which will be used to answer
metadata queries.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#removeRule(org.apache.calcite.plan.RelOptRule)">removeRule</a></span>&#8203;(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</code></th>
<td class="colLast">
<div class="block">Removes a rule.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setRoot(org.apache.calcite.rel.RelNode)">setRoot</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">Sets the root node of this query.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#skippingGroup()">skippingGroup</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i44" class="altColor">
<td class="colFirst"><code>private void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateVertex(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.rel.RelNode)">updateVertex</a></span>&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.plan.AbstractRelOptPlanner">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.plan.<a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></h3>
<code><a href="../AbstractRelOptPlanner.html#addLattice(org.apache.calcite.plan.RelOptLattice)">addLattice</a>, <a href="../AbstractRelOptPlanner.html#addListener(org.apache.calcite.plan.RelOptListener)">addListener</a>, <a href="../AbstractRelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)">addRelTraitDef</a>, <a href="../AbstractRelOptPlanner.html#checkCancel()">checkCancel</a>, <a href="../AbstractRelOptPlanner.html#chooseDelegate()">chooseDelegate</a>, <a href="../AbstractRelOptPlanner.html#clearRelTraitDefs()">clearRelTraitDefs</a>, <a href="../AbstractRelOptPlanner.html#emptyTraitSet()">emptyTraitSet</a>, <a href="../AbstractRelOptPlanner.html#fireRule(org.apache.calcite.plan.RelOptRuleCall)">fireRule</a>, <a href="../AbstractRelOptPlanner.html#getContext()">getContext</a>, <a href="../AbstractRelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode)">getCost</a>, <a href="../AbstractRelOptPlanner.html#getCost(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.metadata.RelMetadataQuery)">getCost</a>, <a href="../AbstractRelOptPlanner.html#getCostFactory()">getCostFactory</a>, <a href="../AbstractRelOptPlanner.html#getExecutor()">getExecutor</a>, <a href="../AbstractRelOptPlanner.html#getLattice(org.apache.calcite.plan.RelOptTable)">getLattice</a>, <a href="../AbstractRelOptPlanner.html#getListener()">getListener</a>, <a href="../AbstractRelOptPlanner.html#getRelTraitDefs()">getRelTraitDefs</a>, <a href="../AbstractRelOptPlanner.html#getRuleByDescription(java.lang.String)">getRuleByDescription</a>, <a href="../AbstractRelOptPlanner.html#isRuleExcluded(org.apache.calcite.plan.RelOptRule)">isRuleExcluded</a>, <a href="../AbstractRelOptPlanner.html#mapRuleDescription(org.apache.calcite.plan.RelOptRule)">mapRuleDescription</a>, <a href="../AbstractRelOptPlanner.html#notifyChosen(org.apache.calcite.rel.RelNode)">notifyChosen</a>, <a href="../AbstractRelOptPlanner.html#notifyDiscard(org.apache.calcite.rel.RelNode)">notifyDiscard</a>, <a href="../AbstractRelOptPlanner.html#notifyEquivalence(org.apache.calcite.rel.RelNode,java.lang.Object,boolean)">notifyEquivalence</a>, <a href="../AbstractRelOptPlanner.html#notifyTransformation(org.apache.calcite.plan.RelOptRuleCall,org.apache.calcite.rel.RelNode,boolean)">notifyTransformation</a>, <a href="../AbstractRelOptPlanner.html#onNewClass(org.apache.calcite.rel.RelNode)">onNewClass</a>, <a href="../AbstractRelOptPlanner.html#registerClass(org.apache.calcite.rel.RelNode)">registerClass</a>, <a href="../AbstractRelOptPlanner.html#registerSchema(org.apache.calcite.plan.RelOptSchema)">registerSchema</a>, <a href="../AbstractRelOptPlanner.html#setCancelFlag(org.apache.calcite.util.CancelFlag)">setCancelFlag</a>, <a href="../AbstractRelOptPlanner.html#setExecutor(org.apache.calcite.rex.RexExecutor)">setExecutor</a>, <a href="../AbstractRelOptPlanner.html#setImportance(org.apache.calcite.rel.RelNode,double)">setImportance</a>, <a href="../AbstractRelOptPlanner.html#setRuleDescExclusionFilter(java.util.regex.Pattern)">setRuleDescExclusionFilter</a>, <a href="../AbstractRelOptPlanner.html#subClasses(java.lang.Class)">subClasses</a>, <a href="../AbstractRelOptPlanner.html#unmapRuleDescription(org.apache.calcite.plan.RelOptRule)">unmapRuleDescription</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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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="mainProgram">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mainProgram</h4>
<pre>private final&nbsp;<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a> mainProgram</pre>
</li>
</ul>
<a id="currentProgram">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>currentProgram</h4>
<pre>private&nbsp;<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a> currentProgram</pre>
</li>
</ul>
<a id="root">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>root</h4>
<pre>private&nbsp;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a> root</pre>
</li>
</ul>
<a id="requestedRootTraits">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>requestedRootTraits</h4>
<pre>private&nbsp;<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a> requestedRootTraits</pre>
</li>
</ul>
<a id="mapDigestToVertex">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapDigestToVertex</h4>
<pre>private final&nbsp;java.util.Map&lt;<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;java.lang.String,&#8203;<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;,&#8203;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt; mapDigestToVertex</pre>
</li>
</ul>
<a id="allRules">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>allRules</h4>
<pre>private final&nbsp;java.util.Set&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt; allRules</pre>
</li>
</ul>
<a id="nTransformations">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nTransformations</h4>
<pre>private&nbsp;int nTransformations</pre>
</li>
</ul>
<a id="graphSizeLastGC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>graphSizeLastGC</h4>
<pre>private&nbsp;int graphSizeLastGC</pre>
</li>
</ul>
<a id="nTransformationsLastGC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nTransformationsLastGC</h4>
<pre>private&nbsp;int nTransformationsLastGC</pre>
</li>
</ul>
<a id="noDag">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>noDag</h4>
<pre>private final&nbsp;boolean noDag</pre>
</li>
</ul>
<a id="graph">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>graph</h4>
<pre>private final&nbsp;<a href="../../util/graph/DirectedGraph.html" title="interface in org.apache.calcite.util.graph">DirectedGraph</a>&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>,&#8203;<a href="../../util/graph/DefaultEdge.html" title="class in org.apache.calcite.util.graph">DefaultEdge</a>&gt; graph</pre>
<div class="block">Query graph, with edges directed from parent to child. This is a
single-rooted DAG, possibly with additional roots corresponding to
discarded plan fragments which remain to be garbage-collected.</div>
</li>
</ul>
<a id="onCopyHook">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onCopyHook</h4>
<pre>private final&nbsp;<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a>&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;java.lang.Void&gt; onCopyHook</pre>
</li>
</ul>
<a id="materializations">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>materializations</h4>
<pre>private final&nbsp;java.util.List&lt;<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&gt; materializations</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;(org.apache.calcite.plan.hep.HepProgram)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HepPlanner</h4>
<pre>public&nbsp;HepPlanner&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program)</pre>
<div class="block">Creates a new HepPlanner that allows DAG.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>program</code> - program controlling rule application</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.calcite.plan.hep.HepProgram,org.apache.calcite.plan.Context)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HepPlanner</h4>
<pre>public&nbsp;HepPlanner&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program,
<a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;context)</pre>
<div class="block">Creates a new HepPlanner that allows DAG.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>program</code> - program controlling rule application</dd>
<dd><code>context</code> - to carry while planning</dd>
</dl>
</li>
</ul>
<a id="&lt;init&gt;(org.apache.calcite.plan.hep.HepProgram,org.apache.calcite.plan.Context,boolean,org.apache.calcite.linq4j.function.Function2,org.apache.calcite.plan.RelOptCostFactory)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HepPlanner</h4>
<pre>public&nbsp;HepPlanner&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program,
<a href="../Context.html" title="interface in org.apache.calcite.plan">Context</a>&nbsp;context,
boolean&nbsp;noDag,
<a href="../../linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a>&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;java.lang.Void&gt;&nbsp;onCopyHook,
<a href="../RelOptCostFactory.html" title="interface in org.apache.calcite.plan">RelOptCostFactory</a>&nbsp;costFactory)</pre>
<div class="block">Creates a new HepPlanner with the option to keep the graph a
tree (noDag = true) or allow DAG (noDag = false).</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>noDag</code> - If false, create shared nodes if expressions are
identical</dd>
<dd><code>program</code> - Program controlling rule application</dd>
<dd><code>onCopyHook</code> - Function to call when a node is copied</dd>
</dl>
</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="setRoot(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRoot</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setRoot&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#setRoot(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
<div class="block">Sets the root node of this query.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - Relational expression</dd>
</dl>
</li>
</ul>
<a id="getRoot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoot</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;getRoot()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#getRoot()">RelOptPlanner</a></code></span></div>
<div class="block">Returns the root node of this query.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Root node</dd>
</dl>
</li>
</ul>
<a id="getRules()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRules</h4>
<pre class="methodSignature">public&nbsp;java.util.List&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;getRules()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#getRules()">RelOptPlanner</a></code></span></div>
<div class="block">Returns the list of all registered rules.</div>
</li>
</ul>
<a id="addRule(org.apache.calcite.plan.RelOptRule)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRule</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;addRule&#8203;(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#addRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div>
<div class="block">Registers a rule.
<p>If the rule has already been registered, does nothing.
This method determines if the given rule is a
<a href="../../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert"><code>ConverterRule</code></a> and pass the
ConverterRule to all
<a href="../RelOptPlanner.html#addRelTraitDef(org.apache.calcite.plan.RelTraitDef)"><code>registered</code></a> RelTraitDef
instances.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the rule was added, as per
<code>Collection.add(E)</code></dd>
</dl>
</li>
</ul>
<a id="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;clear()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#clear()">RelOptPlanner</a></code></span></div>
<div class="block">Removes all internal state, including all registered rules,
materialized views, and lattices.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../RelOptPlanner.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractRelOptPlanner.html#clear()">clear</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd>
</dl>
</li>
</ul>
<a id="removeRule(org.apache.calcite.plan.RelOptRule)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeRule</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;removeRule&#8203;(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#removeRule(org.apache.calcite.plan.RelOptRule)">RelOptPlanner</a></code></span></div>
<div class="block">Removes a rule.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the rule was present, as per
<code>Collection.remove(Object)</code></dd>
</dl>
</li>
</ul>
<a id="changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>changeTraits</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;changeTraits&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../RelTraitSet.html" title="class in org.apache.calcite.plan">RelTraitSet</a>&nbsp;toTraits)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#changeTraits(org.apache.calcite.rel.RelNode,org.apache.calcite.plan.RelTraitSet)">RelOptPlanner</a></code></span></div>
<div class="block">Changes a relational expression to an equivalent one with a different set
of traits.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - Relational expression (may or may not have been registered; must
not have the desired traits)</dd>
<dd><code>toTraits</code> - Trait set to convert the relational expression to</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Relational expression with desired traits. Never null, but may be
abstract</dd>
</dl>
</li>
</ul>
<a id="findBestExp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findBestExp</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;findBestExp()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#findBestExp()">RelOptPlanner</a></code></span></div>
<div class="block">Finds the most efficient expression to implement this query.</div>
</li>
</ul>
<a id="executeProgram(org.apache.calcite.plan.hep.HepProgram)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeProgram</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;executeProgram&#8203;(<a href="HepProgram.html" title="class in org.apache.calcite.plan.hep">HepProgram</a>&nbsp;program)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.MatchLimit)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.MatchLimit.html" title="class in org.apache.calcite.plan.hep">HepInstruction.MatchLimit</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.MatchOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.MatchOrder.html" title="class in org.apache.calcite.plan.hep">HepInstruction.MatchOrder</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.RuleInstance)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.RuleInstance.html" title="class in org.apache.calcite.plan.hep">HepInstruction.RuleInstance</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.RuleClass)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.RuleClass.html" title="class in org.apache.calcite.plan.hep">HepInstruction.RuleClass</a>&lt;?&gt;&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.RuleCollection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.RuleCollection.html" title="class in org.apache.calcite.plan.hep">HepInstruction.RuleCollection</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="skippingGroup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>skippingGroup</h4>
<pre class="methodSignature">private&nbsp;boolean&nbsp;skippingGroup()</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.ConverterRules)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.ConverterRules.html" title="class in org.apache.calcite.plan.hep">HepInstruction.ConverterRules</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.CommonRelSubExprRules)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.CommonRelSubExprRules.html" title="class in org.apache.calcite.plan.hep">HepInstruction.CommonRelSubExprRules</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.Subprogram)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.Subprogram.html" title="class in org.apache.calcite.plan.hep">HepInstruction.Subprogram</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.BeginGroup)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.BeginGroup.html" title="class in org.apache.calcite.plan.hep">HepInstruction.BeginGroup</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="executeInstruction(org.apache.calcite.plan.hep.HepInstruction.EndGroup)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>executeInstruction</h4>
<pre class="methodSignature">void&nbsp;executeInstruction&#8203;(<a href="HepInstruction.EndGroup.html" title="class in org.apache.calcite.plan.hep">HepInstruction.EndGroup</a>&nbsp;instruction)</pre>
</li>
</ul>
<a id="depthFirstApply(java.util.Iterator,java.util.Collection,boolean,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>depthFirstApply</h4>
<pre class="methodSignature">private&nbsp;int&nbsp;depthFirstApply&#8203;(java.util.Iterator&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;&nbsp;iter,
java.util.Collection&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;forceConversions,
int&nbsp;nMatches)</pre>
</li>
</ul>
<a id="applyRules(java.util.Collection,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyRules</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;applyRules&#8203;(java.util.Collection&lt;<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&gt;&nbsp;rules,
boolean&nbsp;forceConversions)</pre>
</li>
</ul>
<a id="getGraphIterator(org.apache.calcite.plan.hep.HepRelVertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGraphIterator</h4>
<pre class="methodSignature">private&nbsp;java.util.Iterator&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;&nbsp;getGraphIterator&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;start)</pre>
</li>
</ul>
<a id="belongsToDag(org.apache.calcite.plan.hep.HepRelVertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>belongsToDag</h4>
<pre class="methodSignature">private&nbsp;boolean&nbsp;belongsToDag&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</pre>
<div class="block">Returns whether the vertex is valid.</div>
</li>
</ul>
<a id="applyRule(org.apache.calcite.plan.RelOptRule,org.apache.calcite.plan.hep.HepRelVertex,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyRule</h4>
<pre class="methodSignature">private&nbsp;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;applyRule&#8203;(<a href="../RelOptRule.html" title="class in org.apache.calcite.plan">RelOptRule</a>&nbsp;rule,
<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex,
boolean&nbsp;forceConversions)</pre>
</li>
</ul>
<a id="doesConverterApply(org.apache.calcite.rel.convert.ConverterRule,org.apache.calcite.plan.hep.HepRelVertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doesConverterApply</h4>
<pre class="methodSignature">private&nbsp;boolean&nbsp;doesConverterApply&#8203;(<a href="../../rel/convert/ConverterRule.html" title="class in org.apache.calcite.rel.convert">ConverterRule</a>&nbsp;converterRule,
<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</pre>
</li>
</ul>
<a id="getVertexParents(org.apache.calcite.plan.hep.HepRelVertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVertexParents</h4>
<pre class="methodSignature">private&nbsp;java.util.List&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;&nbsp;getVertexParents&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</pre>
<div class="block">Retrieves the parent vertices of a vertex. If a vertex appears multiple
times as an input into a parent, then that counts as multiple parents,
one per input reference.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>vertex</code> - the vertex</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of parents for the vertex</dd>
</dl>
</li>
</ul>
<a id="matchOperands(org.apache.calcite.plan.RelOptRuleOperand,org.apache.calcite.rel.RelNode,java.util.List,java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matchOperands</h4>
<pre class="methodSignature">private&nbsp;boolean&nbsp;matchOperands&#8203;(<a href="../RelOptRuleOperand.html" title="class in org.apache.calcite.plan">RelOptRuleOperand</a>&nbsp;operand,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&nbsp;bindings,
java.util.Map&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>,&#8203;java.util.List&lt;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&gt;&gt;&nbsp;nodeChildren)</pre>
</li>
</ul>
<a id="applyTransformationResults(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.plan.hep.HepRuleCall,org.apache.calcite.plan.RelTrait)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyTransformationResults</h4>
<pre class="methodSignature">private&nbsp;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;applyTransformationResults&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex,
<a href="HepRuleCall.html" title="class in org.apache.calcite.plan.hep">HepRuleCall</a>&nbsp;call,
<a href="../RelTrait.html" title="interface in org.apache.calcite.plan">RelTrait</a>&nbsp;parentTrait)</pre>
</li>
</ul>
<a id="register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;register&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;equivRel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#register(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
<div class="block">Registers a relational expression in the expression bank.
<p>After it has been registered, you may not modify it.
<p>The expression must not already have been registered. If you are not
sure whether it has been registered, call
<a href="../RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)"><code>RelOptPlanner.ensureRegistered(RelNode, RelNode)</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - Relational expression to register (must not already be
registered)</dd>
<dd><code>equivRel</code> - Relational expression it is equivalent to (may be null)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the same expression, or an equivalent existing expression</dd>
</dl>
</li>
</ul>
<a id="onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onCopy</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onCopy&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;newRel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
<div class="block">Called when a relational expression is copied to a similar expression.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../RelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a></code>&nbsp;in interface&nbsp;<code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractRelOptPlanner.html#onCopy(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">onCopy</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd>
</dl>
</li>
</ul>
<a id="ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ensureRegistered</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;ensureRegistered&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;equivRel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#ensureRegistered(org.apache.calcite.rel.RelNode,org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
<div class="block">Registers a relational expression if it is not already registered.
<p>If <code>equivRel</code> is specified, <code>rel</code> is placed in the same
equivalence set. It is OK if <code>equivRel</code> has different traits;
<code>rel</code> will end up in a different subset of the same set.
<p>It is OK if <code>rel</code> is a subset.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - Relational expression to register</dd>
<dd><code>equivRel</code> - Relational expression it is equivalent to (may be null)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Registered relational expression</dd>
</dl>
</li>
</ul>
<a id="isRegistered(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isRegistered</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isRegistered&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#isRegistered(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
<div class="block">Determines whether a relational expression has been registered.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - expression to test</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether rel has been registered</dd>
</dl>
</li>
</ul>
<a id="addRelToGraph(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addRelToGraph</h4>
<pre class="methodSignature">private&nbsp;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;addRelToGraph&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
</li>
</ul>
<a id="contractVertices(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.plan.hep.HepRelVertex,java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contractVertices</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;contractVertices&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;preservedVertex,
<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;discardedVertex,
java.util.List&lt;<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&gt;&nbsp;parents)</pre>
</li>
</ul>
<a id="updateVertex(org.apache.calcite.plan.hep.HepRelVertex,org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateVertex</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;updateVertex&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex,
<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
</li>
</ul>
<a id="key(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>key</h4>
<pre class="methodSignature">private static&nbsp;<a href="../../util/Pair.html" title="class in org.apache.calcite.util">Pair</a>&lt;java.lang.String,&#8203;<a href="../../rel/type/RelDataType.html" title="interface in org.apache.calcite.rel.type">RelDataType</a>&gt;&nbsp;key&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
</li>
</ul>
<a id="buildFinalPlan(org.apache.calcite.plan.hep.HepRelVertex)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildFinalPlan</h4>
<pre class="methodSignature">private&nbsp;<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;buildFinalPlan&#8203;(<a href="HepRelVertex.html" title="class in org.apache.calcite.plan.hep">HepRelVertex</a>&nbsp;vertex)</pre>
</li>
</ul>
<a id="collectGarbage()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collectGarbage</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;collectGarbage()</pre>
</li>
</ul>
<a id="assertNoCycles()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertNoCycles</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;assertNoCycles()</pre>
</li>
</ul>
<a id="dumpGraph()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dumpGraph</h4>
<pre class="methodSignature">private&nbsp;void&nbsp;dumpGraph()</pre>
</li>
</ul>
<a id="registerMetadataProviders(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>registerMetadataProviders</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;registerMetadataProviders&#8203;(java.util.List&lt;<a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata">RelMetadataProvider</a>&gt;&nbsp;list)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#registerMetadataProviders(java.util.List)">RelOptPlanner</a></code></span></div>
<div class="block">Gives this planner a chance to register one or more
<a href="../../rel/metadata/RelMetadataProvider.html" title="interface in org.apache.calcite.rel.metadata"><code>RelMetadataProvider</code></a>s in the chain which will be used to answer
metadata queries.
<p>Planners which use their own relational expressions internally
to represent concepts such as equivalence classes will generally need to
supply corresponding metadata providers.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../RelOptPlanner.html#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></code>&nbsp;in interface&nbsp;<code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractRelOptPlanner.html#registerMetadataProviders(java.util.List)">registerMetadataProviders</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>list</code> - receives planner's custom providers, if any</dd>
</dl>
</li>
</ul>
<a id="getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRelMetadataTimestamp</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getRelMetadataTimestamp&#8203;(<a href="../../rel/RelNode.html" title="interface in org.apache.calcite.rel">RelNode</a>&nbsp;rel)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">RelOptPlanner</a></code></span></div>
<div class="block">Gets a timestamp for a given rel's metadata. This timestamp is used by
<a href="../../rel/metadata/CachingRelMetadataProvider.html" title="class in org.apache.calcite.rel.metadata"><code>CachingRelMetadataProvider</code></a> to decide whether cached metadata has
gone stale.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../RelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code>&nbsp;in interface&nbsp;<code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractRelOptPlanner.html#getRelMetadataTimestamp(org.apache.calcite.rel.RelNode)">getRelMetadataTimestamp</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rel</code> - rel of interest</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>timestamp of last change which might affect metadata derivation</dd>
</dl>
</li>
</ul>
<a id="getMaterializations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaterializations</h4>
<pre class="methodSignature">public&nbsp;com.google.common.collect.ImmutableList&lt;<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&gt;&nbsp;getMaterializations()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#getMaterializations()">RelOptPlanner</a></code></span></div>
<div class="block">Returns the materializations that have been registered with the planner.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../RelOptPlanner.html#getMaterializations()">getMaterializations</a></code>&nbsp;in interface&nbsp;<code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractRelOptPlanner.html#getMaterializations()">getMaterializations</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></code></dd>
</dl>
</li>
</ul>
<a id="addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addMaterialization</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;addMaterialization&#8203;(<a href="../RelOptMaterialization.html" title="class in org.apache.calcite.plan">RelOptMaterialization</a>&nbsp;materialization)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">RelOptPlanner</a></code></span></div>
<div class="block">Defines a pair of relational expressions that are equivalent.
<p>Typically <code>tableRel</code> is a
<a href="../../rel/logical/LogicalTableScan.html" title="class in org.apache.calcite.rel.logical"><code>LogicalTableScan</code></a> representing a
table that is a materialized view and <code>queryRel</code> is the SQL
expression that populates that view. The intention is that
<code>tableRel</code> is cheaper to evaluate and therefore if the query being
optimized uses (or can be rewritten to use) <code>queryRel</code> as a
sub-expression then it can be optimized by using <code>tableRel</code>
instead.</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../RelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></code>&nbsp;in interface&nbsp;<code><a href="../RelOptPlanner.html" title="interface in org.apache.calcite.plan">RelOptPlanner</a></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../AbstractRelOptPlanner.html#addMaterialization(org.apache.calcite.plan.RelOptMaterialization)">addMaterialization</a></code>&nbsp;in class&nbsp;<code><a href="../AbstractRelOptPlanner.html" title="class in org.apache.calcite.plan">AbstractRelOptPlanner</a></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/HepPlanner.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>