| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>org.apache.datasketches.tuple (datasketches-java 4.0.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.datasketches.tuple (datasketches-java 4.0.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li 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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="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> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.datasketches.tuple</h1> |
| </div> |
| <div class="contentContainer"> |
| <section><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">The tuple package contains a number of sketches based on the same |
| fundamental algorithms of the Theta Sketch Framework and extend these |
| concepts for whole new families of sketches.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a></th> |
| <td class="colLast"> |
| <div class="block">Interface for user-defined Summary, which is associated with every hash in a tuple sketch</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SummaryDeserializer.html" title="interface in org.apache.datasketches.tuple">SummaryDeserializer</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Interface for deserializing user-defined Summary</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SummaryFactory.html" title="interface in org.apache.datasketches.tuple">SummaryFactory</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Interface for user-defined SummaryFactory</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <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"> |
| <th class="colFirst" scope="row"><a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U></th> |
| <td class="colLast"> |
| <div class="block">Interface for updating user-defined Summary</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="AnotB.html" title="class in org.apache.datasketches.tuple">AnotB</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Computes a set difference, A-AND-NOT-B, of two generic tuple sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="CompactSketch.html" title="class in org.apache.datasketches.tuple">CompactSketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">CompactSketches are never created directly.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="DeserializeResult.html" title="class in org.apache.datasketches.tuple">DeserializeResult</a><T></th> |
| <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="rowColor"> |
| <th class="colFirst" scope="row"><a href="Filter.html" title="class in org.apache.datasketches.tuple">Filter</a><T extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Class for filtering entries from a <a href="Sketch.html" title="class in org.apache.datasketches.tuple"><code>Sketch</code></a> given a <a href="Summary.html" title="interface in org.apache.datasketches.tuple"><code>Summary</code></a></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Intersection.html" title="class in org.apache.datasketches.tuple">Intersection</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Computes an intersection of two or more generic tuple sketches or generic tuple sketches |
| combined with theta sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JaccardSimilarity.html" title="class in org.apache.datasketches.tuple">JaccardSimilarity</a></th> |
| <td class="colLast"> |
| <div class="block">Jaccard similarity of two Tuple Sketches, or alternatively, of a Tuple and Theta Sketch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="SerializerDeserializer.html" title="class in org.apache.datasketches.tuple">SerializerDeserializer</a></th> |
| <td class="colLast"> |
| <div class="block">Multipurpose serializer-deserializer for a collection of sketches defined by the enum.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Sketch.html" title="class in org.apache.datasketches.tuple">Sketch</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">This is an equivalent to org.apache.datasketches.theta.Sketch with |
| addition of a user-defined Summary object associated with every unique entry |
| in the sketch.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Sketches.html" title="class in org.apache.datasketches.tuple">Sketches</a></th> |
| <td class="colLast"> |
| <div class="block">Convenient static methods to instantiate generic tuple sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="TupleSketchIterator.html" title="class in org.apache.datasketches.tuple">TupleSketchIterator</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Iterator over a generic tuple sketch</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Union.html" title="class in org.apache.datasketches.tuple">Union</a><S extends <a href="Summary.html" title="interface in org.apache.datasketches.tuple">Summary</a>></th> |
| <td class="colLast"> |
| <div class="block">Compute the union of two or more generic tuple sketches or generic tuple sketches combined with |
| theta sketches.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="UpdatableSketch.html" title="class in org.apache.datasketches.tuple">UpdatableSketch</a><U,​S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></th> |
| <td class="colLast"> |
| <div class="block">An extension of QuickSelectSketch<S>, which can be updated with many types of keys.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="UpdatableSketchBuilder.html" title="class in org.apache.datasketches.tuple">UpdatableSketchBuilder</a><U,​S extends <a href="UpdatableSummary.html" title="interface in org.apache.datasketches.tuple">UpdatableSummary</a><U>></th> |
| <td class="colLast"> |
| <div class="block">For building a new generic tuple UpdatableSketch</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="Util.html" title="class in org.apache.datasketches.tuple">Util</a></th> |
| <td class="colLast"> |
| <div class="block">Common utility functions for Tuples</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <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"> |
| <th class="colFirst" scope="row"><a href="SerializerDeserializer.SketchType.html" title="enum in org.apache.datasketches.tuple">SerializerDeserializer.SketchType</a></th> |
| <td class="colLast"> |
| <div class="block">Defines the sketch classes that this SerializerDeserializer can handle.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li 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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2015–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
