| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>PartiallyOrderedSet (Apache Calcite 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.calcite.util, class: PartiallyOrderedSet"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/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="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.util</a></div> |
| <h1 title="Class PartiallyOrderedSet" class="title">Class PartiallyOrderedSet<E></h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/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"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">java.util.AbstractCollection</a><E> |
| <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractSet.html" title="class or interface in java.util" class="external-link">java.util.AbstractSet</a><E> |
| <div class="inheritance">org.apache.calcite.util.PartiallyOrderedSet<E></div> |
| </div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>E</code> - Element type</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><E></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><E></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><E></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">PartiallyOrderedSet<E></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractSet.html" title="class or interface in java.util" class="external-link">AbstractSet</a><E></span></div> |
| <div class="block">Partially-ordered set. |
| |
| <p>When you create a partially-ordered set ('poset' for short) you must |
| provide an <a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util"><code>PartiallyOrderedSet.Ordering</code></a> that determines the order relation. The |
| ordering must be:</p> |
| |
| <ul> |
| <li>reflexive: e.lte(e) returns true;</li> |
| <li>anti-symmetric: if e.lte(f) returns true, |
| then f.lte(e) returns false only if e = f;</li> |
| <li>transitive: if e.lte(f) returns true and |
| f.lte(g) returns true, then e.lte(g) must return true.</li> |
| </ul> |
| |
| <p>Note that not all pairs of elements are related. It is OK if e.lte(f) |
| returns false and f.lte(e) returns false also.</p> |
| |
| <p>In addition to the usual set methods, there are methods to determine the |
| immediate parents and children of an element in the set, and method to find |
| all elements which have no parents or no children (i.e. "root" and "leaf" |
| elements).</p> |
| |
| <p>A lattice is a special kind of poset where there is a unique top and |
| bottom element. You can use a PartiallyOrderedSet for a lattice also. It may |
| be helpful to add the top and bottom elements to the poset on |
| construction.</p></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="PartiallyOrderedSet.Ordering.html" class="type-name-link" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.Ordering.html" title="type parameter in PartiallyOrderedSet.Ordering">E</a>></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Ordering relation.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#BIT_SET_INCLUSION_ORDERING" class="member-name-link">BIT_SET_INCLUSION_ORDERING</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Ordering that orders bit sets by inclusion.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== 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.calcite.util.PartiallyOrderedSet.Ordering)" class="member-name-link">PartiallyOrderedSet</a><wbr>(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a partially-ordered set.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.util.PartiallyOrderedSet.Ordering,com.google.common.base.Function,com.google.common.base.Function)" class="member-name-link">PartiallyOrderedSet</a><wbr>(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering, |
| com.google.common.base.Function<<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> childFunction, |
| com.google.common.base.Function<<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> parentFunction)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.util.PartiallyOrderedSet.Ordering,java.util.Collection)" class="member-name-link">PartiallyOrderedSet</a><wbr>(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> collection)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Creates a partially-ordered set, and populates it with a given |
| collection.</div> |
| </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.calcite.util.PartiallyOrderedSet.Ordering,java.util.function.Function,java.util.function.Function)" class="member-name-link">PartiallyOrderedSet</a><wbr>(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> childFunction, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> parentFunction)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Creates a partially-ordered set with a parent-generating function.</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(E)" class="member-name-link">add</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Adds an element to this lattice.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#contains(java.lang.Object)" class="member-name-link">contains</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAncestors(E)" class="member-name-link">getAncestors</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a list of values in the set that are less-than a given value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChildren(E)" class="member-name-link">getChildren</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the values in this partially-ordered set that are less-than |
| a given value and there are no intervening values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getChildren(E,boolean)" class="member-name-link">getChildren</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e, |
| boolean hypothetical)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the values in this partially-ordered set that are less-than |
| a given value and there are no intervening values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescendants(E)" class="member-name-link">getDescendants</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a list of values in the set that are less-than a given value.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNonChildren()" class="member-name-link">getNonChildren</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNonParents()" class="member-name-link">getNonParents</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParents(E)" class="member-name-link">getParents</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the values in this partially-ordered set that are greater-than |
| a given value and there are no intervening values.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getParents(E,boolean)" class="member-name-link">getParents</a><wbr>(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e, |
| boolean hypothetical)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the values in this partially-ordered set that are greater-than |
| a given value and there are no intervening values.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isValid(boolean)" class="member-name-link">isValid</a><wbr>(boolean fail)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks internal consistency of this lattice.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#out(java.lang.StringBuilder)" class="member-name-link">out</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#remove(java.lang.Object)" class="member-name-link">remove</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#size()" class="member-name-link">size</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <E> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><E></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#strip(java.util.List)" class="member-name-link">strip</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.calcite.util.PartiallyOrderedSet.Node<E>> list)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns a list, backed by a list of |
| <code>PartiallyOrderedSet.Node</code>s, that strips |
| away the node and returns the element inside.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.util.AbstractSet">Methods inherited from class java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractSet.html" title="class or interface in java.util" class="external-link">AbstractSet</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractSet.html#equals(java.lang.Object)" title="class or interface in java.util" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractSet.html#hashCode()" title="class or interface in java.util" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractSet.html#removeAll(java.util.Collection)" title="class or interface in java.util" class="external-link">removeAll</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.util.AbstractCollection">Methods inherited from class java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#addAll(java.util.Collection)" title="class or interface in java.util" class="external-link">addAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#containsAll(java.util.Collection)" title="class or interface in java.util" class="external-link">containsAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#isEmpty()" title="class or interface in java.util" class="external-link">isEmpty</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#retainAll(java.util.Collection)" title="class or interface in java.util" class="external-link">retainAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#toArray()" title="class or interface in java.util" class="external-link">toArray</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#toArray(T%5B%5D)" title="class or interface in java.util" class="external-link">toArray</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#toString()" title="class or interface in java.util" class="external-link">toString</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/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/17/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/17/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/17/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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.util.Collection">Methods inherited from interface java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#parallelStream()" title="class or interface in java.util" class="external-link">parallelStream</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#removeIf(java.util.function.Predicate)" title="class or interface in java.util" class="external-link">removeIf</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#stream()" title="class or interface in java.util" class="external-link">stream</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#toArray(java.util.function.IntFunction)" title="class or interface in java.util" class="external-link">toArray</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.util.Set">Methods inherited from interface java.util.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#addAll(java.util.Collection)" title="class or interface in java.util" class="external-link">addAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#containsAll(java.util.Collection)" title="class or interface in java.util" class="external-link">containsAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#isEmpty()" title="class or interface in java.util" class="external-link">isEmpty</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#retainAll(java.util.Collection)" title="class or interface in java.util" class="external-link">retainAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#spliterator()" title="class or interface in java.util" class="external-link">spliterator</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#toArray()" title="class or interface in java.util" class="external-link">toArray</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#toArray(T%5B%5D)" title="class or interface in java.util" class="external-link">toArray</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="BIT_SET_INCLUSION_ORDERING"> |
| <h3>BIT_SET_INCLUSION_ORDERING</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type"><a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="element-name">BIT_SET_INCLUSION_ORDERING</span></div> |
| <div class="block">Ordering that orders bit sets by inclusion. |
| |
| <p>For example, the children of 14 (1110) are 12 (1100), 10 (1010) and |
| 6 (0110).</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= 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.calcite.util.PartiallyOrderedSet.Ordering)"> |
| <h3>PartiallyOrderedSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PartiallyOrderedSet</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering)</span></div> |
| <div class="block">Creates a partially-ordered set.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ordering</code> - Ordering relation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.util.PartiallyOrderedSet.Ordering,java.util.function.Function,java.util.function.Function)"> |
| <h3>PartiallyOrderedSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PartiallyOrderedSet</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> childFunction, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/function/Function.html" title="class or interface in java.util.function" class="external-link">Function</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> parentFunction)</span></div> |
| <div class="block">Creates a partially-ordered set with a parent-generating function.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ordering</code> - Ordering relation</dd> |
| <dd><code>parentFunction</code> - Function to compute parents of a node; may be null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.util.PartiallyOrderedSet.Ordering,com.google.common.base.Function,com.google.common.base.Function)"> |
| <h3>PartiallyOrderedSet</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public</span> <span class="element-name">PartiallyOrderedSet</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering, |
| com.google.common.base.Function<<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> childFunction, |
| com.google.common.base.Function<<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>>> parentFunction)</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.calcite.util.PartiallyOrderedSet.Ordering,java.util.Collection)"> |
| <h3>PartiallyOrderedSet</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">PartiallyOrderedSet</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.Ordering.html" title="interface in org.apache.calcite.util">PartiallyOrderedSet.Ordering</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> ordering, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>> collection)</span></div> |
| <div class="block">Creates a partially-ordered set, and populates it with a given |
| collection.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>ordering</code> - Ordering relation</dd> |
| <dd><code>collection</code> - Initial contents of partially-ordered set</dd> |
| </dl> |
| </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="iterator()"> |
| <h3>iterator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">iterator</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#iterator()" title="class or interface in java.util" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#iterator()" title="class or interface in java.util" class="external-link">iterator</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#iterator()" title="class or interface in java.util" class="external-link">iterator</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="size()"> |
| <h3>size</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">size</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#size()" title="class or interface in java.util" class="external-link">size</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#size()" title="class or interface in java.util" class="external-link">size</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#size()" title="class or interface in java.util" class="external-link">size</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="contains(java.lang.Object)"> |
| <h3>contains</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">contains</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#contains(java.lang.Object)" title="class or interface in java.util" class="external-link">contains</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#contains(java.lang.Object)" title="class or interface in java.util" class="external-link">contains</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#contains(java.lang.Object)" title="class or interface in java.util" class="external-link">contains</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remove(java.lang.Object)"> |
| <h3>remove</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">remove</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> o)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link">remove</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link">remove</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#remove(java.lang.Object)" title="class or interface in java.util" class="external-link">remove</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="add(E)"> |
| <h3 id="add(java.lang.Object)">add</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">add</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</span></div> |
| <div class="block">Adds an element to this lattice.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#add(E)" title="class or interface in java.util" class="external-link">add</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#add(E)" title="class or interface in java.util" class="external-link">add</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#add(E)" title="class or interface in java.util" class="external-link">add</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isValid(boolean)"> |
| <h3>isValid</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isValid</span><wbr><span class="parameters">(boolean fail)</span></div> |
| <div class="block">Checks internal consistency of this lattice.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fail</code> - Whether to throw an assertion error</dd> |
| <dt>Returns:</dt> |
| <dd>Whether valid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="out(java.lang.StringBuilder)"> |
| <h3>out</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">out</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> buf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getChildren(E)"> |
| <h3 id="getChildren(java.lang.Object)">getChildren</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getChildren</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</span></div> |
| <div class="block">Returns the values in this partially-ordered set that are less-than |
| a given value and there are no intervening values. |
| |
| <p>If the value is not in this set, returns null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Value</dd> |
| <dt>Returns:</dt> |
| <dd>List of values in this set that are directly less than the given |
| value</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getDescendants(E)"><code>getDescendants(E)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getChildren(E,boolean)"> |
| <h3 id="getChildren(java.lang.Object,boolean)">getChildren</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getChildren</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e, |
| boolean hypothetical)</span></div> |
| <div class="block">Returns the values in this partially-ordered set that are less-than |
| a given value and there are no intervening values. |
| |
| <p>If the value is not in this set, returns null if <code>hypothetical</code> |
| is false.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Value</dd> |
| <dd><code>hypothetical</code> - Whether to generate a list if value is not in the set</dd> |
| <dt>Returns:</dt> |
| <dd>List of values in this set that are directly less than the given |
| value</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getDescendants(E)"><code>getDescendants(E)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParents(E)"> |
| <h3 id="getParents(java.lang.Object)">getParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getParents</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</span></div> |
| <div class="block">Returns the values in this partially-ordered set that are greater-than |
| a given value and there are no intervening values. |
| |
| <p>If the value is not in this set, returns null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Value</dd> |
| <dt>Returns:</dt> |
| <dd>List of values in this set that are directly greater than the |
| given value</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getAncestors(E)"><code>getAncestors(E)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParents(E,boolean)"> |
| <h3 id="getParents(java.lang.Object,boolean)">getParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getParents</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e, |
| boolean hypothetical)</span></div> |
| <div class="block">Returns the values in this partially-ordered set that are greater-than |
| a given value and there are no intervening values. |
| |
| <p>If the value is not in this set, returns <code>null</code> if |
| <code>hypothetical</code> is false.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Value</dd> |
| <dd><code>hypothetical</code> - Whether to generate a list if value is not in the set</dd> |
| <dt>Returns:</dt> |
| <dd>List of values in this set that are directly greater than the |
| given value</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getAncestors(E)"><code>getAncestors(E)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNonChildren()"> |
| <h3>getNonChildren</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getNonChildren</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNonParents()"> |
| <h3>getNonParents</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getNonParents</span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clear()"> |
| <h3>clear</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">clear</span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html#clear()" title="class or interface in java.util" class="external-link">clear</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Collection.html" title="class or interface in java.util" class="external-link">Collection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html#clear()" title="class or interface in java.util" class="external-link">clear</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html#clear()" title="class or interface in java.util" class="external-link">clear</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/AbstractCollection.html" title="class or interface in java.util" class="external-link">AbstractCollection</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDescendants(E)"> |
| <h3 id="getDescendants(java.lang.Object)">getDescendants</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getDescendants</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</span></div> |
| <div class="block">Returns a list of values in the set that are less-than a given value. |
| The list is in topological order but order is otherwise |
| non-deterministic.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Value</dd> |
| <dt>Returns:</dt> |
| <dd>Values less than given value</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="strip(java.util.List)"> |
| <h3>strip</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><E></span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><E></span> <span class="element-name">strip</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><org.apache.calcite.util.PartiallyOrderedSet.Node<E>> list)</span></div> |
| <div class="block">Returns a list, backed by a list of |
| <code>PartiallyOrderedSet.Node</code>s, that strips |
| away the node and returns the element inside.</div> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>E</code> - Element type</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAncestors(E)"> |
| <h3 id="getAncestors(java.lang.Object)">getAncestors</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a>></span> <span class="element-name">getAncestors</span><wbr><span class="parameters">(<a href="PartiallyOrderedSet.html" title="type parameter in PartiallyOrderedSet">E</a> e)</span></div> |
| <div class="block">Returns a list of values in the set that are less-than a given value. |
| The list is in topological order but order is otherwise |
| non-deterministic.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - Value</dd> |
| <dt>Returns:</dt> |
| <dd>Values less than given value</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
