| <!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 (9) on Fri Oct 01 19:18:48 PDT 2021 --> |
| <title>Union (datasketches-java 3.1.0-SNAPSHOT API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="date" content="2021-10-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.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-1.10.2.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Union (datasketches-java 3.1.0-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":10,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../";loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="fixedNav"> |
| <!-- ========= 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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Union.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="../../../../org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/datasketches/theta/UpdateReturnState.html" title="enum in org.apache.datasketches.theta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/datasketches/theta/Union.html" target="_top">Frames</a></li> |
| <li><a href="Union.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><span>SEARCH: </span> |
| <input type="text" id="search" value=" " disabled="disabled"> |
| <input type="reset" id="reset" value=" " 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="../../../../org/apache/datasketches/theta/package-summary.html">org.apache.datasketches.theta</a></div> |
| <h2 title="Class Union" class="title">Class Union</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">org.apache.datasketches.theta.SetOperation</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.datasketches.theta.Union</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">Union</span> |
| extends <a href="../../../../org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></pre> |
| <div class="block">Compute the union of two or more theta sketches. |
| A new instance represents an empty set.</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"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#Union--">Union</a></span>​()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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><a href="../../../../org/apache/datasketches/Family.html" title="enum in org.apache.datasketches">Family</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#getFamily--">getFamily</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the Family of this SetOperation</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#getResult--">getResult</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#getResult-boolean-org.apache.datasketches.memory.WritableMemory-">getResult</a></span>​(boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</code></th> |
| <td class="colLast"> |
| <div class="block">Gets the result of this operation as a CompactSketch of the chosen form.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#reset--">reset</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Resets this Union.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract byte[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#toByteArray--">toByteArray</a></span>​()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a byte array image of this Union object</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.memory.Memory-">union</a></span>​(org.apache.datasketches.memory.Memory mem)</code></th> |
| <td class="colLast"> |
| <div class="block">Perform a Union operation with <i>this</i> union and the given Memory image of any sketch of the |
| Theta Family.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.theta.Sketch-">union</a></span>​(<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</code></th> |
| <td class="colLast"> |
| <div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-">union</a></span>​(<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</code></th> |
| <td class="colLast"> |
| <div class="block">This implements a stateless, pair-wise union operation.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#union-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-boolean-org.apache.datasketches.memory.WritableMemory-">union</a></span>​(<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</code></th> |
| <td class="colLast"> |
| <div class="block">This implements a stateless, pair-wise union operation.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-byte:A-">update</a></span>​(byte[] data)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the given byte array item.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-char:A-">update</a></span>​(char[] data)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the given char array item.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-double-">update</a></span>​(double datum)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the given double (or float) data item.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-int:A-">update</a></span>​(int[] data)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the given integer array item.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-long-">update</a></span>​(long datum)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the given long data item.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-long:A-">update</a></span>​(long[] data)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the given long array item.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>abstract void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../../org/apache/datasketches/theta/Union.html#update-java.lang.String-">update</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> datum)</code></th> |
| <td class="colLast"> |
| <div class="block">Update <i>this</i> union with the with the given String data item.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.datasketches.theta.SetOperation"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.datasketches.theta.<a href="../../../../org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></h3> |
| <code><a href="../../../../org/apache/datasketches/theta/SetOperation.html#builder--">builder</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#getMaxAnotBResultBytes-int-">getMaxAnotBResultBytes</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#getMaxIntersectionBytes-int-">getMaxIntersectionBytes</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#getMaxUnionBytes-int-">getMaxUnionBytes</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#heapify-org.apache.datasketches.memory.Memory-">heapify</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#heapify-org.apache.datasketches.memory.Memory-long-">heapify</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#isSameResource-org.apache.datasketches.memory.Memory-">isSameResource</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#wrap-org.apache.datasketches.memory.Memory-">wrap</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#wrap-org.apache.datasketches.memory.Memory-long-">wrap</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#wrap-org.apache.datasketches.memory.WritableMemory-">wrap</a>, <a href="../../../../org/apache/datasketches/theta/SetOperation.html#wrap-org.apache.datasketches.memory.WritableMemory-long-">wrap</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Union--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Union</h4> |
| <pre>public Union​()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFamily--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFamily</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/Family.html" title="enum in org.apache.datasketches">Family</a> getFamily​()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/datasketches/theta/SetOperation.html#getFamily--">SetOperation</a></code></span></div> |
| <div class="block">Gets the Family of this SetOperation</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/apache/datasketches/theta/SetOperation.html#getFamily--">getFamily</a></code> in class <code><a href="../../../../org/apache/datasketches/theta/SetOperation.html" title="class in org.apache.datasketches.theta">SetOperation</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the Family of this SetOperation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResult--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre>public abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a> getResult​()</pre> |
| <div class="block">Gets the result of this operation as an ordered CompactSketch on the Java heap. |
| This does not disturb the underlying data structure of the union. |
| Therefore, it is OK to continue updating the union after this operation.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of this operation as an ordered CompactSketch on the Java heap</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResult-boolean-org.apache.datasketches.memory.WritableMemory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre>public abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a> getResult​(boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</pre> |
| <div class="block">Gets the result of this operation as a CompactSketch of the chosen form. |
| This does not disturb the underlying data structure of the union. |
| Therefore, it is OK to continue updating the union after this operation.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dstOrdered</code> - <a href="../../../../resources/dictionary.html#dstOrdered">See Destination Ordered</a></dd> |
| <dd><code>dstMem</code> - <a href="../../../../resources/dictionary.html#dstMem">See Destination Memory</a>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of this operation as a CompactSketch of the chosen form</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public abstract void reset​()</pre> |
| <div class="block">Resets this Union. The seed remains intact, everything else reverts back to its virgin state.</div> |
| </li> |
| </ul> |
| <a name="toByteArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre>public abstract byte[] toByteArray​()</pre> |
| <div class="block">Returns a byte array image of this Union object</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array image of this Union object</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="union-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>union</h4> |
| <pre>public <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a> union​(<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB)</pre> |
| <div class="block">This implements a stateless, pair-wise union operation. The returned sketch will be cutback to |
| the smaller of the two k values if required. |
| |
| <p>Nulls and empty sketches are ignored.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchA</code> - The first argument</dd> |
| <dd><code>sketchB</code> - The second argument</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result ordered CompactSketch on the heap.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="union-org.apache.datasketches.theta.Sketch-org.apache.datasketches.theta.Sketch-boolean-org.apache.datasketches.memory.WritableMemory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>union</h4> |
| <pre>public abstract <a href="../../../../org/apache/datasketches/theta/CompactSketch.html" title="class in org.apache.datasketches.theta">CompactSketch</a> union​(<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchA, |
| <a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchB, |
| boolean dstOrdered, |
| org.apache.datasketches.memory.WritableMemory dstMem)</pre> |
| <div class="block">This implements a stateless, pair-wise union operation. The returned sketch will be cutback to |
| k if required, similar to the regular Union operation. |
| |
| <p>Nulls and empty sketches are ignored.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchA</code> - The first argument</dd> |
| <dd><code>sketchB</code> - The second argument</dd> |
| <dd><code>dstOrdered</code> - If true, the returned CompactSketch will be ordered.</dd> |
| <dd><code>dstMem</code> - If not null, the returned CompactSketch will be placed in this WritableMemory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result CompactSketch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="union-org.apache.datasketches.theta.Sketch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>union</h4> |
| <pre>public abstract void union​(<a href="../../../../org/apache/datasketches/theta/Sketch.html" title="class in org.apache.datasketches.theta">Sketch</a> sketchIn)</pre> |
| <div class="block">Perform a Union operation with <i>this</i> union and the given on-heap sketch of the Theta Family. |
| This method is not valid for the older SetSketch, which was prior to Open Source (August, 2015). |
| |
| <p>This method can be repeatedly called. |
| |
| <p>Nulls and empty sketches are ignored.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchIn</code> - The incoming sketch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="union-org.apache.datasketches.memory.Memory-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>union</h4> |
| <pre>public abstract void union​(org.apache.datasketches.memory.Memory mem)</pre> |
| <div class="block">Perform a Union operation with <i>this</i> union and the given Memory image of any sketch of the |
| Theta Family. The input image may be from earlier versions of the Theta Compact Sketch, |
| called the SetSketch (circa 2012), which was prior to Open Source and are compact and ordered. |
| |
| <p>This method can be repeatedly called. |
| |
| <p>Nulls and empty sketches are ignored.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>mem</code> - Memory image of sketch to be merged</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(long datum)</pre> |
| <div class="block">Update <i>this</i> union with the given long data item.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>datum</code> - The given long datum.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(double datum)</pre> |
| <div class="block">Update <i>this</i> union with the given double (or float) data item. |
| The double will be converted to a long using Double.doubleToLongBits(datum), |
| which normalizes all NaN values to a single NaN representation. |
| Plus and minus zero will be normalized to plus zero. |
| Each of the special floating-point values NaN and +/- Infinity are treated as distinct.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>datum</code> - The given double datum.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> datum)</pre> |
| <div class="block">Update <i>this</i> union with the with the given String data item. |
| The string is converted to a byte array using UTF8 encoding. |
| If the string is null or empty no update attempt is made and the method returns. |
| |
| <p>Note: this will not produce the same output hash values as the <a href="../../../../org/apache/datasketches/theta/Union.html#update-char:A-"><code>update(char[])</code></a> |
| method and will generally be a little slower depending on the complexity of the UTF8 encoding. |
| </p> |
| |
| <p>Note: this is not a Sketch Union operation. This treats the given string as a data item.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>datum</code> - The given String.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(byte[] data)</pre> |
| <div class="block">Update <i>this</i> union with the given byte array item. |
| If the byte array is null or empty no update attempt is made and the method returns. |
| |
| <p>Note: this is not a Sketch Union operation. This treats the given byte array as a data |
| item.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - The given byte array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-int:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(int[] data)</pre> |
| <div class="block">Update <i>this</i> union with the given integer array item. |
| If the integer array is null or empty no update attempt is made and the method returns. |
| |
| <p>Note: this is not a Sketch Union operation. This treats the given integer array as a data |
| item.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - The given int array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-char:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(char[] data)</pre> |
| <div class="block">Update <i>this</i> union with the given char array item. |
| If the char array is null or empty no update attempt is made and the method returns. |
| |
| <p>Note: this will not produce the same output hash values as the <a href="../../../../org/apache/datasketches/theta/Union.html#update-java.lang.String-"><code>update(String)</code></a> |
| method but will be a little faster as it avoids the complexity of the UTF8 encoding.</p> |
| |
| <p>Note: this is not a Sketch Union operation. This treats the given char array as a data |
| item.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - The given char array.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-long:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public abstract void update​(long[] data)</pre> |
| <div class="block">Update <i>this</i> union with the given long array item. |
| If the long array is null or empty no update attempt is made and the method returns. |
| |
| <p>Note: this is not a Sketch Union operation. This treats the given char array as a data |
| item.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>data</code> - The given long array.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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 class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/Union.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="../../../../org/apache/datasketches/theta/Sketches.html" title="class in org.apache.datasketches.theta"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/datasketches/theta/UpdateReturnState.html" title="enum in org.apache.datasketches.theta"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/datasketches/theta/Union.html" target="_top">Frames</a></li> |
| <li><a href="Union.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |