org/apache/sis/math/FunctionProperty.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (19) -->
 <title>FunctionProperty (Apache SIS 1.3 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.sis.math, enum: FunctionProperty">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.math.FunctionProperty class">
 <meta name="keywords" content="values()">
 <meta name="keywords" content="valueOf()">
 <meta name="keywords" content="isBijective()">
 <meta name="keywords" content="isMonotonic()">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../sis.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.6.0.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 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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/FunctionProperty.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li><a href="#nested-class-summary">Nested</a></li>
 <li><a href="#enum-constant-summary">Enum Constants</a></li>
 <li>Field</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li><a href="#enum-constant-detail">Enum Constants</a></li>
 <li>Field</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
 <li><a href="#enum-constant-summary">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li><a href="#enum-constant-detail">Enum Constants</a>&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </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.sis.math</a></div>
 <h1 title="Enum Class FunctionProperty" class="title">Enum Class FunctionProperty</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;
 <div class="inheritance">FunctionProperty</div>
 </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/16/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;</code>, <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/constant/Constable.html" title="class or interface in java.lang.constant" class="external-link">Constable</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name type-name-label">FunctionProperty</span>
 <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;</span></div>
 <div class="block">The manners in which the inputs of a function are mapped to the outputs.
  The function doesn't need to be mathematical. For example, this enumeration
  can be used with <a href="../util/ObjectConverter.html" title="interface in org.apache.sis.util"><code>ObjectConverter</code></a>.

  <p>Any given function can have zero, one or more properties from this enumeration.
  Some properties not included in this enumeration can be expressed by a combination of
  other properties:</p>

  <table class="sis">
    <caption>Inferred function properties</caption>
    <tr><th>Property</th> <th>How to build</th></tr>
    <tr><td><a href="#isBijective(java.util.Set)">Bijective</a></td>
        <td><code>EnumSet.of(<a href="#INJECTIVE">INJECTIVE</a>, <a href="#SURJECTIVE">SURJECTIVE</a>)</code></td>
    <tr><td><a href="#isMonotonic(java.util.Set)">Monotonic</a></td>
        <td><code>EnumSet.of(<a href="#INJECTIVE">INJECTIVE</a>)</code>
         or <code>EnumSet.of(<a href="#SURJECTIVE">SURJECTIVE</a>)</code></td>
    <tr><td>Strictly increasing</td>
        <td><code>EnumSet.of(<a href="#ORDER_PRESERVING">ORDER_PRESERVING</a>, <a href="#INJECTIVE">INJECTIVE</a>)</code></td>
    <tr><td>Strictly decreasing</td>
        <td><code>EnumSet.of(<a href="#ORDER_REVERSING">ORDER_REVERSING</a>, <a href="#INJECTIVE">INJECTIVE</a>)</code></td>
  </table>

  The Javadoc in this class uses the following terms:
  <ul>
    <li><var>S</var> (as in <cite>source</cite>) is the set of all possible input values (the <cite>domain</cite>).
    <li><var>T</var> (as in <cite>target</cite>) is a set containing all possible output values,
        and potentially more elements (the <cite>codomain</cite>). For example, the set of output
        values of the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html#toString()" title="class or interface in java.lang" class="external-link"><code>Integer.toString()</code></a> function is included in a larger set, which is
        the set of all possible <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> values. In this Javadoc, <var>T</var> stands for
        the latter set.</li>
  </ul></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.3</dd>
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../util/ObjectConverter.html#properties()"><code>ObjectConverter.properties()</code></a></li>
 </ul>
 </dd>

 <p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ======== NESTED CLASS SUMMARY ======== -->
 <li>
 <section class="nested-class-summary" id="nested-class-summary">
 <h2>Nested Class Summary</h2>
 <div class="inherited-list">
 <h2 id="nested-classes-inherited-from-class-java.lang.Enum">Nested classes/interfaces inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h2>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">Enum.EnumDesc</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a> extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a>&lt;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.EnumDesc.html" title="class or interface in java.lang" class="external-link">E</a>&gt;&gt;</code></div>
 </section>
 </li>
 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
 <li>
 <section class="constants-summary" id="enum-constant-summary">
 <h2>Enum Constant Summary</h2>
 <div class="caption"><span>Enum Constants</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Enum Constant</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code><a href="#INJECTIVE" class="member-name-link">INJECTIVE</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A function is <cite>injective</cite> if each value of <var>T</var> is either unrelated
  to <var>S</var>, or is the output of exactly one value of <var>S</var>.</div>
 </div>
 <div class="col-first odd-row-color"><code><a href="#INVERTIBLE" class="member-name-link">INVERTIBLE</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">A function is <cite>invertible</cite> if it can provide another function mapping
  <var>T</var> values to <var>S</var> values.</div>
 </div>
 <div class="col-first even-row-color"><code><a href="#ORDER_PRESERVING" class="member-name-link">ORDER_PRESERVING</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A function preserves order if any sequence of increasing <var>S</var> values is mapped
  to a sequence of increasing <var>T</var> values.</div>
 </div>
 <div class="col-first odd-row-color"><code><a href="#ORDER_REVERSING" class="member-name-link">ORDER_REVERSING</a></code></div>
 <div class="col-last odd-row-color">
 <div class="block">A function reverses order if any sequence of increasing <var>S</var> values is mapped
  to a sequence of decreasing <var>T</var> values.</div>
 </div>
 <div class="col-first even-row-color"><code><a href="#SURJECTIVE" class="member-name-link">SURJECTIVE</a></code></div>
 <div class="col-last even-row-color">
 <div class="block">A function is <cite>surjective</cite> if any value of <var>T</var> can be created
  from one or many values of <var>S</var>.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-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-tab1 method-summary-table-tab4"><code>static boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isBijective(java.util.Set)" class="member-name-link">isBijective</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;&nbsp;properties)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns <code>true</code> if a function having the given set of properties is <cite>bijective</cite>.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isMonotonic(java.util.Set)" class="member-name-link">isMonotonic</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;&nbsp;properties)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns <code>true</code> if a function having the given set of properties is <cite>monotonic</cite>.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns the enum constant of this class with the specified name.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>[]</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#values()" class="member-name-link">values</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">
 <div class="block">Returns an array containing the constants of this enum class, in
 the order they are declared.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Enum">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html" title="class or interface in java.lang" class="external-link">Enum</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#describeConstable()" title="class or interface in java.lang" class="external-link">describeConstable</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/16/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/16/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/16/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/16/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/16/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/16/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/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ ENUM CONSTANT DETAIL =========== -->
 <li>
 <section class="constant-details" id="enum-constant-detail">
 <h2>Enum Constant Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="INVERTIBLE">
 <h3>INVERTIBLE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></span>&nbsp;<span class="element-name">INVERTIBLE</span></div>
 <div class="block">A function is <cite>invertible</cite> if it can provide another function mapping
  <var>T</var> values to <var>S</var> values.

  <p>While other values defined in this enumeration are more about the mathematical aspects
  of functions, this particular value is more about the programmatical aspect. A function
  may be conceptually invertible (all <a href="#isBijective(java.util.Set)">bijective</a> functions
  should be), but the inverse operation may not be implemented. In such case, the function
  properties shall not include this <code>INVERTIBLE</code> value.</p></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="../util/ObjectConverter.html#inverse()"><code>ObjectConverter.inverse()</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="INJECTIVE">
 <h3>INJECTIVE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></span>&nbsp;<span class="element-name">INJECTIVE</span></div>
 <div class="block">A function is <cite>injective</cite> if each value of <var>T</var> is either unrelated
  to <var>S</var>, or is the output of exactly one value of <var>S</var>.

  <div class="note"><b>Example:</b>
  An <a href="../util/ObjectConverter.html" title="interface in org.apache.sis.util"><code>ObjectConverter</code></a> doing conversions from <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a> to <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a>
  is an injective function, because no pair of integers can produce the same string.</div>

  A function which is both injective and <a href="#SURJECTIVE">surjective</a> is a
  <cite>bijective</cite> function. In such functions, there is a one-to-one relationship
  between all input and output values.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#SURJECTIVE"><code>SURJECTIVE</code></a></li>
 <li><a href="#isBijective(java.util.Set)"><code>isBijective(Set)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="SURJECTIVE">
 <h3>SURJECTIVE</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></span>&nbsp;<span class="element-name">SURJECTIVE</span></div>
 <div class="block">A function is <cite>surjective</cite> if any value of <var>T</var> can be created
  from one or many values of <var>S</var>.

  <div class="note"><b>Example:</b>
  An <a href="../util/ObjectConverter.html" title="interface in org.apache.sis.util"><code>ObjectConverter</code></a> doing conversions from <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link"><code>String</code></a> to <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link"><code>Integer</code></a>
  is a surjective function, since there is always at least one string for each integer value. Note that such
  function cannot be injective since many different strings can represent the same integer value.</div>

  A function which is both <a href="#INJECTIVE">injective</a> and surjective is a
  <cite>bijective</cite> function. In such functions, there is a one-to-one relationship
  between all input and output values.</div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#INJECTIVE"><code>INJECTIVE</code></a></li>
 <li><a href="#isBijective(java.util.Set)"><code>isBijective(Set)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="ORDER_PRESERVING">
 <h3>ORDER_PRESERVING</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></span>&nbsp;<span class="element-name">ORDER_PRESERVING</span></div>
 <div class="block">A function preserves order if any sequence of increasing <var>S</var> values is mapped
  to a sequence of increasing <var>T</var> values. This enumeration constant can be used
  only with <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link"><code>Comparable</code></a> types or primitive types having a comparable wrapper.

  <p>Strictly ordered input values are not necessarily mapped to strictly ordered output values.
  Strictness is preserved only if the function is also <a href="#INJECTIVE">injective</a>.</p>

  <p>A function may be both order preserving and <a href="#ORDER_REVERSING">order reversing</a>
  if all input values are mapped to a constant output value.</p></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#ORDER_REVERSING"><code>ORDER_REVERSING</code></a></li>
 <li><a href="#isMonotonic(java.util.Set)"><code>isMonotonic(Set)</code></a></li>
 </ul>
 </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="ORDER_REVERSING">
 <h3>ORDER_REVERSING</h3>
 <div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></span>&nbsp;<span class="element-name">ORDER_REVERSING</span></div>
 <div class="block">A function reverses order if any sequence of increasing <var>S</var> values is mapped
  to a sequence of decreasing <var>T</var> values. This enumeration constant can be used
  only with <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link"><code>Comparable</code></a> types or primitive types having a comparable wrapper.

  <p>Strictly ordered input values are not necessarily mapped to strictly ordered output values.
  Strictness is preserved only if the function is also <a href="#INJECTIVE">injective</a>.</p>

  <p>A function may be both <a href="#ORDER_PRESERVING">order preserving</a> and order reversing
  if all input values are mapped to a constant output value.</p></div>
 <dl class="notes">
 <dt>See Also:</dt>
 <dd>
 <ul class="see-list">
 <li><a href="#ORDER_PRESERVING"><code>ORDER_PRESERVING</code></a></li>
 <li><a href="#isMonotonic(java.util.Set)"><code>isMonotonic(Set)</code></a></li>
 </ul>
 </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="values()">
 <h3>values</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>[]</span>&nbsp;<span class="element-name">values</span>()</div>
 <div class="block">Returns an array containing the constants of this enum class, in
 the order they are declared.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>an array containing the constants of this enum class, in the order they are declared</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="valueOf(java.lang.String)">
 <h3>valueOf</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></span>&nbsp;<span class="element-name">valueOf</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
 <div class="block">Returns the enum constant of this class with the specified name.
 The string must match <i>exactly</i> an identifier used to declare an
 enum constant in this class.  (Extraneous whitespace characters are
 not permitted.)</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>name</code> - the name of the enum constant to be returned.</dd>
 <dt>Returns:</dt>
 <dd>the enum constant with the specified name</dd>
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum class has no constant with the specified name</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isBijective(java.util.Set)">
 <h3>isBijective</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isBijective</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;&nbsp;properties)</span></div>
 <div class="block">Returns <code>true</code> if a function having the given set of properties is <cite>bijective</cite>.
  Bijective functions have a one-to-one relationship between all input and output values.
  This convenience method tests if the given set contains <em>all</em> following properties:

  <ul>
    <li><a href="#INJECTIVE"><code>INJECTIVE</code></a></li>
    <li><a href="#SURJECTIVE"><code>SURJECTIVE</code></a></li>
  </ul></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>properties</code> - the properties of the function to test for bijectivity.</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if a function having the given set of properties is bijective.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="isMonotonic(java.util.Set)">
 <h3>isMonotonic</h3>
 <div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isMonotonic</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a>&gt;&nbsp;properties)</span></div>
 <div class="block">Returns <code>true</code> if a function having the given set of properties is <cite>monotonic</cite>.
  This convenience method tests if the given set contains <em>at least one</em> of the following
  properties:

  <ul>
    <li><a href="#ORDER_PRESERVING"><code>ORDER_PRESERVING</code></a></li>
    <li><a href="#ORDER_REVERSING"><code>ORDER_REVERSING</code></a></li>
  </ul></div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>properties</code> - the properties of the function to test for monotonicity.</dd>
 <dt>Returns:</dt>
 <dd><code>true</code> if a function having the given set of properties is monotonic.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2010&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>