Google Git
Sign in
apache / datasketches-website / d5f29b3e6de7df659f65c31ea2ce341dcaf8b675 / . / api / java / snapshot / apidocs / org / apache / datasketches / theta / Sketches.html
blob: 470827427c3d08e2ba10d95925bf354497994406 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Sketches (datasketches-java 4.0.0 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Sketches (datasketches-java 4.0.0 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9,"i15":9,"i16":9,"i17":9,"i18":9,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":9,"i30":9,"i31":9,"i32":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Sketches.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.datasketches.theta</a></div>
<h2 title="Class Sketches" class="title">Class Sketches</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.datasketches.theta.Sketches</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public final class <span class="typeNameLabel">Sketches</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
<div class="block">This class brings together the common sketch and set operation creation methods and
the public static methods into one place.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Lee Rhodes</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEstimate(org.apache.datasketches.memory.Memory)">getEstimate</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Gets the unique count estimate from a valid memory image of a Sketch</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLowerBound(int,org.apache.datasketches.memory.Memory)">getLowerBound</a></span>&#8203;(int&nbsp;numStdDev,
org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Gets the approximate lower error bound from a valid memory image of a Sketch
given the specified number of Standard Deviations.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxAnotBResultBytes(int)">getMaxAnotBResultBytes</a></span>&#8203;(int&nbsp;maxNomEntries)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#getMaxAnotBResultBytes(int)"><code>SetOperation.getMaxAnotBResultBytes(int)</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxCompactSketchBytes(int)">getMaxCompactSketchBytes</a></span>&#8203;(int&nbsp;numberOfEntries)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#getMaxCompactSketchBytes(int)"><code>Sketch.getMaxCompactSketchBytes(int)</code></a></div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxIntersectionBytes(int)">getMaxIntersectionBytes</a></span>&#8203;(int&nbsp;nomEntries)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxUnionBytes(int)">getMaxUnionBytes</a></span>&#8203;(int&nbsp;nomEntries)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMaxUpdateSketchBytes(int)">getMaxUpdateSketchBytes</a></span>&#8203;(int&nbsp;nomEntries)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSerializationVersion(org.apache.datasketches.memory.Memory)">getSerializationVersion</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static double</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getUpperBound(int,org.apache.datasketches.memory.Memory)">getUpperBound</a></span>&#8203;(int&nbsp;numStdDev,
org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Gets the approximate upper error bound from a valid memory image of a Sketch
given the specified number of Standard Deviations.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifyCompactSketch(org.apache.datasketches.memory.Memory)">heapifyCompactSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a></div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)">heapifyCompactSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifySetOperation(org.apache.datasketches.memory.Memory)">heapifySetOperation</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a></div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifySetOperation(org.apache.datasketches.memory.Memory,long)">heapifySetOperation</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifySketch(org.apache.datasketches.memory.Memory)">heapifySketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a></div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifySketch(org.apache.datasketches.memory.Memory,long)">heapifySketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifyUpdateSketch(org.apache.datasketches.memory.Memory)">heapifyUpdateSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a></div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)">heapifyUpdateSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>static <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setOperationBuilder()">setOperationBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>static <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#updateSketchBuilder()">updateSketchBuilder</a></span>()</code></th>
<td class="colLast">
<div class="block">Ref: <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapCompactSketch(org.apache.datasketches.memory.Memory)">wrapCompactSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a></div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>static <a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapCompactSketch(org.apache.datasketches.memory.Memory,long)">wrapCompactSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>static <a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapIntersection(org.apache.datasketches.memory.Memory)">wrapIntersection</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>static <a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapIntersection(org.apache.datasketches.memory.WritableMemory)">wrapIntersection</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapSetOperation(org.apache.datasketches.memory.Memory)">wrapSetOperation</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapSetOperation(org.apache.datasketches.memory.Memory,long)">wrapSetOperation</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapSetOperation(org.apache.datasketches.memory.WritableMemory)">wrapSetOperation</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code>static <a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)">wrapSetOperation</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapSketch(org.apache.datasketches.memory.Memory)">wrapSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a></div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code>static <a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapSketch(org.apache.datasketches.memory.Memory,long)">wrapSketch</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>static <a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapUnion(org.apache.datasketches.memory.Memory)">wrapUnion</a></span>&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div>
</td>
</tr>
<tr id="i30" class="altColor">
<td class="colFirst"><code>static <a href="Union.html" title="class in org.apache.datasketches.theta">Union</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapUnion(org.apache.datasketches.memory.WritableMemory)">wrapUnion</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div>
</td>
</tr>
<tr id="i31" class="rowColor">
<td class="colFirst"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)">wrapUpdateSketch</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a></div>
</td>
</tr>
<tr id="i32" class="altColor">
<td class="colFirst"><code>static <a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)">wrapUpdateSketch</a></span>&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem,
long&nbsp;expectedSeed)</code></th>
<td class="colLast">
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://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" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getEstimate(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEstimate</h4>
<pre class="methodSignature">public static&nbsp;double&nbsp;getEstimate&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Gets the unique count estimate from a valid memory image of a Sketch</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the sketch's best estimate of the cardinality of the input stream.</dd>
</dl>
</li>
</ul>
<a id="getLowerBound(int,org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLowerBound</h4>
<pre class="methodSignature">public static&nbsp;double&nbsp;getLowerBound&#8203;(int&nbsp;numStdDev,
org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Gets the approximate lower error bound from a valid memory image of a Sketch
given the specified number of Standard Deviations.
This will return getEstimate() if isEmpty() is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd>
<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the lower bound.</dd>
</dl>
</li>
</ul>
<a id="getMaxAnotBResultBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxAnotBResultBytes</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getMaxAnotBResultBytes&#8203;(int&nbsp;maxNomEntries)</pre>
<div class="block">Ref: <a href="SetOperation.html#getMaxAnotBResultBytes(int)"><code>SetOperation.getMaxAnotBResultBytes(int)</code></a>.
Returns the maximum number of bytes for the returned CompactSketch, given the maximum
value of nomEntries of the first sketch A of AnotB.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>maxNomEntries</code> - the given value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the maximum number of bytes.</dd>
</dl>
</li>
</ul>
<a id="getMaxCompactSketchBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxCompactSketchBytes</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getMaxCompactSketchBytes&#8203;(int&nbsp;numberOfEntries)</pre>
<div class="block">Ref: <a href="Sketch.html#getMaxCompactSketchBytes(int)"><code>Sketch.getMaxCompactSketchBytes(int)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numberOfEntries</code> - Ref: <a href="Sketch.html#getMaxCompactSketchBytes(int)"><code>Sketch.getMaxCompactSketchBytes(int)</code></a>,
<code>numberOfEntries</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ref: <a href="Sketch.html#getMaxCompactSketchBytes(int)"><code>Sketch.getMaxCompactSketchBytes(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="getMaxIntersectionBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxIntersectionBytes</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getMaxIntersectionBytes&#8203;(int&nbsp;nomEntries)</pre>
<div class="block">Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a>, <code>nomEntries</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ref: <a href="SetOperation.html#getMaxIntersectionBytes(int)"><code>SetOperation.getMaxIntersectionBytes(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="getMaxUnionBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxUnionBytes</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getMaxUnionBytes&#8203;(int&nbsp;nomEntries)</pre>
<div class="block">Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a>, <code>nomEntries</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ref: <a href="SetOperation.html#getMaxUnionBytes(int)"><code>SetOperation.getMaxUnionBytes(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="getMaxUpdateSketchBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxUpdateSketchBytes</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getMaxUpdateSketchBytes&#8203;(int&nbsp;nomEntries)</pre>
<div class="block">Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nomEntries</code> - Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a>, <code>nomEntries</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ref: <a href="Sketch.html#getMaxUpdateSketchBytes(int)"><code>Sketch.getMaxUpdateSketchBytes(int)</code></a></dd>
</dl>
</li>
</ul>
<a id="getSerializationVersion(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSerializationVersion</h4>
<pre class="methodSignature">public static&nbsp;int&nbsp;getSerializationVersion&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Ref: <a href="Sketch.html#getSerializationVersion(org.apache.datasketches.memory.Memory)"><code>Sketch.getSerializationVersion(Memory)</code></a></dd>
</dl>
</li>
</ul>
<a id="getUpperBound(int,org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUpperBound</h4>
<pre class="methodSignature">public static&nbsp;double&nbsp;getUpperBound&#8203;(int&nbsp;numStdDev,
org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Gets the approximate upper error bound from a valid memory image of a Sketch
given the specified number of Standard Deviations.
This will return getEstimate() if isEmpty() is true.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>numStdDev</code> - <a href="../../../../resources/dictionary.html#numStdDev">See Number of Standard Deviations</a></dd>
<dd><code>srcMem</code> - <a href="../../../../resources/dictionary.html#mem">See Memory</a></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the upper bound.</dd>
</dl>
</li>
</ul>
<a id="heapifyCompactSketch(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifyCompactSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;heapifyCompactSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>CompactSketch.heapify(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifyCompactSketch(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifyCompactSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;heapifyCompactSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a>, <code>srcMem</code></dd>
<dd><code>expectedSeed</code> - Ref: <a href="CompactSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.heapify(Memory, long)</code></a>,
<code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapCompactSketch(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapCompactSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;wrapCompactSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>CompactSketch.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapCompactSketch(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapCompactSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a>&nbsp;wrapCompactSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a>, <code>srcMem</code></dd>
<dd><code>expectedSeed</code> - Ref: <a href="CompactSketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>CompactSketch.wrap(Memory, long)</code></a>,
<code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="CompactSketch.html" title="class in org.apache.datasketches.theta"><code>CompactSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifySetOperation(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifySetOperation</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;heapifySetOperation&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory)"><code>SetOperation.heapify(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifySetOperation(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifySetOperation</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;heapifySetOperation&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a>,
<code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
Ref: <a href="SetOperation.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.heapify(Memory, long)</code></a>,
<code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifySketch(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifySketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;heapifySketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>Sketch.heapify(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifySketch(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifySketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;heapifySketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a>, <code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
Ref: <a href="Sketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>Sketch.heapify(Memory, long)</code></a>, <code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifyUpdateSketch(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifyUpdateSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;heapifyUpdateSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.heapify(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="heapifyUpdateSketch(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>heapifyUpdateSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;heapifyUpdateSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a>,
<code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
Ref: <a href="UpdateSketch.html#heapify(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.heapify(Memory, long)</code></a>,
<code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="setOperationBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOperationBuilder</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta">SetOperationBuilder</a>&nbsp;setOperationBuilder()</pre>
<div class="block">Ref: <a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperationBuilder.html" title="class in org.apache.datasketches.theta"><code>SetOperationBuilder</code></a></dd>
</dl>
</li>
</ul>
<a id="updateSketchBuilder()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateSketchBuilder</h4>
<pre class="methodSignature">public static&nbsp;<a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta">UpdateSketchBuilder</a>&nbsp;updateSketchBuilder()</pre>
<div class="block">Ref: <a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="UpdateSketchBuilder.html" title="class in org.apache.datasketches.theta"><code>UpdateSketchBuilder</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapIntersection(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapIntersection</h4>
<pre class="methodSignature">public static&nbsp;<a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a>&nbsp;wrapIntersection&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Intersection backed by the given Memory</dd>
</dl>
</li>
</ul>
<a id="wrapIntersection(org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapIntersection</h4>
<pre class="methodSignature">public static&nbsp;<a href="Intersection.html" title="class in org.apache.datasketches.theta">Intersection</a>&nbsp;wrapIntersection&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</pre>
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Intersection</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Intersection backed by the given Memory</dd>
</dl>
</li>
</ul>
<a id="wrapSetOperation(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapSetOperation</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;wrapSetOperation&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapSetOperation(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapSetOperation</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;wrapSetOperation&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>,
<code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>,
<code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapSetOperation(org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapSetOperation</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;wrapSetOperation&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapSetOperation(org.apache.datasketches.memory.WritableMemory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapSetOperation</h4>
<pre class="methodSignature">public static&nbsp;<a href="SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a>&nbsp;wrapSetOperation&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>,
<code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>SetOperation.wrap(Memory, long)</code></a>,
<code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="SetOperation.html" title="class in org.apache.datasketches.theta"><code>SetOperation</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapSketch(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;wrapSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>Sketch.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapSketch(org.apache.datasketches.memory.Memory,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a>&nbsp;wrapSketch&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a>, <code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the expectedSeed used to validate the given Memory image.
Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>Sketch.wrap(Memory, long)</code></a>, <code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="Sketch.html" title="class in org.apache.datasketches.theta"><code>Sketch</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapUnion(org.apache.datasketches.memory.Memory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapUnion</h4>
<pre class="methodSignature">public static&nbsp;<a href="Union.html" title="class in org.apache.datasketches.theta">Union</a>&nbsp;wrapUnion&#8203;(org.apache.datasketches.memory.Memory&nbsp;srcMem)</pre>
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Union backed by the given Memory</dd>
</dl>
</li>
</ul>
<a id="wrapUnion(org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapUnion</h4>
<pre class="methodSignature">public static&nbsp;<a href="Union.html" title="class in org.apache.datasketches.theta">Union</a>&nbsp;wrapUnion&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</pre>
<div class="block">Convenience method, calls <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a> and casts the result to a Union</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="SetOperation.html#wrap(org.apache.datasketches.memory.Memory)"><code>SetOperation.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a Union backed by the given Memory</dd>
</dl>
</li>
</ul>
<a id="wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>wrapUpdateSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;wrapUpdateSketch&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem)</pre>
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory)"><code>UpdateSketch.wrap(Memory)</code></a>, <code>srcMem</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd>
</dl>
</li>
</ul>
<a id="wrapUpdateSketch(org.apache.datasketches.memory.WritableMemory,long)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>wrapUpdateSketch</h4>
<pre class="methodSignature">public static&nbsp;<a href="UpdateSketch.html" title="class in org.apache.datasketches.theta">UpdateSketch</a>&nbsp;wrapUpdateSketch&#8203;(org.apache.datasketches.memory.WritableMemory&nbsp;srcMem,
long&nbsp;expectedSeed)</pre>
<div class="block">Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>srcMem</code> - Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a>, <code>srcMem</code></dd>
<dd><code>expectedSeed</code> - the seed used to validate the given Memory image.
Ref: <a href="Sketch.html#wrap(org.apache.datasketches.memory.Memory,long)"><code>UpdateSketch.wrap(Memory, long)</code></a>, <code>expectedSeed</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="UpdateSketch.html" title="class in org.apache.datasketches.theta"><code>UpdateSketch</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Sketches.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&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>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>