| <!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 Oct 25 17:06:11 PDT 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>com.yahoo.sketches.tuple (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)</title> |
| <meta name="date" content="2018-10-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="com.yahoo.sketches.tuple (com.yahoo.datasketches:sketches-core 0.12.1-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/yahoo/sketches/theta/package-summary.html">Prev Package</a></li> |
| <li>Next Package</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/tuple/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package com.yahoo.sketches.tuple</h1> |
| <div class="docSummary"> |
| <div class="block">The tuple package contains implementation of sketches based on the idea of |
| theta sketches with the addition of values associated with unique keys.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesCombiner.html" title="interface in com.yahoo.sketches.tuple">ArrayOfDoublesCombiner</a></td> |
| <td class="colLast"> |
| <div class="block">Combines two arrays of double values for use with ArrayOfDoubles tuple sketches</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesSketchIterator.html" title="interface in com.yahoo.sketches.tuple">ArrayOfDoublesSketchIterator</a></td> |
| <td class="colLast"> |
| <div class="block">Interface for iterating over tuple sketches of type ArrayOfDoubles</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a></td> |
| <td class="colLast"> |
| <div class="block">Interface for user-defined Summary, which is associated with every key in a tuple sketch</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/SummaryDeserializer.html" title="interface in com.yahoo.sketches.tuple">SummaryDeserializer</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Interface for deserializing user-defined Summary</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/SummaryFactory.html" title="interface in com.yahoo.sketches.tuple">SummaryFactory</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Interface for user-defined SummaryFactory</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/SummarySetOperations.html" title="interface in com.yahoo.sketches.tuple">SummarySetOperations</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">This is to provide methods of producing unions and intersections of two Summary objects.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/UpdatableSummary.html" title="interface in com.yahoo.sketches.tuple">UpdatableSummary</a><U></td> |
| <td class="colLast"> |
| <div class="block">Interface for updating user-defined Summary</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/AnotB.html" title="class in com.yahoo.sketches.tuple">AnotB</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Computes a set difference of two generic tuple sketches</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesAnotB.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesAnotB</a></td> |
| <td class="colLast"> |
| <div class="block">Computes a set difference of two tuple sketches of type ArrayOfDoubles</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesCompactSketch.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesCompactSketch</a></td> |
| <td class="colLast"> |
| <div class="block">Top level compact tuple sketch of type ArrayOfDoubles.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesIntersection.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesIntersection</a></td> |
| <td class="colLast"> |
| <div class="block">Computes the intersection of two or more tuple sketches of type ArrayOfDoubles.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesSetOperationBuilder.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesSetOperationBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Builds set operations object for tuple sketches of type ArrayOfDoubles.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesSketch.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesSketch</a></td> |
| <td class="colLast"> |
| <div class="block">The base class for the tuple sketch of type ArrayOfDoubles, where an array of double values |
| is associated with each key.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesSketches.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesSketches</a></td> |
| <td class="colLast"> |
| <div class="block">Convenient static methods to instantiate tuple sketches of type ArrayOfDoubles.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesUnion.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesUnion</a></td> |
| <td class="colLast"> |
| <div class="block">The base class for unions of tuple sketches of type ArrayOfDoubles.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesUpdatableSketch.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesUpdatableSketch</a></td> |
| <td class="colLast"> |
| <div class="block">The top level for updatable tuple sketches of type ArrayOfDoubles.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/ArrayOfDoublesUpdatableSketchBuilder.html" title="class in com.yahoo.sketches.tuple">ArrayOfDoublesUpdatableSketchBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">For building a new ArrayOfDoublesUpdatableSketch</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/CompactSketch.html" title="class in com.yahoo.sketches.tuple">CompactSketch</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">CompactSketches are never created directly.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/DeserializeResult.html" title="class in com.yahoo.sketches.tuple">DeserializeResult</a><T></td> |
| <td class="colLast"> |
| <div class="block">Returns an object and its size in bytes as a result of a deserialize operation</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.html" title="class in com.yahoo.sketches.tuple">DoubleSummary</a></td> |
| <td class="colLast"> |
| <div class="block">Summary for generic tuple sketches of type Double.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryDeserializer.html" title="class in com.yahoo.sketches.tuple">DoubleSummaryDeserializer</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummaryFactory.html" title="class in com.yahoo.sketches.tuple">DoubleSummaryFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory for DoubleSummary.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummarySetOperations.html" title="class in com.yahoo.sketches.tuple">DoubleSummarySetOperations</a></td> |
| <td class="colLast"> |
| <div class="block">Methods for producing unions and intersections of two objects of type DoubleSummary.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/Filter.html" title="class in com.yahoo.sketches.tuple">Filter</a><T extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Class for filtering entries from a <a href="../../../../com/yahoo/sketches/tuple/Sketch.html" title="class in com.yahoo.sketches.tuple"><code>Sketch</code></a> given a <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple"><code>Summary</code></a></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/Intersection.html" title="class in com.yahoo.sketches.tuple">Intersection</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Computes an intersection of two or more generic tuple sketches.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/Sketch.html" title="class in com.yahoo.sketches.tuple">Sketch</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">This is an equivalent to com.yahoo.sketches.theta.Sketch with |
| addition of a user-defined Summary object associated with every unique entry |
| in the sketch.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/Sketches.html" title="class in com.yahoo.sketches.tuple">Sketches</a></td> |
| <td class="colLast"> |
| <div class="block">Convenient static methods to instantiate generic tuple sketches.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/SketchIterator.html" title="class in com.yahoo.sketches.tuple">SketchIterator</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Iterator over a generic tuple sketch</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/Union.html" title="class in com.yahoo.sketches.tuple">Union</a><S extends <a href="../../../../com/yahoo/sketches/tuple/Summary.html" title="interface in com.yahoo.sketches.tuple">Summary</a>></td> |
| <td class="colLast"> |
| <div class="block">Compute a union of two or more tuple sketches.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/UpdatableSketch.html" title="class in com.yahoo.sketches.tuple">UpdatableSketch</a><U,S extends <a href="../../../../com/yahoo/sketches/tuple/UpdatableSummary.html" title="interface in com.yahoo.sketches.tuple">UpdatableSummary</a><U>></td> |
| <td class="colLast"> |
| <div class="block">An extension of QuickSelectSketch, which can be updated with many types of keys.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/UpdatableSketchBuilder.html" title="class in com.yahoo.sketches.tuple">UpdatableSketchBuilder</a><U,S extends <a href="../../../../com/yahoo/sketches/tuple/UpdatableSummary.html" title="interface in com.yahoo.sketches.tuple">UpdatableSummary</a><U>></td> |
| <td class="colLast"> |
| <div class="block">For building a new generic tuple UpdatableSketch</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../com/yahoo/sketches/tuple/DoubleSummary.Mode.html" title="enum in com.yahoo.sketches.tuple">DoubleSummary.Mode</a></td> |
| <td class="colLast"> |
| <div class="block">The aggregation modes for this Summary</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package com.yahoo.sketches.tuple Description">Package com.yahoo.sketches.tuple Description</h2> |
| <div class="block">The tuple package contains implementation of sketches based on the idea of |
| theta sketches with the addition of values associated with unique keys. |
| Two sets of tuple sketch classes are available at the moment: |
| generic tuple sketches with user-defined Summary, and a faster specialized |
| implementation with an array of double values. |
| See unit tests for usage examples.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Alexander Saydakov</dd> |
| </dl> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../com/yahoo/sketches/theta/package-summary.html">Prev Package</a></li> |
| <li>Next Package</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?com/yahoo/sketches/tuple/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2015–2018. All rights reserved.</small></p> |
| </body> |
| </html> |
