blob: 42250387215d88a5e563e06dd5407739618e747c [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.frequencies (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.frequencies (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>Prev&nbsp;Package</li>
<li><a href="../../../../../com/yahoo/sketches/pig/hash/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/pig/frequencies/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.frequencies</h1>
<div class="docSummary">
<div class="block">This package is dedicated to streaming algorithms that enable estimation of the
frequency of occurence of items in a weighted multiset stream of items.</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/frequencies/AlgebraicInitial.html" title="class in com.yahoo.sketches.pig.frequencies">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/frequencies/DataToFrequentItemsSketch.html" title="class in com.yahoo.sketches.pig.frequencies">DataToFrequentItemsSketch</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This is a generic implementation to be specialized in concrete UDFs</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/DataToFrequentItemsSketchAlgebraicIntermediateFinal.html" title="class in com.yahoo.sketches.pig.frequencies">DataToFrequentItemsSketchAlgebraicIntermediateFinal</a>&lt;T&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="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/DataToFrequentStringsSketch.html" title="class in com.yahoo.sketches.pig.frequencies">DataToFrequentStringsSketch</a></td>
<td class="colLast">
<div class="block">This UDF creates a FrequentItemsSketch&lt;String&gt; from raw data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/DataToFrequentStringsSketch.Initial.html" title="class in com.yahoo.sketches.pig.frequencies">DataToFrequentStringsSketch.Initial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/DataToFrequentStringsSketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.frequencies">DataToFrequentStringsSketch.IntermediateFinal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/FrequentStringsSketchToEstimates.html" title="class in com.yahoo.sketches.pig.frequencies">FrequentStringsSketchToEstimates</a></td>
<td class="colLast">
<div class="block">This UDF converts a FrequentItemsSketch&lt;String&gt; to estimates:
{(item, estimate, upper bound, lower bound), ...}</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/UnionFrequentItemsSketch.html" title="class in com.yahoo.sketches.pig.frequencies">UnionFrequentItemsSketch</a>&lt;T&gt;</td>
<td class="colLast">
<div class="block">This is a generic implementation to be specialized in concrete UDFs</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/UnionFrequentItemsSketchAlgebraicIntermediateFinal.html" title="class in com.yahoo.sketches.pig.frequencies">UnionFrequentItemsSketchAlgebraicIntermediateFinal</a>&lt;T&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>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/UnionFrequentStringsSketch.html" title="class in com.yahoo.sketches.pig.frequencies">UnionFrequentStringsSketch</a></td>
<td class="colLast">
<div class="block">This is to union FrequentItemsSketch&lt;String&gt;.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/UnionFrequentStringsSketch.Initial.html" title="class in com.yahoo.sketches.pig.frequencies">UnionFrequentStringsSketch.Initial</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/frequencies/UnionFrequentStringsSketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.frequencies">UnionFrequentStringsSketch.IntermediateFinal</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.yahoo.sketches.pig.frequencies Description">Package com.yahoo.sketches.pig.frequencies Description</h2>
<div class="block"><p>This package is dedicated to streaming algorithms that enable estimation of the
frequency of occurence of items in a weighted multiset stream of items.
If the frequency distribution of items is sufficiently skewed, these algorithms are very
useful in identifying the "Heavy Hitters" that occured most frequently in the stream.
The accuracy of the estimation of the frequency of an item has well understood error
bounds that can be returned by the sketch.</p>
<p>These sketches are mergable and can be serialized and deserialized to/from a compact
form.</p></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lee Rhodes</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>Prev&nbsp;Package</li>
<li><a href="../../../../../com/yahoo/sketches/pig/hash/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/pig/frequencies/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>