blob: 2daa968f9f118d4cfec95251a3e95e180aa829fb [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_102) on Fri Nov 25 15:49:40 PST 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>com.yahoo.sketches.pig.tuple (com.yahoo.datasketches:sketches-pig 0.8.3-SNAPSHOT API)</title>
<meta name="date" content="2016-11-25">
<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="com.yahoo.sketches.pig.tuple (com.yahoo.datasketches:sketches-pig 0.8.3-SNAPSHOT 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-use.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/pig/theta/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/pig/tuple/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;com.yahoo.sketches.pig.tuple</h1>
<div class="docSummary">
<div class="block">The tuple package contains implementation of sketches based on the idea of
theta sketches with the addition of values associated with unique keys.</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="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="../../../../../com/yahoo/sketches/pig/tuple/AlgebraicInitial.html" title="class in com.yahoo.sketches.pig.tuple">AlgebraicInitial</a></td>
<td class="colLast">
<div class="block">This is a common pass-through implementation for initial step of an Algebraic operation</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/ArrayOfDoublesSketchToEstimates.html" title="class in com.yahoo.sketches.pig.tuple">ArrayOfDoublesSketchToEstimates</a></td>
<td class="colLast">
<div class="block">This UDF converts an ArrayOfDoubles sketch to estimates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToArrayOfDoublesSketch.html" title="class in com.yahoo.sketches.pig.tuple">DataToArrayOfDoublesSketch</a></td>
<td class="colLast">
<div class="block">This UDF creates an ArrayOfDoublesSketch from raw data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToArrayOfDoublesSketch.Initial.html" title="class in com.yahoo.sketches.pig.tuple">DataToArrayOfDoublesSketch.Initial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToArrayOfDoublesSketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.tuple">DataToArrayOfDoublesSketch.IntermediateFinal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToDoubleSummarySketch.html" title="class in com.yahoo.sketches.pig.tuple">DataToDoubleSummarySketch</a></td>
<td class="colLast">
<div class="block">This UDF creates a Sketch&lt;DoubleSummary&gt; from raw data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToDoubleSummarySketch.Initial.html" title="class in com.yahoo.sketches.pig.tuple">DataToDoubleSummarySketch.Initial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToDoubleSummarySketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.tuple">DataToDoubleSummarySketch.IntermediateFinal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToSketch.html" title="class in com.yahoo.sketches.pig.tuple">DataToSketch</a>&lt;U,S extends com.yahoo.sketches.tuple.UpdatableSummary&lt;U&gt;&gt;</td>
<td class="colLast">
<div class="block">This is a generic implementation to be specialized in concrete UDFs</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DataToSketchAlgebraicIntermediateFinal.html" title="class in com.yahoo.sketches.pig.tuple">DataToSketchAlgebraicIntermediateFinal</a>&lt;U,S extends com.yahoo.sketches.tuple.UpdatableSummary&lt;U&gt;&gt;</td>
<td class="colLast">
<div class="block">Class used to calculate the intermediate pass (combiner) or the final pass
(reducer) of an Algebraic sketch operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DoubleSummarySketchToEstimates.html" title="class in com.yahoo.sketches.pig.tuple">DoubleSummarySketchToEstimates</a></td>
<td class="colLast">
<div class="block">This UDF converts a Sketch&lt;DoubleSummary&gt; to estimates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/DoubleSummarySketchToPercentile.html" title="class in com.yahoo.sketches.pig.tuple">DoubleSummarySketchToPercentile</a></td>
<td class="colLast">
<div class="block">This UDF is to get a percentile value from a Sketch&lt;DoubleSummary&gt;.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionArrayOfDoublesSketch.html" title="class in com.yahoo.sketches.pig.tuple">UnionArrayOfDoublesSketch</a></td>
<td class="colLast">
<div class="block">This is to union ArrayOfDoublesSketches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionArrayOfDoublesSketch.Initial.html" title="class in com.yahoo.sketches.pig.tuple">UnionArrayOfDoublesSketch.Initial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionArrayOfDoublesSketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.tuple">UnionArrayOfDoublesSketch.IntermediateFinal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionDoubleSummarySketch.html" title="class in com.yahoo.sketches.pig.tuple">UnionDoubleSummarySketch</a></td>
<td class="colLast">
<div class="block">This is to union Sketch&lt;DoubleSummary&gt;.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionDoubleSummarySketch.Initial.html" title="class in com.yahoo.sketches.pig.tuple">UnionDoubleSummarySketch.Initial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionDoubleSummarySketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.tuple">UnionDoubleSummarySketch.IntermediateFinal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionSketch.html" title="class in com.yahoo.sketches.pig.tuple">UnionSketch</a>&lt;S extends com.yahoo.sketches.tuple.Summary&gt;</td>
<td class="colLast">
<div class="block">This is a generic implementation to be specialized in concrete UDFs</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/tuple/UnionSketchAlgebraicIntermediateFinal.html" title="class in com.yahoo.sketches.pig.tuple">UnionSketchAlgebraicIntermediateFinal</a>&lt;S extends com.yahoo.sketches.tuple.Summary&gt;</td>
<td class="colLast">
<div class="block">This is to calculate the intermediate pass (combiner) or the final pass
(reducer) of an Algebraic sketch operation.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.yahoo.sketches.pig.tuple Description">Package com.yahoo.sketches.pig.tuple Description</h2>
<div class="block">The tuple package contains implementation of sketches based on the idea of
theta sketches with the addition of values associated with unique keys.
Two sets of tuple sketch classes are available at the moment:
generic tuple sketches with user-defined Summary, and a faster specialized
implementation with an array of double values.
See unit tests for usage examples.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Alexander Saydakov</dd>
</dl>
</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-use.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/pig/theta/package-summary.html">Prev&nbsp;Package</a></li>
<li>Next&nbsp;Package</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/pig/tuple/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 &#169; 2015&#x2013;2016 <a href="https://www.yahoo.com">Yahoo! Inc.</a>. All rights reserved.</small></p>
</body>
</html>