Google Git
Sign in
apache / calcite-site / aa042a0da8aed8b59d4a32d423ef3d414459189e / . / javadocAggregate / org / apache / calcite / util / Permutation.html
blob: 6967c3681a03f43c24221f8f8bba4a5308fa72f4 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Permutation (Apache Calcite API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.calcite.util, class: Permutation">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<div class="about-language"><b>Apache Calcite</b></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&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="sub-nav-list">
<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="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.calcite.util</a></div>
<h1 title="Class Permutation" class="title">Class Permutation</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.calcite.util.Permutation</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="mapping/IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>&gt;</code>, <code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code>, <code><a href="mapping/Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></code>, <code><a href="mapping/Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code>, <code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code>, <code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Permutation</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>, <a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></span></div>
<div class="block">Represents a mapping which reorders elements in an array.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">Permutation</a><wbr>(int&nbsp;size)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a permutation of a given size.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int%5B%5D)" class="member-name-link">Permutation</a><wbr>(int[]&nbsp;targets)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a permutation from an array.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clear()" class="member-name-link">clear</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Removes all elements in the mapping.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#clone()" class="member-name-link">clone</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="mapping/MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMappingType()" class="member-name-link">getMappingType</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the mapping type.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSource(int)" class="member-name-link">getSource</a><wbr>(int&nbsp;target)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the position which maps to <code>target</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSourceCount()" class="member-name-link">getSourceCount</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the number of sources.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSourceOpt(int)" class="member-name-link">getSourceOpt</a><wbr>(int&nbsp;target)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the source that a target maps to, or -1 if it is not mapped.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTarget(int)" class="member-name-link">getTarget</a><wbr>(int&nbsp;source)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the position that <code>source</code> is mapped to.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetCount()" class="member-name-link">getTargetCount</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the number of targets.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTargetOpt(int)" class="member-name-link">getTargetOpt</a><wbr>(int&nbsp;source)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the target that a source maps to, or -1 if it is not mapped.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#identity()" class="member-name-link">identity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Initializes this permutation to the identity permutation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#insertSource(int)" class="member-name-link">insertSource</a><wbr>(int&nbsp;x)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Inserts into the sources.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#insertTarget(int)" class="member-name-link">insertTarget</a><wbr>(int&nbsp;x)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Inserts into the targets.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Permutation.html" title="class in org.apache.calcite.util">Permutation</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#inverse()" class="member-name-link">inverse</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the inverse permutation.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isIdentity()" class="member-name-link">isIdentity</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns whether this is the identity permutation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="mapping/IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#iterator()" class="member-name-link">iterator</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns an iterator over the elements in this mapping.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Permutation.html" title="class in org.apache.calcite.util">Permutation</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#product(org.apache.calcite.util.Permutation)" class="member-name-link">product</a><wbr>(<a href="Permutation.html" title="class in org.apache.calcite.util">Permutation</a>&nbsp;permutation)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the product of this Permutation with a given Permutation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(int,int)" class="member-name-link">set</a><wbr>(int&nbsp;source,
int&nbsp;target)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Maps source position to target position.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#set(int,int,boolean)" class="member-name-link">set</a><wbr>(int&nbsp;source,
int&nbsp;target,
boolean&nbsp;allowResize)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Maps source position to target position, automatically resizing if source
or target is out of bounds.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setAll(org.apache.calcite.util.mapping.Mapping)" class="member-name-link">setAll</a><wbr>(<a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>&nbsp;mapping)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>final int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#size()" class="member-name-link">size</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the number of elements in this permutation.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns a string representation of this permutation.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Iterable">Methods inherited from interface&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#forEach(java.util.function.Consumer)" title="class or interface in java.lang" class="external-link">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#spliterator()" title="class or interface in java.lang" class="external-link">spliterator</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(int)">
<h3>Permutation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Permutation</span><wbr><span class="parameters">(int&nbsp;size)</span></div>
<div class="block">Creates a permutation of a given size.
<p>It is initialized to the identity permutation, such as "[0, 1, 2, 3]".</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>size</code> - Number of elements in the permutation</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int[])">
<h3>Permutation</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Permutation</span><wbr><span class="parameters">(int[]&nbsp;targets)</span></div>
<div class="block">Creates a permutation from an array.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>targets</code> - Array of targets</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if elements of array are not unique</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">ArrayIndexOutOfBoundsException</a></code> - if elements of array are not
between 0 through targets.length - 1
inclusive</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="clone()">
<h3>clone</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span>&nbsp;<span class="element-name">clone</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="identity()">
<h3>identity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">identity</span>()</div>
<div class="block">Initializes this permutation to the identity permutation.</div>
</section>
</li>
<li>
<section class="detail" id="size()">
<h3>size</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">size</span>()</div>
<div class="block">Returns the number of elements in this permutation.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#size()">size</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.CoreMapping.html#size()">size</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="clear()">
<h3>clear</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">clear</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mapping.html#clear()">Mapping</a></code></span></div>
<div class="block">Removes all elements in the mapping.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#clear()">clear</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">toString</span>()</div>
<div class="block">Returns a string representation of this permutation.
<p>For example, the mapping
<table>
<caption>Example mapping</caption>
<tr>
<th>source</th>
<th>target</th>
</tr>
<tr>
<td>0</td>
<td>2</td>
</tr>
<tr>
<td>1</td>
<td>0</td>
</tr>
<tr>
<td>2</td>
<td>1</td>
</tr>
<tr>
<td>3</td>
<td>3</td>
</tr>
</table>
<p>is represented by the string "[2, 0, 1, 3]".</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="set(int,int)">
<h3>set</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">set</span><wbr><span class="parameters">(int&nbsp;source,
int&nbsp;target)</span></div>
<div class="block">Maps source position to target position.
<p>To preserve the 1:1 nature of the permutation, the previous target of
source becomes the new target of the previous source.
<p>For example, given the permutation
<blockquote><pre>[3, 2, 0, 1]</pre></blockquote>
<p>suppose we map position 2 to target 1. Position 2 currently has target
0, and the source of position 1 is position 3. We preserve the permutation
property by mapping the previous source 3 to the previous target 0. The new
permutation is
<blockquote><pre>[3, 2, 1, 0].</pre></blockquote>
<p>Another example. Again starting from
<blockquote><pre>[3, 2, 0, 1]</pre></blockquote>
<p>suppose we map position 2 to target 3. We map the previous source 0 to
the previous target 0, which gives
<blockquote><pre>[0, 2, 3, 1].</pre></blockquote></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#set(int,int)">set</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
<dt>Parameters:</dt>
<dd><code>source</code> - Source position</dd>
<dd><code>target</code> - Target position</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">ArrayIndexOutOfBoundsException</a></code> - if source or target is negative or
greater than or equal to the size of
the permuation</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="set(int,int,boolean)">
<h3>set</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">set</span><wbr><span class="parameters">(int&nbsp;source,
int&nbsp;target,
boolean&nbsp;allowResize)</span></div>
<div class="block">Maps source position to target position, automatically resizing if source
or target is out of bounds.
<p>To preserve the 1:1 nature of the permutation, the previous target of
source becomes the new target of the previous source.
<p>For example, given the permutation
<blockquote><pre>[3, 2, 0, 1]</pre></blockquote>
<p>suppose we map position 2 to target 1. Position 2 currently has target
0, and the source of position 1 is position 3. We preserve the permutation
property by mapping the previous source 3 to the previous target 0. The new
permutation is
<blockquote><pre>[3, 2, 1, 0].</pre></blockquote>
<p>Another example. Again starting from
<blockquote><pre>[3, 2, 0, 1]</pre></blockquote>
<p>suppose we map position 2 to target 3. We map the previous source 0 to
the previous target 0, which gives
<blockquote><pre>[0, 2, 3, 1].</pre></blockquote></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>source</code> - Source position</dd>
<dd><code>target</code> - Target position</dd>
<dd><code>allowResize</code> - Whether to resize the permutation if the source or
target is greater than the current capacity</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ArrayIndexOutOfBoundsException.html" title="class or interface in java.lang" class="external-link">ArrayIndexOutOfBoundsException</a></code> - if source or target is negative,
or greater than or equal to the size
of the permutation, and
<code>allowResize</code> is false</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="insertTarget(int)">
<h3>insertTarget</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">insertTarget</span><wbr><span class="parameters">(int&nbsp;x)</span></div>
<div class="block">Inserts into the targets.
<p>For example, consider the permutation</p>
<table border="1">
<caption>Example permutation</caption>
<tr>
<td>source</td>
<td>0</td>
<td>1</td>
<td>2</td>
<td>3</td>
<td>4</td>
</tr>
<tr>
<td>target</td>
<td>3</td>
<td>0</td>
<td>4</td>
<td>2</td>
<td>1</td>
</tr>
</table>
<p>After applying <code>insertTarget(2)</code> every target 2 or higher is
shifted up one.</p>
<table border="1">
<caption>Mapping after applying insertTarget(2)</caption>
<tr>
<td>source</td>
<td>0</td>
<td>1</td>
<td>2</td>
<td>3</td>
<td>4</td>
<td>5</td>
</tr>
<tr>
<td>target</td>
<td>4</td>
<td>0</td>
<td>5</td>
<td>3</td>
<td>1</td>
<td>2</td>
</tr>
</table>
<p>Note that the array has been extended to accommodate the new target, and
the previously unmapped source 5 is mapped to the unused target slot 2.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - Ordinal of position to add to target</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="insertSource(int)">
<h3>insertSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">insertSource</span><wbr><span class="parameters">(int&nbsp;x)</span></div>
<div class="block">Inserts into the sources.
<p>Behavior is analogous to <a href="#insertTarget(int)"><code>insertTarget(int)</code></a>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - Ordinal of position to add to source</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="inverse()">
<h3>inverse</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Permutation.html" title="class in org.apache.calcite.util">Permutation</a></span>&nbsp;<span class="element-name">inverse</span>()</div>
<div class="block">Returns the inverse permutation.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#inverse()">inverse</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#inverse()">inverse</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isIdentity()">
<h3>isIdentity</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isIdentity</span>()</div>
<div class="block">Returns whether this is the identity permutation.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#isIdentity()">isIdentity</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#isIdentity()">isIdentity</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTarget(int)">
<h3>getTarget</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getTarget</span><wbr><span class="parameters">(int&nbsp;source)</span></div>
<div class="block">Returns the position that <code>source</code> is mapped to.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.FunctionMapping.html#getTarget(int)">getTarget</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#getTarget(int)">getTarget</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
<dt>Parameters:</dt>
<dd><code>source</code> - source</dd>
<dt>Returns:</dt>
<dd>target</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSource(int)">
<h3>getSource</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getSource</span><wbr><span class="parameters">(int&nbsp;target)</span></div>
<div class="block">Returns the position which maps to <code>target</code>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#getSource(int)">getSource</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Parameters:</dt>
<dd><code>target</code> - target</dd>
<dt>Returns:</dt>
<dd>source</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span><wbr><span class="parameters">(@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;obj)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="iterator()">
<h3>iterator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a>&lt;<a href="mapping/IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>&gt;</span>&nbsp;<span class="element-name">iterator</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mapping.html#iterator()">Mapping</a></code></span></div>
<div class="block">Returns an iterator over the elements in this mapping.
<p>This method is optional; implementations may throw
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang" class="external-link"><code>UnsupportedOperationException</code></a>.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html#iterator()" title="class or interface in java.lang" class="external-link">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a>&lt;<a href="mapping/IntPair.html" title="class in org.apache.calcite.util.mapping">IntPair</a>&gt;</code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#iterator()">iterator</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSourceCount()">
<h3>getSourceCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getSourceCount</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mapping.html#getSourceCount()">Mapping</a></code></span></div>
<div class="block">Returns the number of sources. Valid sources will be in the range 0 ..
sourceCount.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#getSourceCount()">getSourceCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.FunctionMapping.html#getSourceCount()">getSourceCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#getSourceCount()">getSourceCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#getSourceCount()">getSourceCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTargetCount()">
<h3>getTargetCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getTargetCount</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mapping.html#getTargetCount()">Mapping</a></code></span></div>
<div class="block">Returns the number of targets. Valid targets will be in the range 0 ..
targetCount.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#getTargetCount()">getTargetCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#getTargetCount()">getTargetCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#getTargetCount()">getTargetCount</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getMappingType()">
<h3>getMappingType</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="mapping/MappingType.html" title="enum in org.apache.calcite.util.mapping">MappingType</a></span>&nbsp;<span class="element-name">getMappingType</span>()</div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mappings.CoreMapping.html#getMappingType()">Mappings.CoreMapping</a></code></span></div>
<div class="block">Returns the mapping type.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mapping.html#getMappingType()">getMappingType</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.CoreMapping.html#getMappingType()">getMappingType</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.CoreMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.CoreMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.FunctionMapping.html#getMappingType()">getMappingType</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#getMappingType()">getMappingType</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Returns:</dt>
<dd>Mapping type</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getTargetOpt(int)">
<h3>getTargetOpt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getTargetOpt</span><wbr><span class="parameters">(int&nbsp;source)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mappings.FunctionMapping.html#getTargetOpt(int)">Mappings.FunctionMapping</a></code></span></div>
<div class="block">Returns the target that a source maps to, or -1 if it is not mapped.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.FunctionMapping.html#getTargetOpt(int)">getTargetOpt</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.FunctionMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.FunctionMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#getTargetOpt(int)">getTargetOpt</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#getTargetOpt(int)">getTargetOpt</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSourceOpt(int)">
<h3>getSourceOpt</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">getSourceOpt</span><wbr><span class="parameters">(int&nbsp;target)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="mapping/Mappings.SourceMapping.html#getSourceOpt(int)">Mappings.SourceMapping</a></code></span></div>
<div class="block">Returns the source that a target maps to, or -1 if it is not mapped.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.SourceMapping.html#getSourceOpt(int)">getSourceOpt</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.SourceMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.SourceMapping</a></code></dd>
<dt>Specified by:</dt>
<dd><code><a href="mapping/Mappings.TargetMapping.html#getSourceOpt(int)">getSourceOpt</a></code>&nbsp;in interface&nbsp;<code><a href="mapping/Mappings.TargetMapping.html" title="interface in org.apache.calcite.util.mapping">Mappings.TargetMapping</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setAll(org.apache.calcite.util.mapping.Mapping)">
<h3>setAll</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAll</span><wbr><span class="parameters">(<a href="mapping/Mapping.html" title="interface in org.apache.calcite.util.mapping">Mapping</a>&nbsp;mapping)</span></div>
</section>
</li>
<li>
<section class="detail" id="product(org.apache.calcite.util.Permutation)">
<h3>product</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Permutation.html" title="class in org.apache.calcite.util">Permutation</a></span>&nbsp;<span class="element-name">product</span><wbr><span class="parameters">(<a href="Permutation.html" title="class in org.apache.calcite.util">Permutation</a>&nbsp;permutation)</span></div>
<div class="block">Returns the product of this Permutation with a given Permutation. Does
not modify this Permutation or <code>permutation</code>.
<p>For example, perm.product(perm.inverse()) yields the identity.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &copy; 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>