Google Git
Sign in
apache / datasketches / d3adc1a60d93e5399c063ea3ed5ef18960ddb98d / . / api / core / snapshot / apidocs / com / yahoo / sketches / class-use / Family.html
blob: 03c4c86651ca98bc360b1cc6b0368e50bf28a671 [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_162) on Thu Mar 14 13:13:09 PDT 2019 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Class com.yahoo.sketches.Family (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)</title>
<meta name="date" content="2019-03-14">
<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="Uses of Class com.yahoo.sketches.Family (com.yahoo.datasketches:sketches-core 0.13.1-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><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Class</a></li>
<li class="navBarCell1Rev">Use</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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/class-use/Family.html" target="_top">Frames</a></li>
<li><a href="Family.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">
<h2 title="Uses of Class com.yahoo.sketches.Family" class="title">Uses of Class<br>com.yahoo.sketches.Family</h2>
</div>
<div class="classUseContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#com.yahoo.sketches">com.yahoo.sketches</a></td>
<td class="colLast">
<div class="block">This package is the parent package for all sketch algorithms.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#com.yahoo.sketches.cpc">com.yahoo.sketches.cpc</a></td>
<td class="colLast">
<div class="block">Compressed Probabilistic Counting</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#com.yahoo.sketches.theta">com.yahoo.sketches.theta</a></td>
<td class="colLast">
<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>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<ul class="blockList">
<li class="blockList"><a name="com.yahoo.sketches">
<!-- -->
</a>
<h3>Uses of <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> in <a href="../../../../com/yahoo/sketches/package-summary.html">com.yahoo.sketches</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../com/yahoo/sketches/package-summary.html">com.yahoo.sketches</a> that return <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">Family.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/Family.html#idToFamily-int-">idToFamily</a></span>(int&nbsp;id)</code>
<div class="block">Returns the Family given the ID</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">Family.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/Family.html#stringToFamily-java.lang.String-">stringToFamily</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;famName)</code>
<div class="block">Returns the Family given the family name</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">Family.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/Family.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>[]</code></td>
<td class="colLast"><span class="typeNameLabel">Family.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/Family.html#values--">values</a></span>()</code>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="com.yahoo.sketches.cpc">
<!-- -->
</a>
<h3>Uses of <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> in <a href="../../../../com/yahoo/sketches/cpc/package-summary.html">com.yahoo.sketches.cpc</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../com/yahoo/sketches/cpc/package-summary.html">com.yahoo.sketches.cpc</a> that return <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">CpcUnion.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/cpc/CpcUnion.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">CpcWrapper.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/cpc/CpcWrapper.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">CpcSketch.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/cpc/CpcSketch.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Return the DataSketches identifier for this CPC family of sketches.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="com.yahoo.sketches.theta">
<!-- -->
</a>
<h3>Uses of <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a> in <a href="../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.theta</a></h3>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.theta</a> that return <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Returns the Family</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">Intersection.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/Intersection.html#getFamily--">getFamily</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">Sketch.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/Sketch.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Returns the Family that this sketch belongs to</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">AnotB.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/AnotB.html#getFamily--">getFamily</a></span>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">CompactSketch.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/CompactSketch.html#getFamily--">getFamily</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">SetOperation.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperation.html#getFamily--">getFamily</a></span>()</code>
<div class="block">Gets the Family of this SetOperation</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></code></td>
<td class="colLast"><span class="typeNameLabel">Union.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/Union.html#getFamily--">getFamily</a></span>()</code>&nbsp;</td>
</tr>
</tbody>
</table>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
<caption><span>Methods in <a href="../../../../com/yahoo/sketches/theta/package-summary.html">com.yahoo.sketches.theta</a> with parameters of type <a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta">SetOperation</a></code></td>
<td class="colLast"><span class="typeNameLabel">SetOperationBuilder.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#build-com.yahoo.sketches.Family-">build</a></span>(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>&nbsp;family)</code>
<div class="block">Returns a SetOperation with the current configuration of this Builder and the given Family.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/SetOperation.html" title="class in com.yahoo.sketches.theta">SetOperation</a></code></td>
<td class="colLast"><span class="typeNameLabel">SetOperationBuilder.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/SetOperationBuilder.html#build-com.yahoo.sketches.Family-com.yahoo.memory.WritableMemory-">build</a></span>(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>&nbsp;family,
com.yahoo.memory.WritableMemory&nbsp;dstMem)</code>
<div class="block">Returns a SetOperation with the current configuration of this Builder, the given Family
and the given destination memory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html" title="class in com.yahoo.sketches.theta">UpdateSketchBuilder</a></code></td>
<td class="colLast"><span class="typeNameLabel">UpdateSketchBuilder.</span><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/theta/UpdateSketchBuilder.html#setFamily-com.yahoo.sketches.Family-">setFamily</a></span>(<a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Family</a>&nbsp;family)</code>
<div class="block">Set the Family.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</li>
</ul>
</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><a href="../package-summary.html">Package</a></li>
<li><a href="../../../../com/yahoo/sketches/Family.html" title="enum in com.yahoo.sketches">Class</a></li>
<li class="navBarCell1Rev">Use</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</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/yahoo/sketches/class-use/Family.html" target="_top">Frames</a></li>
<li><a href="Family.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;2019. All rights reserved.</small></p>
</body>
</html>