blob: ab45c466fb9ea32999860ac7bd90f70a81222d4a [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.theta (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.theta (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/sampling/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../com/yahoo/sketches/pig/tuple/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/pig/theta/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.theta</h1>
<div class="docSummary">
<div class="block">The theta package contains all the sketch classes that are members of the
<a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.</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/theta/AexcludeB.html" title="class in com.yahoo.sketches.pig.theta">AexcludeB</a></td>
<td class="colLast">
<div class="block">This is a Pig UDF that performs the A-NOT-B Set Operation on two given Sketches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/DataToSketch.html" title="class in com.yahoo.sketches.pig.theta">DataToSketch</a></td>
<td class="colLast">
<div class="block">This is a Pig UDF that builds Sketches from data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/DataToSketch.Initial.html" title="class in com.yahoo.sketches.pig.theta">DataToSketch.Initial</a></td>
<td class="colLast">
<div class="block">Class used to calculate the initial pass of an Algebraic sketch operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/DataToSketch.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.theta">DataToSketch.IntermediateFinal</a></td>
<td class="colLast">
<div class="block">Class used to calculate the intermediate or final combiner pass of an <i>Algebraic</i> sketch
operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/ErrorBounds.html" title="class in com.yahoo.sketches.pig.theta">ErrorBounds</a></td>
<td class="colLast">
<div class="block">This is a User Defined Function (UDF) for returning the Double value result along with a lower and
upper bound.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Estimate.html" title="class in com.yahoo.sketches.pig.theta">Estimate</a></td>
<td class="colLast">
<div class="block">Returns the unique count estimate of a sketch as a Double.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Intersect.html" title="class in com.yahoo.sketches.pig.theta">Intersect</a></td>
<td class="colLast">
<div class="block">This is a Pig UDF that performs the Intersection Set Operation on Sketches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Intersect.Initial.html" title="class in com.yahoo.sketches.pig.theta">Intersect.Initial</a></td>
<td class="colLast">
<div class="block">Class used to calculate the initial pass of an Algebraic sketch operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Intersect.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.theta">Intersect.IntermediateFinal</a></td>
<td class="colLast">
<div class="block">Class used to calculate the intermediate or final combiner pass of an <i>Algebraic</i> intersection
operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/SketchToString.html" title="class in com.yahoo.sketches.pig.theta">SketchToString</a></td>
<td class="colLast">
<div class="block">This is a User Defined Function (UDF) for "pretty printing" the summary of a sketch
from a Sketch Tuple.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Union.html" title="class in com.yahoo.sketches.pig.theta">Union</a></td>
<td class="colLast">
<div class="block">This is a Pig UDF that performs the Union Set Operation on Sketches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Union.Initial.html" title="class in com.yahoo.sketches.pig.theta">Union.Initial</a></td>
<td class="colLast">
<div class="block">Class used to calculate the initial pass of an Algebraic sketch operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../com/yahoo/sketches/pig/theta/Union.IntermediateFinal.html" title="class in com.yahoo.sketches.pig.theta">Union.IntermediateFinal</a></td>
<td class="colLast">
<div class="block">Class used to calculate the intermediate or final combiner pass of an <i>Algebraic</i> union
operation.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package com.yahoo.sketches.pig.theta Description">Package com.yahoo.sketches.pig.theta Description</h2>
<div class="block"><p>The theta package contains all the sketch classes that are members of the
<a href="../../../../../resources/dictionary.html#thetaSketch">Theta Sketch Framework</a>.
The basic sketching functionality in this package is also
accessible from Hadoop Pig UDFs found in the <i>sketches-pig</i> repository,
and from Hadoop Hive UADFs and UDFs found in the <i>sketches-hive</i> repository.
</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><a href="../../../../../com/yahoo/sketches/pig/sampling/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../com/yahoo/sketches/pig/tuple/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/yahoo/sketches/pig/theta/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>