| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ImmutableBitSet (Apache Calcite calcite API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.util, class: ImmutableBitSet"> |
| <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.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":9,"i1":10,"i2":10,"i3":9,"i4":41,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":9,"i27":9,"i28":9,"i29":9,"i30":9,"i31":10,"i32":10,"i33":10,"i34":9,"i35":9,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":9,"i45":10,"i46":10,"i47":10,"i48":9,"i49":10,"i50":10,"i51":9,"i52":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= 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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.apache.calcite.util</a></div> |
| <h1 title="Class ImmutableBitSet" class="title">Class ImmutableBitSet</h1> |
| </div> |
| <div class="contentContainer"> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.util.ImmutableBitSet</div> |
| </div> |
| <section class="description"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code>, <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">ImmutableBitSet</span> |
| extends <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> |
| implements <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>>, <a href="https://docs.oracle.com/javase/9/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io" class="externalLink">Serializable</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></pre> |
| <div class="block">An immutable list of bits.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.calcite.util.ImmutableBitSet">Serialized Form</a></dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li class="blockList"> |
| <section class="nestedClassSummary"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h2>Nested Class Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Builder.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="fieldSummary"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h2>Field Summary</h2> |
| <div class="memberSummary"> |
| <table> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#COMPARATOR">COMPARATOR</a></span></code></th> |
| <td class="colLast"> |
| <div class="block">Compares bit sets topologically, so that enclosing bit sets come first, |
| using natural ordering to break ties.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static com.google.common.base.Function<? super <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FROM_BIT_SET">FROM_BIT_SET</a></span></code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static com.google.common.collect.Ordering<<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ORDERING">ORDERING</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t1" class="tableTab" onclick="show(1);">Static Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t6" class="tableTab" onclick="show(32);">Deprecated Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#allContain(java.util.Collection,int)">allContain</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> bitSets, |
| int bit)</code></th> |
| <td class="colLast"> |
| <div class="block">Checks if all bit sets contain a particular bit.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asList()">asList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a view onto this bit set as a list of integers.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#asSet()">asSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a view onto this bit set as a set of integers.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#builder()">builder</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an empty Builder.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#builder(org.apache.calcite.util.ImmutableBitSet)">builder</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> bitSet)</code></th> |
| <td class="colLast"> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cardinality()">cardinality</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of bits set to <code>true</code> in this |
| <code>ImmutableBitSet</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i6"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear(int)">clear</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set the same as this but with a given bit cleared.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i7"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clearIf(int,boolean)">clearIf</a></span>​(int i, |
| boolean condition)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set the same as this but with a given bit cleared if |
| condition is true.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i8"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedMap</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#closure(java.util.SortedMap)">closure</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedMap</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> equivalence)</code></th> |
| <td class="colLast"> |
| <div class="block">Computes the closure of a map from integers to bits.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i9"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compareTo(org.apache.calcite.util.ImmutableBitSet)">compareTo</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> o)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this ImmutableBitSet with another, using a lexicographic |
| ordering.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i10"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#contains(org.apache.calcite.util.ImmutableBitSet)">contains</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> set1)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if all bits set in the second parameter are also set in the |
| first.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i11"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equals(java.lang.Object)">equals</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</code></th> |
| <td class="colLast"> |
| <div class="block">Compares this object against the specified object.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i12"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#except(org.apache.calcite.util.ImmutableBitSet)">except</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> that)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set with all the bits in this set that are not in |
| another.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i13"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fromBitSet(java.util.BitSet)">fromBitSet</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a> input)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new immutable bit set containing all the bits in the given |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>BitSet</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i14"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(int)">get</a></span>​(int bitIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the value of the bit with the specified index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i15"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#get(int,int)">get</a></span>​(int fromIndex, |
| int toIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new <code>ImmutableBitSet</code> |
| composed of bits from this <code>ImmutableBitSet</code> |
| from <code>fromIndex</code> (inclusive) to <code>toIndex</code> (exclusive).</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i16"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#hashCode()">hashCode</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the hash code value for this bit set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i17"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#indexOf(int)">indexOf</a></span>​(int bit)</code></th> |
| <td class="colLast"> |
| <div class="block">The ordinal of a given bit, or -1 if it is not set.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i18"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intersect(org.apache.calcite.util.ImmutableBitSet)">intersect</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> that)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set with all the bits set in both this set and in |
| another.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i19"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#intersects(org.apache.calcite.util.ImmutableBitSet)">intersects</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> set)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if the specified <code>ImmutableBitSet</code> has any bits set to |
| <code>true</code> that are also set to <code>true</code> in this |
| <code>ImmutableBitSet</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i20"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isEmpty()">isEmpty</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns true if this <code>ImmutableBitSet</code> contains no bits that are set |
| to <code>true</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i21"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#iterator()">iterator</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i22"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#length()">length</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the "logical size" of this <code>ImmutableBitSet</code>: the index of |
| the highest set bit in the <code>ImmutableBitSet</code> plus one.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i23"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextClearBit(int)">nextClearBit</a></span>​(int fromIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the index of the first bit that is set to <code>false</code> |
| that occurs on or after the specified starting index.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i24"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nextSetBit(int)">nextSetBit</a></span>​(int fromIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the index of the first bit that is set to <code>true</code> |
| that occurs on or after the specified starting index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i25"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#nth(int)">nth</a></span>​(int n)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the <code>n</code>th set bit.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i26"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of()">of</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an ImmutableBitSet with no bits.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i27"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(int...)">of</a></span>​(int... bits)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor" id="i28"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(java.lang.Iterable)">of</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> bits)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i29"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#of(org.apache.calcite.util.ImmutableIntList)">of</a></span>​(<a href="ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> bits)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an ImmutableBitSet with given bits set.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i30"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#permute(java.lang.Iterable,java.util.Map)">permute</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> bitSets, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> map)</code></th> |
| <td class="colLast"> |
| <div class="block">Permutes a collection of bit sets according to a given mapping.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i31"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#permute(java.util.Map)">permute</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> map)</code></th> |
| <td class="colLast"> |
| <div class="block">Permutes a bit set according to a given mapping.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i32"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#powerSet()">powerSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Computes the power set (set of all sets) of this bit set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i33"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#previousClearBit(int)">previousClearBit</a></span>​(int fromIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the index of the nearest bit that is set to <code>false</code> |
| that occurs on or before the specified starting index.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i34"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#range(int)">range</a></span>​(int toIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an ImmutableBitSet with bits between 0 and <code>toIndex</code> set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i35"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#range(int,int)">range</a></span>​(int fromIndex, |
| int toIndex)</code></th> |
| <td class="colLast"> |
| <div class="block">Creates an ImmutableBitSet with bits from <code>fromIndex</code> (inclusive) to |
| specified <code>toIndex</code> (exclusive) set to <code>true</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i36"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rebuild()">rebuild</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Builder whose initial contents are the same as this |
| ImmutableBitSet.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i37"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(int)">set</a></span>​(int i)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set the same as this but with a given bit set.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i38"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#set(int,boolean)">set</a></span>​(int i, |
| boolean b)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set the same as this but with a given bit set (if b is |
| true) or unset (if b is false).</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i39"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setIf(int,boolean)">setIf</a></span>​(int bit, |
| boolean condition)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set the same as this but with a given bit set if condition |
| is true.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i40"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#shift(int)">shift</a></span>​(int offset)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a bit set with every bit moved up <code>offset</code> positions.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i41"> |
| <td class="colFirst"><code>int</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#size()">size</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the number of bits of space actually in use by this |
| <code>ImmutableBitSet</code> to represent bit values.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i42"> |
| <td class="colFirst"><code>int[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toArray()">toArray</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this bit set to an array.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i43"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toBitSet()">toBitSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>BitSet</code></a> that has the same contents as this |
| <code>ImmutableBitSet</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i44"> |
| <td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/9/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toImmutableBitSet()">toImmutableBitSet</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Creates a Collector.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i45"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toList()">toList</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this bit set to a list.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i46"> |
| <td class="colFirst"><code>long[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toLongArray()">toLongArray</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Converts this bit set to an array of little-endian words.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i47"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a string representation of this bit set.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i48"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#union(java.lang.Iterable)">union</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><? extends <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> sets)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the union of a number of bit sets.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i49"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#union(java.util.BitSet)">union</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a> other)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the union of this immutable bit set with a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>BitSet</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i50"> |
| <td class="colFirst"><code><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#union(org.apache.calcite.util.ImmutableBitSet)">union</a></span>​(<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> other)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the union of this bit set with another.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i51"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(long...)">valueOf</a></span>​(long... longs)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new immutable bit set containing all the bits in the given long |
| array.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i52"> |
| <td class="colFirst"><code>static <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#valueOf(java.nio.LongBuffer)">valueOf</a></span>​(<a href="https://docs.oracle.com/javase/9/docs/api/java/nio/LongBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">LongBuffer</a> longs)</code></th> |
| <td class="colLast"> |
| <div class="block">Returns a new immutable bit set containing all the bits in the given long |
| buffer.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface java.lang.<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a></h3> |
| <a id="methods.inherited.from.class.java.lang.Iterable"> |
| <!-- --> |
| </a><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="externalLink">forEach</a>, <a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true#spliterator()" title="class or interface in java.lang" class="externalLink">spliterator</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li class="blockList"> |
| <section class="fieldDetails"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h2>Field Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="COMPARATOR">COMPARATOR</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util" class="externalLink">Comparator</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">COMPARATOR</span></div> |
| <div class="block">Compares bit sets topologically, so that enclosing bit sets come first, |
| using natural ordering to break ties.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="ORDERING">ORDERING</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static final</span> <span class="returnType">com.google.common.collect.Ordering<<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">ORDERING</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="FROM_BIT_SET">FROM_BIT_SET</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static final</span> <span class="returnType">com.google.common.base.Function<? super <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">FROM_BIT_SET</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of()">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">of</span>()</div> |
| <div class="block">Creates an ImmutableBitSet with no bits.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(int...)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">of</span>​(<span class="arguments">int... bits)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(java.lang.Iterable)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">of</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> bits)</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="of(org.apache.calcite.util.ImmutableIntList)">of</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">of</span>​(<span class="arguments"><a href="ImmutableIntList.html" title="class in org.apache.calcite.util">ImmutableIntList</a> bits)</span></div> |
| <div class="block">Creates an ImmutableBitSet with given bits set. |
| |
| <p>For example, <code>of(ImmutableIntList.of(0, 3))</code> returns a bit |
| set with bits {0, 3} set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bits</code> - Collection of bits to set</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Bit set</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="valueOf(long...)">valueOf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">valueOf</span>​(<span class="arguments">long... longs)</span></div> |
| <div class="block">Returns a new immutable bit set containing all the bits in the given long |
| array. |
| |
| <p>More precisely, |
| |
| <blockquote><code>ImmutableBitSet.valueOf(longs).get(n) |
| == ((longs[n/64] & (1L<<(n%64))) != 0)</code></blockquote> |
| |
| <p>for all <code>n < 64 * longs.length</code>. |
| |
| <p>This method is equivalent to |
| <code>ImmutableBitSet.valueOf(LongBuffer.wrap(longs))</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>longs</code> - a long array containing a little-endian representation |
| of a sequence of bits to be used as the initial bits of the |
| new bit set</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a <code>ImmutableBitSet</code> containing all the bits in the long |
| array</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="valueOf(java.nio.LongBuffer)">valueOf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">valueOf</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/nio/LongBuffer.html?is-external=true" title="class or interface in java.nio" class="externalLink">LongBuffer</a> longs)</span></div> |
| <div class="block">Returns a new immutable bit set containing all the bits in the given long |
| buffer.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fromBitSet(java.util.BitSet)">fromBitSet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">fromBitSet</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a> input)</span></div> |
| <div class="block">Returns a new immutable bit set containing all the bits in the given |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>BitSet</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="range(int,int)">range</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">range</span>​(<span class="arguments">int fromIndex, |
| int toIndex)</span></div> |
| <div class="block">Creates an ImmutableBitSet with bits from <code>fromIndex</code> (inclusive) to |
| specified <code>toIndex</code> (exclusive) set to <code>true</code>. |
| |
| <p>For example, <code>range(0, 3)</code> returns a bit set with bits |
| {0, 1, 2} set.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromIndex</code> - Index of the first bit to be set.</dd> |
| <dd><code>toIndex</code> - Index after the last bit to be set.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Bit set</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="range(int)">range</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">range</span>​(<span class="arguments">int toIndex)</span></div> |
| <div class="block">Creates an ImmutableBitSet with bits between 0 and <code>toIndex</code> set.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toImmutableBitSet()">toImmutableBitSet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/stream/Collector.html?is-external=true" title="class or interface in java.util.stream" class="externalLink">Collector</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">toImmutableBitSet</span>()</div> |
| <div class="block">Creates a Collector.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="powerSet()">powerSet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">powerSet</span>()</div> |
| <div class="block">Computes the power set (set of all sets) of this bit set.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="get(int)">get</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">get</span>​(<span class="arguments">int bitIndex)</span></div> |
| <div class="block">Returns the value of the bit with the specified index. The value |
| is <code>true</code> if the bit with the index <code>bitIndex</code> |
| is currently set in this <code>ImmutableBitSet</code>; otherwise, the result |
| is <code>false</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>bitIndex</code> - the bit index</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the value of the bit with the specified index</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the specified index is negative</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="get(int,int)">get</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">get</span>​(<span class="arguments">int fromIndex, |
| int toIndex)</span></div> |
| <div class="block">Returns a new <code>ImmutableBitSet</code> |
| composed of bits from this <code>ImmutableBitSet</code> |
| from <code>fromIndex</code> (inclusive) to <code>toIndex</code> (exclusive).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromIndex</code> - index of the first bit to include</dd> |
| <dd><code>toIndex</code> - index after the last bit to include</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>ImmutableBitSet</code> from a range of |
| this <code>ImmutableBitSet</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if <code>fromIndex</code> is negative, |
| or <code>toIndex</code> is negative, or <code>fromIndex</code> is |
| larger than <code>toIndex</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toString()">toString</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span> <span class="memberName">toString</span>()</div> |
| <div class="block">Returns a string representation of this bit set. For every index |
| for which this <code>BitSet</code> contains a bit in the set |
| state, the decimal representation of that index is included in |
| the result. Such indices are listed in order from lowest to |
| highest, separated by ", " (a comma and a space) and |
| surrounded by braces, resulting in the usual mathematical |
| notation for a set of integers. |
| |
| <p>Example: |
| <pre> |
| BitSet drPepper = new BitSet();</pre> |
| Now <code>drPepper.toString()</code> returns "<code>{}</code>". |
| <pre> |
| drPepper.set(2);</pre> |
| Now <code>drPepper.toString()</code> returns "<code>{2}</code>". |
| <pre> |
| drPepper.set(4); |
| drPepper.set(10);</pre> |
| Now <code>drPepper.toString()</code> returns "<code>{2, 4, 10}</code>".</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string representation of this bit set</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="intersects(org.apache.calcite.util.ImmutableBitSet)">intersects</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">intersects</span>​(<span class="arguments"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> set)</span></div> |
| <div class="block">Returns true if the specified <code>ImmutableBitSet</code> has any bits set to |
| <code>true</code> that are also set to <code>true</code> in this |
| <code>ImmutableBitSet</code>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>set</code> - <code>ImmutableBitSet</code> to intersect with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>boolean indicating whether this <code>ImmutableBitSet</code> intersects |
| the specified <code>ImmutableBitSet</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cardinality()">cardinality</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">cardinality</span>()</div> |
| <div class="block">Returns the number of bits set to <code>true</code> in this |
| <code>ImmutableBitSet</code>.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#size()"><code>size()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="hashCode()">hashCode</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">hashCode</span>()</div> |
| <div class="block">Returns the hash code value for this bit set. The hash code |
| depends only on which bits are set within this <code>ImmutableBitSet</code>. |
| |
| <p>The hash code is defined using the same calculation as |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true#hashCode()" title="class or interface in java.util" class="externalLink"><code>BitSet.hashCode()</code></a>.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the hash code value for this bit set</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="size()">size</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">size</span>()</div> |
| <div class="block">Returns the number of bits of space actually in use by this |
| <code>ImmutableBitSet</code> to represent bit values. |
| The maximum element in the set is the size - 1st element.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the number of bits currently in this bit set</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#cardinality()"><code>cardinality()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="equals(java.lang.Object)">equals</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">equals</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a> obj)</span></div> |
| <div class="block">Compares this object against the specified object. |
| The result is <code>true</code> if and only if the argument is |
| not <code>null</code> and is a <code>ImmutableBitSet</code> object that has |
| exactly the same set of bits set to <code>true</code> as this bit |
| set.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - the object to compare with</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if the objects are the same; |
| <code>false</code> otherwise</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="#size()"><code>size()</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="compareTo(org.apache.calcite.util.ImmutableBitSet)">compareTo</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">compareTo</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/javax/annotation/Nonnull.html?is-external=true" title="class or interface in javax.annotation" class="externalLink">@Nonnull</a> |
| <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> o)</span></div> |
| <div class="block">Compares this ImmutableBitSet with another, using a lexicographic |
| ordering. |
| |
| <p>Bit sets <code>(), (0), (0, 1), (0, 1, 3), (1), (2, 3)</code> are in sorted |
| order.</p></div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang" class="externalLink">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Comparable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="nextSetBit(int)">nextSetBit</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">nextSetBit</span>​(<span class="arguments">int fromIndex)</span></div> |
| <div class="block">Returns the index of the first bit that is set to <code>true</code> |
| that occurs on or after the specified starting index. If no such |
| bit exists then <code>-1</code> is returned. |
| |
| <p>Based upon <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true#nextSetBit(int)" title="class or interface in java.util" class="externalLink"><code>BitSet.nextSetBit(int)</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromIndex</code> - the index to start checking from (inclusive)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index of the next set bit, or <code>-1</code> if there |
| is no such bit</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the specified index is negative</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="nextClearBit(int)">nextClearBit</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">nextClearBit</span>​(<span class="arguments">int fromIndex)</span></div> |
| <div class="block">Returns the index of the first bit that is set to <code>false</code> |
| that occurs on or after the specified starting index.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromIndex</code> - the index to start checking from (inclusive)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index of the next clear bit</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the specified index is negative</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="previousClearBit(int)">previousClearBit</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">previousClearBit</span>​(<span class="arguments">int fromIndex)</span></div> |
| <div class="block">Returns the index of the nearest bit that is set to <code>false</code> |
| that occurs on or before the specified starting index. |
| If no such bit exists, or if <code>-1</code> is given as the |
| starting index, then <code>-1</code> is returned.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fromIndex</code> - the index to start checking from (inclusive)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the index of the previous clear bit, or <code>-1</code> if there |
| is no such bit</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if the specified index is less |
| than <code>-1</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="iterator()">iterator</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util" class="externalLink">Iterator</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></span> <span class="memberName">iterator</span>()</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang" class="externalLink">iterator</a></code> in interface <code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toList()">toList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></span> <span class="memberName">toList</span>()</div> |
| <div class="block">Converts this bit set to a list.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asList()">asList</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></span> <span class="memberName">asList</span>()</div> |
| <div class="block">Creates a view onto this bit set as a list of integers. |
| |
| <p>The <code>cardinality</code> and <code>get</code> methods are both O(n), but |
| the iterator is efficient. The list is memory efficient, and the CPU cost |
| breaks even (versus <a href="#toList()"><code>toList()</code></a>) if you intend to scan it only once.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="asSet()">asSet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>></span> <span class="memberName">asSet</span>()</div> |
| <div class="block">Creates a view onto this bit set as a set of integers. |
| |
| <p>The <code>size</code> and <code>contains</code> methods are both O(n), but the |
| iterator is efficient.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toArray()">toArray</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int[]</span> <span class="memberName">toArray</span>()</div> |
| <div class="block">Converts this bit set to an array. |
| |
| <p>Each entry of the array is the ordinal of a set bit. The array is |
| sorted.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Array of set bits</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toLongArray()">toLongArray</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">long[]</span> <span class="memberName">toLongArray</span>()</div> |
| <div class="block">Converts this bit set to an array of little-endian words.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="union(java.util.BitSet)">union</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">union</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a> other)</span></div> |
| <div class="block">Returns the union of this immutable bit set with a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>BitSet</code></a>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="union(org.apache.calcite.util.ImmutableBitSet)">union</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">union</span>​(<span class="arguments"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> other)</span></div> |
| <div class="block">Returns the union of this bit set with another.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="union(java.lang.Iterable)">union</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">union</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><? extends <a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> sets)</span></div> |
| <div class="block">Returns the union of a number of bit sets.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="except(org.apache.calcite.util.ImmutableBitSet)">except</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">except</span>​(<span class="arguments"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> that)</span></div> |
| <div class="block">Returns a bit set with all the bits in this set that are not in |
| another.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true#andNot(java.util.BitSet)" title="class or interface in java.util" class="externalLink"><code>BitSet.andNot(java.util.BitSet)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="intersect(org.apache.calcite.util.ImmutableBitSet)">intersect</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">intersect</span>​(<span class="arguments"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> that)</span></div> |
| <div class="block">Returns a bit set with all the bits set in both this set and in |
| another.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true#and(java.util.BitSet)" title="class or interface in java.util" class="externalLink"><code>BitSet.and(java.util.BitSet)</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="contains(org.apache.calcite.util.ImmutableBitSet)">contains</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">contains</span>​(<span class="arguments"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> set1)</span></div> |
| <div class="block">Returns true if all bits set in the second parameter are also set in the |
| first. In other words, whether x is a super-set of y.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>set1</code> - Bitmap to be checked</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Whether all bits in set1 are set in set0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="indexOf(int)">indexOf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">indexOf</span>​(<span class="arguments">int bit)</span></div> |
| <div class="block">The ordinal of a given bit, or -1 if it is not set.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="closure(java.util.SortedMap)">closure</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedMap</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">closure</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedMap</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> equivalence)</span></div> |
| <div class="block">Computes the closure of a map from integers to bits. |
| |
| <p>The input must have an entry for each position. |
| |
| <p>Does not modify the input map or its bit sets.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="length()">length</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">length</span>()</div> |
| <div class="block">Returns the "logical size" of this <code>ImmutableBitSet</code>: the index of |
| the highest set bit in the <code>ImmutableBitSet</code> plus one. Returns zero |
| if the <code>ImmutableBitSet</code> contains no set bits.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the logical size of this <code>ImmutableBitSet</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="isEmpty()">isEmpty</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">isEmpty</span>()</div> |
| <div class="block">Returns true if this <code>ImmutableBitSet</code> contains no bits that are set |
| to <code>true</code>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="builder()">builder</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></span> <span class="memberName">builder</span>()</div> |
| <div class="block">Creates an empty Builder.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="builder(org.apache.calcite.util.ImmutableBitSet)">builder</a></h3> |
| <div class="memberSignature"><span class="annotations"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a> |
| </span><span class="modifiers">public static</span> <span class="returnType"><a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></span> <span class="memberName">builder</span>​(<span class="arguments"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a> bitSet)</span></div> |
| <div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="rebuild()">rebuild</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.Builder.html" title="class in org.apache.calcite.util">ImmutableBitSet.Builder</a></span> <span class="memberName">rebuild</span>()</div> |
| <div class="block">Creates a Builder whose initial contents are the same as this |
| ImmutableBitSet.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="nth(int)">nth</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">nth</span>​(<span class="arguments">int n)</span></div> |
| <div class="block">Returns the <code>n</code>th set bit.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/IndexOutOfBoundsException.html?is-external=true" title="class or interface in java.lang" class="externalLink">IndexOutOfBoundsException</a></code> - if n is less than 0 or greater |
| than the number of bits set</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="set(int)">set</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">set</span>​(<span class="arguments">int i)</span></div> |
| <div class="block">Returns a bit set the same as this but with a given bit set.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="set(int,boolean)">set</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">set</span>​(<span class="arguments">int i, |
| boolean b)</span></div> |
| <div class="block">Returns a bit set the same as this but with a given bit set (if b is |
| true) or unset (if b is false).</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="setIf(int,boolean)">setIf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">setIf</span>​(<span class="arguments">int bit, |
| boolean condition)</span></div> |
| <div class="block">Returns a bit set the same as this but with a given bit set if condition |
| is true.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clear(int)">clear</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">clear</span>​(<span class="arguments">int i)</span></div> |
| <div class="block">Returns a bit set the same as this but with a given bit cleared.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="clearIf(int,boolean)">clearIf</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">clearIf</span>​(<span class="arguments">int i, |
| boolean condition)</span></div> |
| <div class="block">Returns a bit set the same as this but with a given bit cleared if |
| condition is true.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="toBitSet()">toBitSet</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink">BitSet</a></span> <span class="memberName">toBitSet</span>()</div> |
| <div class="block">Returns a <a href="https://docs.oracle.com/javase/9/docs/api/java/util/BitSet.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>BitSet</code></a> that has the same contents as this |
| <code>ImmutableBitSet</code>.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="permute(java.util.Map)">permute</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">permute</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> map)</span></div> |
| <div class="block">Permutes a bit set according to a given mapping.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="permute(java.lang.Iterable,java.util.Map)">permute</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>></span> <span class="memberName">permute</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang" class="externalLink">Iterable</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> bitSets, |
| <a href="https://docs.oracle.com/javase/9/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink">Map</a><<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>,​<a href="https://docs.oracle.com/javase/9/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang" class="externalLink">Integer</a>> map)</span></div> |
| <div class="block">Permutes a collection of bit sets according to a given mapping.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="shift(int)">shift</a></h3> |
| <div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a></span> <span class="memberName">shift</span>​(<span class="arguments">int offset)</span></div> |
| <div class="block">Returns a bit set with every bit moved up <code>offset</code> positions. |
| Offset may be negative, but throws if any bit ends up negative.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="allContain(java.util.Collection,int)">allContain</a></h3> |
| <div class="memberSignature"><span class="modifiers">public static</span> <span class="returnType">boolean</span> <span class="memberName">allContain</span>​(<span class="arguments"><a href="https://docs.oracle.com/javase/9/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util" class="externalLink">Collection</a><<a href="ImmutableBitSet.html" title="class in org.apache.calcite.util">ImmutableBitSet</a>> bitSets, |
| int bit)</span></div> |
| <div class="block">Checks if all bit sets contain a particular bit.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </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><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">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">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><b>Apache Calcite</b></div> |
| </div> |
| <div class="subNav"> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |