| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_162) on Thu Mar 14 13:13:09 PDT 2019 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ItemsUnion (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)</title> |
| <meta name="date" content="2019-03-14"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ItemsUnion (com.yahoo.datasketches:sketches-core 0.13.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":9,"i2":9,"i3":9,"i4":9,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ItemsUnion.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/yahoo/sketches/quantiles/ItemsSketchIterator.html" title="class in com.yahoo.sketches.quantiles"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/yahoo/sketches/quantiles/UpdateDoublesSketch.html" title="class in com.yahoo.sketches.quantiles"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/quantiles/ItemsUnion.html" target="_top">Frames</a></li> |
| <li><a href="ItemsUnion.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> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">com.yahoo.sketches.quantiles</div> |
| <h2 title="Class ItemsUnion" class="title">Class ItemsUnion<T></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">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.yahoo.sketches.quantiles.ItemsUnion<T></li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of item</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public final class <span class="typeNameLabel">ItemsUnion<T></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">Object</a></pre> |
| <div class="block">The API for Union operations for generic ItemsSketches</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lee Rhodes, Alexander Saydakov</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#comparator_">comparator_</a></span></code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#gadget_">gadget_</a></span></code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#maxK_">maxK_</a></span></code> </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" border="0" cellpadding="3" cellspacing="0" 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getEffectiveK--">getEffectiveK</a></span>()</code> |
| <div class="block">Returns the effective <i>k</i> of this Union.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getInstance-java.util.Comparator-">getInstance</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super T> comparator)</code> |
| <div class="block">Create an instance of ItemsUnion with the default k</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getInstance-int-java.util.Comparator-">getInstance</a></span>(int maxK, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super T> comparator)</code> |
| <div class="block">Create an instance of ItemsUnion</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getInstance-com.yahoo.sketches.quantiles.ItemsSketch-">getInstance</a></span>(<a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><T> sketch)</code> |
| <div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getInstance-com.yahoo.memory.Memory-java.util.Comparator-com.yahoo.sketches.ArrayOfItemsSerDe-">getInstance</a></span>(com.yahoo.memory.Memory srcMem, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super T> comparator, |
| <a href="../../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><T> serDe)</code> |
| <div class="block">Heapify the given srcMem into a Union object.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getMaxK--">getMaxK</a></span>()</code> |
| <div class="block">Returns the configured <i>maxK</i> of this Union.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getResult--">getResult</a></span>()</code> |
| <div class="block">Gets the result of this Union operation as a copy of the internal state.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getResultAndReset--">getResultAndReset</a></span>()</code> |
| <div class="block">Gets the result of this Union operation (without a copy) and resets this Union to the |
| virgin state.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#isDirect--">isDirect</a></span>()</code> |
| <div class="block">Returns true if this union is direct</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#isEmpty--">isEmpty</a></span>()</code> |
| <div class="block">Returns true if this union is empty</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#reset--">reset</a></span>()</code> |
| <div class="block">Resets this Union to a virgin state.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#toByteArray-com.yahoo.sketches.ArrayOfItemsSerDe-">toByteArray</a></span>(<a href="../../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</code> |
| <div class="block">Serialize this union to a byte array.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#toString--">toString</a></span>()</code> |
| <div class="block">Returns summary information about the backing sketch.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#toString-boolean-boolean-">toString</a></span>(boolean sketchSummary, |
| boolean dataDetail)</code> |
| <div class="block">Returns summary information about the backing sketch.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#update-com.yahoo.sketches.quantiles.ItemsSketch-">update</a></span>(<a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> sketchIn)</code> |
| <div class="block">Iterative union operation, which means this method can be repeatedly called.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#update-com.yahoo.memory.Memory-com.yahoo.sketches.ArrayOfItemsSerDe-">update</a></span>(com.yahoo.memory.Memory srcMem, |
| <a href="../../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</code> |
| <div class="block">Iterative union operation, which means this method can be repeatedly called.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#update-T-">update</a></span>(<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a> dataItem)</code> |
| <div class="block">Update this union with the given double (or float) 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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="maxK_"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>maxK_</h4> |
| <pre>protected final int maxK_</pre> |
| </li> |
| </ul> |
| <a name="comparator_"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>comparator_</h4> |
| <pre>protected final <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> comparator_</pre> |
| </li> |
| </ul> |
| <a name="gadget_"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>gadget_</h4> |
| <pre>protected <a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> gadget_</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getInstance-java.util.Comparator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>public static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T> getInstance(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super T> comparator)</pre> |
| <div class="block">Create an instance of ItemsUnion with the default k</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of item</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>comparator</code> - to compare items</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of ItemsUnion</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstance-int-java.util.Comparator-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>public static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T> getInstance(int maxK, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super T> comparator)</pre> |
| <div class="block">Create an instance of ItemsUnion</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of item</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxK</code> - determines the accuracy and size of the union and is a maximum value. |
| The effective <i>k</i> can be smaller due to unions with smaller <i>k</i> sketches. |
| It is recommended that <i>maxK</i> be a power of 2 to enable unioning of sketches with |
| different values of <i>k</i>.</dd> |
| <dd><code>comparator</code> - to compare items</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of ItemsUnion</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstance-com.yahoo.memory.Memory-java.util.Comparator-com.yahoo.sketches.ArrayOfItemsSerDe-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>public static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T> getInstance(com.yahoo.memory.Memory srcMem, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</a><? super T> comparator, |
| <a href="../../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><T> serDe)</pre> |
| <div class="block">Heapify the given srcMem into a Union object.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of item</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcMem</code> - the given srcMem. |
| A reference to srcMem will not be maintained internally.</dd> |
| <dd><code>comparator</code> - to compare items</dd> |
| <dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of ItemsUnion</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInstance-com.yahoo.sketches.quantiles.ItemsSketch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInstance</h4> |
| <pre>public static <T> <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="class in com.yahoo.sketches.quantiles">ItemsUnion</a><T> getInstance(<a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><T> sketch)</pre> |
| <div class="block">Create an instance of ItemsUnion based on ItemsSketch</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - type of item</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketch</code> - the basis of the union</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an instance of ItemsUnion</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-com.yahoo.sketches.quantiles.ItemsSketch-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public void update(<a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> sketchIn)</pre> |
| <div class="block">Iterative union operation, which means this method can be repeatedly called. |
| Merges the given sketch into this union object. |
| The given sketch is not modified. |
| It is required that the ratio of the two K values be a power of 2. |
| This is easily satisfied if each of the K values is already a power of 2. |
| If the given sketch is null or empty it is ignored. |
| |
| <p>It is required that the results of the union operation, which can be obtained at any time, |
| is obtained from <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getResult--"><code>getResult()</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchIn</code> - the sketch to be merged into this one.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-com.yahoo.memory.Memory-com.yahoo.sketches.ArrayOfItemsSerDe-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public void update(com.yahoo.memory.Memory srcMem, |
| <a href="../../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</pre> |
| <div class="block">Iterative union operation, which means this method can be repeatedly called. |
| Merges the given Memory image of a ItemsSketch into this union object. |
| The given Memory object is not modified and a link to it is not retained. |
| It is required that the ratio of the two K values be a power of 2. |
| This is easily satisfied if each of the K values is already a power of 2. |
| If the given sketch is null or empty it is ignored. |
| |
| <p>It is required that the results of the union operation, which can be obtained at any time, |
| is obtained from <a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html#getResult--"><code>getResult()</code></a>.</p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>srcMem</code> - Memory image of sketch to be merged</dd> |
| <dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="update-java.lang.Object-"> |
| <!-- --> |
| </a><a name="update-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>update</h4> |
| <pre>public void update(<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a> dataItem)</pre> |
| <div class="block">Update this union with the given double (or float) data Item.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dataItem</code> - The given datum.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResult--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResult</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> getResult()</pre> |
| <div class="block">Gets the result of this Union operation as a copy of the internal state. |
| This enables further union update operations on this state.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of this Union operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getResultAndReset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResultAndReset</h4> |
| <pre>public <a href="../../../../com/yahoo/sketches/quantiles/ItemsSketch.html" title="class in com.yahoo.sketches.quantiles">ItemsSketch</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> getResultAndReset()</pre> |
| <div class="block">Gets the result of this Union operation (without a copy) and resets this Union to the |
| virgin state.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the result of this Union operation and reset.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block">Resets this Union to a virgin state.</div> |
| </li> |
| </ul> |
| <a name="isEmpty--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isEmpty</h4> |
| <pre>public boolean isEmpty()</pre> |
| <div class="block">Returns true if this union is empty</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this union is empty</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isDirect--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isDirect</h4> |
| <pre>public boolean isDirect()</pre> |
| <div class="block">Returns true if this union is direct</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if this union is direct</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxK--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxK</h4> |
| <pre>public int getMaxK()</pre> |
| <div class="block">Returns the configured <i>maxK</i> of this Union.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configured <i>maxK</i> of this Union.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEffectiveK--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEffectiveK</h4> |
| <pre>public int getEffectiveK()</pre> |
| <div class="block">Returns the effective <i>k</i> of this Union.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the effective <i>k</i> of this Union.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> |
| <div class="block">Returns summary information about the backing sketch.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString(boolean sketchSummary, |
| boolean dataDetail)</pre> |
| <div class="block">Returns summary information about the backing sketch. Used for debugging.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>sketchSummary</code> - if true includes sketch summary</dd> |
| <dd><code>dataDetail</code> - if true includes data detail</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>summary information about the sketch.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toByteArray-com.yahoo.sketches.ArrayOfItemsSerDe-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toByteArray</h4> |
| <pre>public byte[] toByteArray(<a href="../../../../com/yahoo/sketches/ArrayOfItemsSerDe.html" title="class in com.yahoo.sketches">ArrayOfItemsSerDe</a><<a href="../../../../com/yahoo/sketches/quantiles/ItemsUnion.html" title="type parameter in ItemsUnion">T</a>> serDe)</pre> |
| <div class="block">Serialize this union to a byte array. Result is an ItemsSketch, serialized in an |
| unordered, non-compact form. The resulting byte[] can be passed to getInstance for either a |
| sketch or union.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>serDe</code> - an instance of ArrayOfItemsSerDe</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>byte array of this union</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/ItemsUnion.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/yahoo/sketches/quantiles/ItemsSketchIterator.html" title="class in com.yahoo.sketches.quantiles"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../com/yahoo/sketches/quantiles/UpdateDoublesSketch.html" title="class in com.yahoo.sketches.quantiles"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/quantiles/ItemsUnion.html" target="_top">Frames</a></li> |
| <li><a href="ItemsUnion.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> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </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–2019. All rights reserved.</small></p> |
| </body> |
| </html> |
