blob: 8c7cd5d84234378127fe10655d81337d6510a20c [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 (1.8.0_121) on Mon Jun 26 14:46:07 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DataToDoubleSummarySketchUDAF (com.yahoo.datasketches:sketches-hive 0.10.1-SNAPSHOT API)</title>
<meta name="date" content="2017-06-26">
<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="DataToDoubleSummarySketchUDAF (com.yahoo.datasketches:sketches-hive 0.10.1-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":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";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataToDoubleSummarySketchUDAF.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">
<li><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToArrayOfDoublesSketchUDAF.DataToArrayOfDoublesSketchEvaluator.html" title="class in com.yahoo.sketches.hive.tuple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToDoubleSummaryWithModeSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/hive/tuple/DataToDoubleSummarySketchUDAF.html" target="_top">Frames</a></li>
<li><a href="DataToDoubleSummarySketchUDAF.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.com.yahoo.sketches.hive.tuple.DataToSketchUDAF">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.yahoo.sketches.hive.tuple</div>
<h2 title="Class DataToDoubleSummarySketchUDAF" class="title">Class DataToDoubleSummarySketchUDAF</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hive.ql.udf.generic.AbstractGenericUDAFResolver</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple">com.yahoo.sketches.hive.tuple.DataToSketchUDAF</a></li>
<li>
<ul class="inheritance">
<li>com.yahoo.sketches.hive.tuple.DataToDoubleSummarySketchUDAF</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.hive.ql.udf.generic.GenericUDAFResolver, org.apache.hadoop.hive.ql.udf.generic.GenericUDAFResolver2</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">DataToDoubleSummarySketchUDAF</span>
extends <a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple">DataToSketchUDAF</a></pre>
<div class="block">This simple implementation is to give an example of a concrete UDAF based on the abstract
DataToSketchUDAF if no extra arguments are needed. The same functionality is included into
DataToDoubleSummaryWithModeSketchUDAF with the default summary mode of Sum, but the
implementation is more complex because of the extra argument.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.yahoo.sketches.hive.tuple.DataToSketchUDAF">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.yahoo.sketches.hive.tuple.<a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple">DataToSketchUDAF</a></h3>
<code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.DataToSketchEvaluator.html" title="class in com.yahoo.sketches.hive.tuple">DataToSketchUDAF.DataToSketchEvaluator</a>&lt;<a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.DataToSketchEvaluator.html" title="type parameter in DataToSketchUDAF.DataToSketchEvaluator">U</a>,<a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.DataToSketchEvaluator.html" title="type parameter in DataToSketchUDAF.DataToSketchEvaluator">S</a> extends com.yahoo.sketches.tuple.UpdatableSummary&lt;<a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.DataToSketchEvaluator.html" title="type parameter in DataToSketchUDAF.DataToSketchEvaluator">U</a>&gt;&gt;</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToDoubleSummarySketchUDAF.html#DataToDoubleSummarySketchUDAF--">DataToDoubleSummarySketchUDAF</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToDoubleSummarySketchUDAF.html#createEvaluator--">createEvaluator</a></span>()</code>
<div class="block">This is needed because a concrete UDAF is going to have its own concrete evaluator static inner class.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToDoubleSummarySketchUDAF.html#getEvaluator-org.apache.hadoop.hive.ql.udf.generic.GenericUDAFParameterInfo-">getEvaluator</a></span>(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFParameterInfo&nbsp;info)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.yahoo.sketches.hive.tuple.DataToSketchUDAF">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.yahoo.sketches.hive.tuple.<a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple">DataToSketchUDAF</a></h3>
<code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html#checkExtraArguments-org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector:A-">checkExtraArguments</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hive.ql.udf.generic.AbstractGenericUDAFResolver">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.hive.ql.udf.generic.AbstractGenericUDAFResolver</h3>
<code>getEvaluator</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DataToDoubleSummarySketchUDAF--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DataToDoubleSummarySketchUDAF</h4>
<pre>public&nbsp;DataToDoubleSummarySketchUDAF()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEvaluator-org.apache.hadoop.hive.ql.udf.generic.GenericUDAFParameterInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvaluator</h4>
<pre>public&nbsp;org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator&nbsp;getEvaluator(org.apache.hadoop.hive.ql.udf.generic.GenericUDAFParameterInfo&nbsp;info)
throws org.apache.hadoop.hive.ql.parse.SemanticException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getEvaluator</code>&nbsp;in interface&nbsp;<code>org.apache.hadoop.hive.ql.udf.generic.GenericUDAFResolver2</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html#getEvaluator-org.apache.hadoop.hive.ql.udf.generic.GenericUDAFParameterInfo-">getEvaluator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple">DataToSketchUDAF</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>org.apache.hadoop.hive.ql.parse.SemanticException</code></dd>
</dl>
</li>
</ul>
<a name="createEvaluator--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createEvaluator</h4>
<pre>public&nbsp;org.apache.hadoop.hive.ql.udf.generic.GenericUDAFEvaluator&nbsp;createEvaluator()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html#createEvaluator--">DataToSketchUDAF</a></code></span></div>
<div class="block">This is needed because a concrete UDAF is going to have its own concrete evaluator static inner class.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html#createEvaluator--">createEvaluator</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple">DataToSketchUDAF</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance of evaluator</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DataToDoubleSummarySketchUDAF.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">
<li><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToArrayOfDoublesSketchUDAF.DataToArrayOfDoublesSketchEvaluator.html" title="class in com.yahoo.sketches.hive.tuple"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/yahoo/sketches/hive/tuple/DataToDoubleSummaryWithModeSketchUDAF.html" title="class in com.yahoo.sketches.hive.tuple"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/hive/tuple/DataToDoubleSummarySketchUDAF.html" target="_top">Frames</a></li>
<li><a href="DataToDoubleSummarySketchUDAF.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.classes.inherited.from.class.com.yahoo.sketches.hive.tuple.DataToSketchUDAF">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2017 <a href="https://www.yahoo.com">Yahoo! Inc.</a>. All rights reserved.</small></p>
</body>
</html>