javadocAggregate/org/apache/calcite/util/EquivalenceSet.html - calcite-site - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc -->
 <title>EquivalenceSet (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: EquivalenceSet">
 <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":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.calcite.util</a></div>
 <h1 title="Class EquivalenceSet" class="title">Class EquivalenceSet&lt;E extends <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>&lt;E&gt;&gt;</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.EquivalenceSet&lt;E&gt;</div>
 </div>
 <section class="description">
 <dl>
 <dt><span class="paramLabel">Type Parameters:</span></dt>
 <dd><code>E</code> - Element type</dd>
 </dl>
 <hr>
 <pre>public class <span class="typeNameLabel">EquivalenceSet&lt;E extends <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>&lt;E&gt;&gt;</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></pre>
 <div class="block">Set of elements organized into equivalence classes.

  <p>Elements are equivalent by the rules of a mathematical equivalence
  relation:

  <dl>
    <dt>Reflexive
    <dd>Every element <code>e</code> is equivalent to itself
    <dt>Symmetric
    <dd>If <code>e</code> is equivalent to <code>f</code>,
      then <code>f</code> is equivalent to <code>e</code>
    <dt>Transitive
    <dd>If <code>e</code> is equivalent to <code>f</code>,
      and <code>f</code> is equivalent to <code>g</code>,
      then <code>e</code> is equivalent to <code>g</code>
  </dl>

  <p>For any given pair of elements, answers in O(log N) (two hash-table
  lookups) whether they are equivalent to each other.</div>
 </section>
 <section class="summary">
 <ul class="blockList">
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li class="blockList">
 <section class="constructorSummary"><a id="constructor.summary">
 <!--   -->
 </a>
 <h2>Constructor Summary</h2>
 <div class="memberSummary">
 <table>
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <thead>
 <tr>
 <th class="colFirst" scope="col">Constructor</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr class="altColor">
 <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">EquivalenceSet</a></span>()</code></th>
 <td class="colLast">&nbsp;</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="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></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><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(E)">add</a></span>&#8203;(<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;e)</code></th>
 <td class="colLast">
 <div class="block">Adds an element, and returns the element (which is its own parent).</div>
 </td>
 </tr>
 <tr class="rowColor" id="i1">
 <td class="colFirst"><code>boolean</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#areEquivalent(E,E)">areEquivalent</a></span>&#8203;(<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;e,
 <a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;f)</code></th>
 <td class="colLast">
 <div class="block">Returns whether two elements are in the same equivalence class.</div>
 </td>
 </tr>
 <tr class="altColor" id="i2">
 <td class="colFirst"><code>int</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#classCount()">classCount</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns the number of equivalence classes in this equivalence set.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i3">
 <td class="colFirst"><code>void</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Removes all elements in this equivalence set.</div>
 </td>
 </tr>
 <tr class="altColor" id="i4">
 <td class="colFirst"><code><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equiv(E,E)">equiv</a></span>&#8203;(<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;e,
 <a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;f)</code></th>
 <td class="colLast">
 <div class="block">Marks two elements as equivalent.</div>
 </td>
 </tr>
 <tr class="rowColor" id="i5">
 <td class="colFirst"><code><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>&lt;<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>,&#8203;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedSet</a>&lt;<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&gt;&gt;</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#map()">map</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Returns a map of the canonical element in each equivalence class to the
  set of elements in that class.</div>
 </td>
 </tr>
 <tr class="altColor" id="i6">
 <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 elements in this equivalence set.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <div class="inheritedList">
 <h3>Methods inherited from class&nbsp;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#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</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#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="blockList">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li class="blockList">
 <section class="constructorDetails"><a id="constructor.detail">
 <!--   -->
 </a>
 <h2>Constructor Details</h2>
 <ul class="blockList">
 <li class="blockList">
 <section class="detail">
 <h3><a id="&lt;init&gt;()">EquivalenceSet</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">EquivalenceSet</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="add(java.lang.Comparable)">
 <!--   -->
 </a><a id="add(E)">add</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></span>&nbsp;<span class="memberName">add</span>&#8203;(<span class="arguments"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;e)</span></div>
 <div class="block">Adds an element, and returns the element (which is its own parent).
  If already present, returns the element's parent.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="equiv(java.lang.Comparable,java.lang.Comparable)">
 <!--   -->
 </a><a id="equiv(E,E)">equiv</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></span>&nbsp;<span class="memberName">equiv</span>&#8203;(<span class="arguments"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;e,
 <a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;f)</span></div>
 <div class="block">Marks two elements as equivalent.
  They may or may not be registered, and they may or may not be equal.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="areEquivalent(java.lang.Comparable,java.lang.Comparable)">
 <!--   -->
 </a><a id="areEquivalent(E,E)">areEquivalent</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">boolean</span>&nbsp;<span class="memberName">areEquivalent</span>&#8203;(<span class="arguments"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;e,
 <a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&nbsp;f)</span></div>
 <div class="block">Returns whether two elements are in the same equivalence class.
  Returns false if either or both of the elements are not registered.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="map()">map</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<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>&lt;<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>,&#8203;<a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedSet</a>&lt;<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>&gt;&gt;</span>&nbsp;<span class="memberName">map</span>()</div>
 <div class="block">Returns a map of the canonical element in each equivalence class to the
  set of elements in that class. The keys are sorted in natural order, as
  are the elements within each key.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="clear()">clear</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">void</span>&nbsp;<span class="memberName">clear</span>()</div>
 <div class="block">Removes all elements in this equivalence set.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="size()">size</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">size</span>()</div>
 <div class="block">Returns the number of elements in this equivalence set.</div>
 </section>
 </li>
 <li class="blockList">
 <section class="detail">
 <h3><a id="classCount()">classCount</a></h3>
 <div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">classCount</span>()</div>
 <div class="block">Returns the number of equivalence classes in this equivalence set.</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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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 &copy; 2012-2020 Apache Software Foundation. All Rights Reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc -->
	<title>EquivalenceSet (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: EquivalenceSet">
	<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":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
	var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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>Nested \| </li>
	<li>Field \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </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 EquivalenceSet" class="title">Class EquivalenceSet<E extends <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><E>></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.EquivalenceSet<E></div>
	</div>
	<section class="description">
	<dl>
	<dt><span class="paramLabel">Type Parameters:</span></dt>
	<dd><code>E</code> - Element type</dd>
	</dl>
	<hr>
	<pre>public class <span class="typeNameLabel">EquivalenceSet<E extends <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><E>></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></pre>
	<div class="block">Set of elements organized into equivalence classes.

	<p>Elements are equivalent by the rules of a mathematical equivalence
	relation:

	<dl>
	<dt>Reflexive
	<dd>Every element <code>e</code> is equivalent to itself
	<dt>Symmetric
	<dd>If <code>e</code> is equivalent to <code>f</code>,
	then <code>f</code> is equivalent to <code>e</code>
	<dt>Transitive
	<dd>If <code>e</code> is equivalent to <code>f</code>,
	and <code>f</code> is equivalent to <code>g</code>,
	then <code>e</code> is equivalent to <code>g</code>
	</dl>

	<p>For any given pair of elements, answers in O(log N) (two hash-table
	lookups) whether they are equivalent to each other.</div>
	</section>
	<section class="summary">
	<ul class="blockList">
	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
	<li class="blockList">
	<section class="constructorSummary"><a id="constructor.summary">
	<!-- -->
	</a>
	<h2>Constructor Summary</h2>
	<div class="memberSummary">
	<table>
	<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
	<thead>
	<tr>
	<th class="colFirst" scope="col">Constructor</th>
	<th class="colLast" scope="col">Description</th>
	</tr>
	</thead>
	<tbody>
	<tr class="altColor">
	<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">EquivalenceSet</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="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></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><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(E)">add</a></span>(<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> e)</code></th>
	<td class="colLast">
	<div class="block">Adds an element, and returns the element (which is its own parent).</div>
	</td>
	</tr>
	<tr class="rowColor" id="i1">
	<td class="colFirst"><code>boolean</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#areEquivalent(E,E)">areEquivalent</a></span>(<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> e,
	<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> f)</code></th>
	<td class="colLast">
	<div class="block">Returns whether two elements are in the same equivalence class.</div>
	</td>
	</tr>
	<tr class="altColor" id="i2">
	<td class="colFirst"><code>int</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#classCount()">classCount</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns the number of equivalence classes in this equivalence set.</div>
	</td>
	</tr>
	<tr class="rowColor" id="i3">
	<td class="colFirst"><code>void</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clear()">clear</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Removes all elements in this equivalence set.</div>
	</td>
	</tr>
	<tr class="altColor" id="i4">
	<td class="colFirst"><code><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#equiv(E,E)">equiv</a></span>(<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> e,
	<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> f)</code></th>
	<td class="colLast">
	<div class="block">Marks two elements as equivalent.</div>
	</td>
	</tr>
	<tr class="rowColor" id="i5">
	<td class="colFirst"><code><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="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>,<a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedSet</a><<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>>></code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#map()">map</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Returns a map of the canonical element in each equivalence class to the
	set of elements in that class.</div>
	</td>
	</tr>
	<tr class="altColor" id="i6">
	<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 elements in this equivalence set.</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#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</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#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</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#toString()" title="class or interface in java.lang" class="externalLink">toString</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>
	</section>
	</li>
	</ul>
	</section>
	<section class="details">
	<ul class="blockList">
	<!-- ========= CONSTRUCTOR DETAIL ======== -->
	<li class="blockList">
	<section class="constructorDetails"><a id="constructor.detail">
	<!-- -->
	</a>
	<h2>Constructor Details</h2>
	<ul class="blockList">
	<li class="blockList">
	<section class="detail">
	<h3><a id="<init>()">EquivalenceSet</a></h3>
	<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">EquivalenceSet</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="add(java.lang.Comparable)">
	<!-- -->
	</a><a id="add(E)">add</a></h3>
	<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></span> <span class="memberName">add</span>(<span class="arguments"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> e)</span></div>
	<div class="block">Adds an element, and returns the element (which is its own parent).
	If already present, returns the element's parent.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="equiv(java.lang.Comparable,java.lang.Comparable)">
	<!-- -->
	</a><a id="equiv(E,E)">equiv</a></h3>
	<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a></span> <span class="memberName">equiv</span>(<span class="arguments"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> e,
	<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> f)</span></div>
	<div class="block">Marks two elements as equivalent.
	They may or may not be registered, and they may or may not be equal.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="areEquivalent(java.lang.Comparable,java.lang.Comparable)">
	<!-- -->
	</a><a id="areEquivalent(E,E)">areEquivalent</a></h3>
	<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">boolean</span> <span class="memberName">areEquivalent</span>(<span class="arguments"><a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> e,
	<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a> f)</span></div>
	<div class="block">Returns whether two elements are in the same equivalence class.
	Returns false if either or both of the elements are not registered.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="map()">map</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/SortedMap.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedMap</a><<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>,<a href="https://docs.oracle.com/javase/9/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util" class="externalLink">SortedSet</a><<a href="EquivalenceSet.html" title="type parameter in EquivalenceSet">E</a>>></span> <span class="memberName">map</span>()</div>
	<div class="block">Returns a map of the canonical element in each equivalence class to the
	set of elements in that class. The keys are sorted in natural order, as
	are the elements within each key.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="clear()">clear</a></h3>
	<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">clear</span>()</div>
	<div class="block">Removes all elements in this equivalence set.</div>
	</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 elements in this equivalence set.</div>
	</section>
	</li>
	<li class="blockList">
	<section class="detail">
	<h3><a id="classCount()">classCount</a></h3>
	<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">int</span> <span class="memberName">classCount</span>()</div>
	<div class="block">Returns the number of equivalence classes in this equivalence set.</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>Nested \| </li>
	<li>Field \| </li>
	<li><a href="#constructor.summary">Constr</a> \| </li>
	<li><a href="#method.summary">Method</a></li>
	</ul>
	<ul class="subNavList">
	<li>Detail: </li>
	<li>Field \| </li>
	<li><a href="#constructor.detail">Constr</a> \| </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>