blob: 9e094779672eb30c5684f516346c89badd375fae [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ReduceDecimalsRule.ReinterpretExpander (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="ReduceDecimalsRule.ReinterpretExpander (Apache Calcite API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ReduceDecimalsRule.ReinterpretExpander.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&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.rel.rules</a></div>
<h2 title="Class ReduceDecimalsRule.ReinterpretExpander" class="title">Class ReduceDecimalsRule.ReinterpretExpander</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="ReduceDecimalsRule.RexExpander.html" title="class in org.apache.calcite.rel.rules">org.apache.calcite.rel.rules.ReduceDecimalsRule.RexExpander</a></li>
<li>
<ul class="inheritance">
<li>org.apache.calcite.rel.rules.ReduceDecimalsRule.ReinterpretExpander</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="ReduceDecimalsRule.html" title="class in org.apache.calcite.rel.rules">ReduceDecimalsRule</a></dd>
</dl>
<hr>
<pre>private class <span class="typeNameLabel">ReduceDecimalsRule.ReinterpretExpander</span>
extends <a href="ReduceDecimalsRule.RexExpander.html" title="class in org.apache.calcite.rel.rules">ReduceDecimalsRule.RexExpander</a></pre>
<div class="block">This expander simplifies reinterpret calls. Consider (1.0+1)*1. The inner
operation encodes a decimal (Reinterpret(...)) which the outer operation
immediately decodes: (Reinterpret(Reinterpret(...))). Arithmetic overflow
is handled by underlying integer operations, so we don't have to consider
it. Simply remove the nested Reinterpret.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.apache.calcite.rel.rules.ReduceDecimalsRule.RexExpander">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.calcite.rel.rules.<a href="ReduceDecimalsRule.RexExpander.html" title="class in org.apache.calcite.rel.rules">ReduceDecimalsRule.RexExpander</a></h3>
<code><a href="ReduceDecimalsRule.RexExpander.html#builder">builder</a>, <a href="ReduceDecimalsRule.RexExpander.html#int8">int8</a>, <a href="ReduceDecimalsRule.RexExpander.html#real8">real8</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">Modifier</th>
<th class="colSecond" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.calcite.rex.RexBuilder)">ReinterpretExpander</a></span>&#8203;(<a href="../../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;builder)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canExpand(org.apache.calcite.rex.RexCall)">canExpand</a></span>&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</code></th>
<td class="colLast">
<div class="block">This defaults to the utility method,
<a href="../../rex/RexUtil.html#requiresDecimalExpansion(org.apache.calcite.rex.RexNode,boolean)"><code>RexUtil.requiresDecimalExpansion(RexNode, boolean)</code></a> which checks
general guidelines on whether a rewrite should be considered at all.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>private boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#canSimplify(org.apache.calcite.rex.RexCall,org.apache.calcite.rex.RexCall,org.apache.calcite.rex.RexNode)">canSimplify</a></span>&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;outer,
<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;inner,
<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Detect, in a generic, but strict way, whether it is possible to
simplify a reinterpret cast.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#expand(org.apache.calcite.rex.RexCall)">expand</a></span>&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</code></th>
<td class="colLast">
<div class="block">Rewrites an expression containing decimals.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.calcite.rel.rules.ReduceDecimalsRule.RexExpander">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.calcite.rel.rules.<a href="ReduceDecimalsRule.RexExpander.html" title="class in org.apache.calcite.rel.rules">ReduceDecimalsRule.RexExpander</a></h3>
<code><a href="ReduceDecimalsRule.RexExpander.html#accessValue(org.apache.calcite.rex.RexNode)">accessValue</a>, <a href="ReduceDecimalsRule.RexExpander.html#decodeValue(org.apache.calcite.rex.RexNode)">decodeValue</a>, <a href="ReduceDecimalsRule.RexExpander.html#encodeValue(org.apache.calcite.rex.RexNode,org.apache.calcite.rel.type.RelDataType)">encodeValue</a>, <a href="ReduceDecimalsRule.RexExpander.html#encodeValue(org.apache.calcite.rex.RexNode,org.apache.calcite.rel.type.RelDataType,boolean)">encodeValue</a>, <a href="ReduceDecimalsRule.RexExpander.html#ensureScale(org.apache.calcite.rex.RexNode,int,int)">ensureScale</a>, <a href="ReduceDecimalsRule.RexExpander.html#ensureType(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rex.RexNode)">ensureType</a>, <a href="ReduceDecimalsRule.RexExpander.html#ensureType(org.apache.calcite.rel.type.RelDataType,org.apache.calcite.rex.RexNode,boolean)">ensureType</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeApproxLiteral(java.math.BigDecimal)">makeApproxLiteral</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeApproxScaleFactor(int)">makeApproxScaleFactor</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeCase(org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)">makeCase</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeCase(org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)">makeCase</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeDivide(org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)">makeDivide</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeExactLiteral(long)">makeExactLiteral</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeIsNegative(org.apache.calcite.rex.RexNode)">makeIsNegative</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeIsPositive(org.apache.calcite.rex.RexNode)">makeIsPositive</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeMinus(org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)">makeMinus</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeMultiply(org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)">makeMultiply</a>, <a href="ReduceDecimalsRule.RexExpander.html#makePlus(org.apache.calcite.rex.RexNode,org.apache.calcite.rex.RexNode)">makePlus</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeRoundFactor(int)">makeRoundFactor</a>, <a href="ReduceDecimalsRule.RexExpander.html#makeScaleFactor(int)">makeScaleFactor</a>, <a href="ReduceDecimalsRule.RexExpander.html#powerOfTen(int)">powerOfTen</a>, <a href="ReduceDecimalsRule.RexExpander.html#scaleDown(org.apache.calcite.rex.RexNode,int)">scaleDown</a>, <a href="ReduceDecimalsRule.RexExpander.html#scaleDownDouble(org.apache.calcite.rex.RexNode,int)">scaleDownDouble</a>, <a href="ReduceDecimalsRule.RexExpander.html#scaleUp(org.apache.calcite.rex.RexNode,int)">scaleUp</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">
<!-- ========= 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.rex.RexBuilder)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReinterpretExpander</h4>
<pre>private&nbsp;ReinterpretExpander&#8203;(<a href="../../rex/RexBuilder.html" title="class in org.apache.calcite.rex">RexBuilder</a>&nbsp;builder)</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="canExpand(org.apache.calcite.rex.RexCall)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canExpand</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;canExpand&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="ReduceDecimalsRule.RexExpander.html#canExpand(org.apache.calcite.rex.RexCall)">ReduceDecimalsRule.RexExpander</a></code></span></div>
<div class="block">This defaults to the utility method,
<a href="../../rex/RexUtil.html#requiresDecimalExpansion(org.apache.calcite.rex.RexNode,boolean)"><code>RexUtil.requiresDecimalExpansion(RexNode, boolean)</code></a> which checks
general guidelines on whether a rewrite should be considered at all. In
general, it is helpful to update the utility method since that method is
often used to filter the somewhat expensive rewrite process.
<p>However, this method provides another place for implementations of
RexExpander to make a more detailed analysis before deciding on
whether to perform a rewrite.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="ReduceDecimalsRule.RexExpander.html#canExpand(org.apache.calcite.rex.RexCall)">canExpand</a></code>&nbsp;in class&nbsp;<code><a href="ReduceDecimalsRule.RexExpander.html" title="class in org.apache.calcite.rel.rules">ReduceDecimalsRule.RexExpander</a></code></dd>
</dl>
</li>
</ul>
<a id="expand(org.apache.calcite.rex.RexCall)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>expand</h4>
<pre class="methodSignature">public&nbsp;<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;expand&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;call)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="ReduceDecimalsRule.RexExpander.html#expand(org.apache.calcite.rex.RexCall)">ReduceDecimalsRule.RexExpander</a></code></span></div>
<div class="block">Rewrites an expression containing decimals. Normally, this method
always performs a rewrite, but implementations may choose to return
the original expression if no change was required.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="ReduceDecimalsRule.RexExpander.html#expand(org.apache.calcite.rex.RexCall)">expand</a></code>&nbsp;in class&nbsp;<code><a href="ReduceDecimalsRule.RexExpander.html" title="class in org.apache.calcite.rel.rules">ReduceDecimalsRule.RexExpander</a></code></dd>
</dl>
</li>
</ul>
<a id="canSimplify(org.apache.calcite.rex.RexCall,org.apache.calcite.rex.RexCall,org.apache.calcite.rex.RexNode)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>canSimplify</h4>
<pre class="methodSignature">private&nbsp;boolean&nbsp;canSimplify&#8203;(<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;outer,
<a href="../../rex/RexCall.html" title="class in org.apache.calcite.rex">RexCall</a>&nbsp;inner,
<a href="../../rex/RexNode.html" title="class in org.apache.calcite.rex">RexNode</a>&nbsp;value)</pre>
<div class="block">Detect, in a generic, but strict way, whether it is possible to
simplify a reinterpret cast. The rules are as follows:
<ol>
<li>If value is not the same basic type as outer, then we cannot
simplify
<li>If the value is nullable but the inner or outer are not, then we
cannot simplify.
<li>If inner is nullable but outer is not, we cannot simplify.
<li>If an overflow check is required from either inner or outer, we
cannot simplify.
<li>Otherwise, given the same type, and sufficient nullability
constraints, we can simplify.
</ol></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>outer</code> - outer call to reinterpret</dd>
<dd><code>inner</code> - inner call to reinterpret</dd>
<dd><code>value</code> - inner value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the two reinterpret casts can be removed</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/ReduceDecimalsRule.ReinterpretExpander.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>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&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>