blob: a7610e8a43a48ec9b1af68a63f2a43b8fdf5c367 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.calcite.linq4j.function (Apache Calcite calcite API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.calcite.linq4j.function (Apache Calcite calcite API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/linq4j/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/calcite/linq4j/tree/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/linq4j/function/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.calcite.linq4j.function</h1>
<div class="docSummary">
<div class="block">Contains definitions of functions and predicates.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/BigDecimalFunction1.html" title="interface in org.apache.calcite.linq4j.function">BigDecimalFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a> value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/DoubleFunction1.html" title="interface in org.apache.calcite.linq4j.function">DoubleFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a native <code>double</code> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/EqualityComparer.html" title="interface in org.apache.calcite.linq4j.function">EqualityComparer</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">Compares values for equality.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/FloatFunction1.html" title="interface in org.apache.calcite.linq4j.function">FloatFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a native <code>float</code> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Function.html" title="interface in org.apache.calcite.linq4j.function">Function</a>&lt;R&gt;</td>
<td class="colLast">
<div class="block">Base interface for all functions.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Function0.html" title="interface in org.apache.calcite.linq4j.function">Function0</a>&lt;R&gt;</td>
<td class="colLast">
<div class="block">Function with no parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Function1.html" title="interface in org.apache.calcite.linq4j.function">Function1</a>&lt;T0,R&gt;</td>
<td class="colLast">
<div class="block">Function with one parameter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Function2.html" title="interface in org.apache.calcite.linq4j.function">Function2</a>&lt;T0,T1,R&gt;</td>
<td class="colLast">
<div class="block">Function with two parameters.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/IntegerFunction1.html" title="interface in org.apache.calcite.linq4j.function">IntegerFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a native <code>int</code> value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/LongFunction1.html" title="interface in org.apache.calcite.linq4j.function">LongFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a native <code>long</code> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/NullableBigDecimalFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableBigDecimalFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a> value that
may be null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/NullableDoubleFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableDoubleFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true" title="class or interface in java.lang"><code>Double</code></a> value that
may be null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/NullableFloatFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableFloatFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html?is-external=true" title="class or interface in java.lang"><code>Float</code></a> value that
may be null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/NullableIntegerFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableIntegerFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang"><code>Integer</code></a> value that
may be null.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/NullableLongFunction1.html" title="interface in org.apache.calcite.linq4j.function">NullableLongFunction1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function that takes one parameter and returns a <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang"><code>Long</code></a> value that
may be null.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Predicate1.html" title="interface in org.apache.calcite.linq4j.function">Predicate1</a>&lt;T0&gt;</td>
<td class="colLast">
<div class="block">Function with one parameter returning a native <code>boolean</code> value.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Predicate2.html" title="interface in org.apache.calcite.linq4j.function">Predicate2</a>&lt;T0,T1&gt;</td>
<td class="colLast">
<div class="block">Function with two parameters returning a native <code>boolean</code> value.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Functions.html" title="class in org.apache.calcite.linq4j.function">Functions</a></td>
<td class="colLast">
<div class="block">Utilities relating to functions.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Annotation Type</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Deterministic.html" title="annotation in org.apache.calcite.linq4j.function">Deterministic</a></td>
<td class="colLast">
<div class="block">Specifies that function is deterministic (i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Experimental.html" title="annotation in org.apache.calcite.linq4j.function">Experimental</a></td>
<td class="colLast">
<div class="block">Annotation that indicates that a class, interface, field or method
is experimental, not part of the public API, and subject to change
or removal.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/NonDeterministic.html" title="annotation in org.apache.calcite.linq4j.function">NonDeterministic</a></td>
<td class="colLast">
<div class="block">Specifies that function is NOT deterministic (i.e.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Parameter.html" title="annotation in org.apache.calcite.linq4j.function">Parameter</a></td>
<td class="colLast">
<div class="block">Annotation that supplies metadata about a function parameter.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/SemiStrict.html" title="annotation in org.apache.calcite.linq4j.function">SemiStrict</a></td>
<td class="colLast">
<div class="block">Annotation applied to a user-defined function that indicates that
the function always returns null if one or more of its arguments
are null but also may return null at other times.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/calcite/linq4j/function/Strict.html" title="annotation in org.apache.calcite.linq4j.function">Strict</a></td>
<td class="colLast">
<div class="block">Annotation applied to a user-defined function that indicates that
the function returns null if and only if one or more of its arguments
are null.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.calcite.linq4j.function Description">Package org.apache.calcite.linq4j.function Description</h2>
<div class="block">Contains definitions of functions and predicates.</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Apache Calcite</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/calcite/linq4j/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/calcite/linq4j/tree/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/calcite/linq4j/function/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.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>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
</body>
</html>