| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (25) --> |
| <title>IntegerSummarySetOperations (datasketches-java 9.0.1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.datasketches.tuple.aninteger, class: IntegerSummarySetOperations"> |
| <meta name="generator" content="javadoc/ClassWriter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../resource-files/jquery-ui.min.css"> |
| <link rel="stylesheet" type="text/css" href="../../../../../resource-files/stylesheet.css"> |
| <script type="text/javascript" src="../../../../../script-files/script.js"></script> |
| <script type="text/javascript" src="../../../../../script-files/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-files/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">const pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="nav-content"> |
| <div class="nav-menu-button"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button></div> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/IntegerSummarySetOperations.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="../../../../../search.html">Search</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="sub-nav"> |
| <div class="nav-content"> |
| <ol class="sub-nav-list"> |
| <li><a href="package-summary.html">org.apache.datasketches.tuple.aninteger</a></li> |
| <li><a href="IntegerSummarySetOperations.html" class="current-selection">IntegerSummarySetOperations</a></li> |
| </ol> |
| <div class="nav-list-search"><input type="text" id="search-input" disabled placeholder="Search documentation (type /)" aria-label="Search in documentation" autocomplete="off" spellcheck="false"><input type="reset" id="reset-search" disabled value="Reset"></div> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="main-grid"> |
| <nav role="navigation" class="toc" aria-label="Table of contents"> |
| <div class="toc-header">Contents <input type="text" class="filter-input" disabled placeholder="Filter contents (type .)" aria-label="Filter table of contents" autocomplete="off" spellcheck="false"><input type="reset" class="reset-filter" disabled tabindex="-1" value="Reset"></div> |
| <ol class="toc-list" tabindex="-1"> |
| <li><a href="#" tabindex="0">Description</a></li> |
| <li><a href="#constructor-summary" tabindex="0">Constructor Summary</a></li> |
| <li><a href="#method-summary" tabindex="0">Method Summary</a></li> |
| <li><a href="#constructor-detail" tabindex="0">Constructor Details</a> |
| <ol class="toc-list"> |
| <li><a href="#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" tabindex="0">IntegerSummarySetOperations(IntegerSummary.Mode, IntegerSummary.Mode)</a></li> |
| </ol> |
| </li> |
| <li><a href="#method-detail" tabindex="0">Method Details</a> |
| <ol class="toc-list"> |
| <li><a href="#union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" tabindex="0">union(IntegerSummary, IntegerSummary)</a></li> |
| <li><a href="#intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" tabindex="0">intersection(IntegerSummary, IntegerSummary)</a></li> |
| </ol> |
| </li> |
| </ol> |
| <button class="hide-sidebar"><span>Hide sidebar </span><img src="../../../../../resource-files/left.svg" alt="Hide sidebar"></button><button class="show-sidebar"><img src="../../../../../resource-files/right.svg" alt="Show sidebar"><span> Show sidebar</span></button></nav> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <h1 title="Class IntegerSummarySetOperations" class="title">Class IntegerSummarySetOperations</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.datasketches.tuple.aninteger.IntegerSummarySetOperations</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> |
| </dl> |
| <hr> |
| <div class="horizontal-scroll"> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">IntegerSummarySetOperations</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> |
| implements <a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></span></div> |
| <div class="block">Methods for defining how unions and intersections of two objects of type IntegerSummary |
| are performed.</div> |
| <dl class="notes"> |
| <dt>Author:</dt> |
| <dd>Lee Rhodes</dd> |
| </dl> |
| </div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)" class="member-name-link">IntegerSummarySetOperations</a><wbr>(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> unionSummaryMode, |
| <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> intersectionSummaryMode)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a new instance with two modes</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0"> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">intersection</a><wbr>(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, |
| <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is called by the intersection operator when both sketches have the same hash value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)" class="member-name-link">union</a><wbr>(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, |
| <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is called by the union operator when both sketches have the same hash value.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#method-summary" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode,org.apache.datasketches.tuple.aninteger.IntegerSummary.Mode)"> |
| <h3>IntegerSummarySetOperations</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">IntegerSummarySetOperations</span><wbr><span class="parameters">(<a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> unionSummaryMode, |
| <a href="IntegerSummary.Mode.html" title="enum class in org.apache.datasketches.tuple.aninteger">IntegerSummary.Mode</a> intersectionSummaryMode)</span></div> |
| <div class="block">Creates a new instance with two modes</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>unionSummaryMode</code> - for unions</dd> |
| <dd><code>intersectionSummaryMode</code> - for intersections</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="union(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)"> |
| <h3>union</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">union</span><wbr><span class="parameters">(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, |
| <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#union(S,S)">SummarySetOperations</a></code></span></div> |
| <div class="block">This is called by the union operator when both sketches have the same hash value. |
| |
| <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, |
| unless they are immutable (most Summary objects are not). For mutable Summary objects, it is |
| important to create a new Summary object with the correct contents to be returned. Do not |
| return null summaries.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SummarySetOperations.html#union(S,S)">union</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>a</code> - Summary from sketch A</dd> |
| <dd><code>b</code> - Summary from sketch B</dd> |
| <dt>Returns:</dt> |
| <dd>union of Summary A and Summary B</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="intersection(org.apache.datasketches.tuple.aninteger.IntegerSummary,org.apache.datasketches.tuple.aninteger.IntegerSummary)"> |
| <h3>intersection</h3> |
| <div class="horizontal-scroll"> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a></span> <span class="element-name">intersection</span><wbr><span class="parameters">(<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> a, |
| <a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a> b)</span></div> |
| <div class="block"><span class="description-from-type-label">Description copied from interface: <code><a href="../SummarySetOperations.html#intersection(S,S)">SummarySetOperations</a></code></span></div> |
| <div class="block">This is called by the intersection operator when both sketches have the same hash value. |
| |
| <p><b>Caution:</b> Do not modify the input Summary objects. Also do not return them directly, |
| unless they are immutable (most Summary objects are not). For mutable Summary objects, it is |
| important to create a new Summary object with the correct contents to be returned. Do not |
| return null summaries.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../SummarySetOperations.html#intersection(S,S)">intersection</a></code> in interface <code><a href="../SummarySetOperations.html" title="interface in org.apache.datasketches.tuple">SummarySetOperations</a><<a href="IntegerSummary.html" title="class in org.apache.datasketches.tuple.aninteger">IntegerSummary</a>></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>a</code> - Summary from sketch A</dd> |
| <dd><code>b</code> - Summary from sketch B</dd> |
| <dt>Returns:</dt> |
| <dd>intersection of Summary A and Summary B</dd> |
| </dl> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2015–2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </main> |
| </div> |
| </body> |
| </html> |
