blob: a29c57b88f696f2fb18e3b8f0140f2fd441f2e9d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (19) -->
<title>org.apache.sis.math (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">
<meta name="generator" content="javadoc/PackageWriterImpl">
<meta name="keywords" content="org.apache.sis.math package">
<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="package-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 class="nav-bar-cell1-rev">Package</li>
<li>Class</li>
<li><a href="package-use.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#package">Help</a></li>
</ul>
<ul class="sub-nav-list-small">
<li>
<p>Package:</p>
<ul>
<li><a href="#package-description">Description</a></li>
<li>Related Packages</li>
<li><a href="#class-summary">Classes and Interfaces</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Package:&nbsp;</li>
<li><a href="#package-description">Description</a>&nbsp;|&nbsp;</li>
<li>Related Packages&nbsp;|&nbsp;</li>
<li><a href="#class-summary">Classes and Interfaces</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">
<div class="header">
<h1 title="Package org.apache.sis.math" class="title">Package org.apache.sis.math</h1>
</div>
<hr>
<div class="package-signature">package <span class="element-name">org.apache.sis.math</span></div>
<section class="package-description" id="package-description">
<div class="block">A set of mathematical objects and algebraic utilities.
This package provides:
<ul class="verbose">
<li>Mathematical functions as static methods in <a href="MathFunctions.html" title="class in org.apache.sis.math"><code>Math­Functions</code></a> and
<a href="DecimalFunctions.html" title="class in org.apache.sis.math"><code>Decimal­Functions</code></a>.</li>
<li><a href="Statistics.html" title="class in org.apache.sis.math"><code>Statistics</code></a> accumulator, optionally with statistics on derivatives
and <a href="StatisticsFormat.html" title="class in org.apache.sis.math">tabular formatting</a>.</li>
<li>Simple equations for <a href="Line.html" title="class in org.apache.sis.math"><code>Line</code></a> and <a href="Plane.html" title="class in org.apache.sis.math"><code>Plane</code></a>
with capability to determine the coefficients from a set of coordinates.
<div class="note"><b>Note:</b>
<code>Line</code> and <code>Plane</code> classes are not geometric objects since they are not bounded in space.
For example, the <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.desktop/java/awt/geom/Line2D.html" title="class or interface in java.awt.geom" class="external-link"><code>Line2D</code></a> geometry have starting and ending points, while the
<code>Line</code> class in this package extends to infinite.</div></li>
<li><a href="Vector.html" title="class in org.apache.sis.math"><code>Vector</code></a> of real numbers, typically as views over arrays of primitive types.
Those views make abstraction of the data type (e.g. <code>float</code>, <code>double</code>, <code>int</code>,
unsigned <code>int</code>, <i>etc.</i>).</li>
</ul></div>
<dl class="notes">
<dt>Since:</dt>
<dd>0.3</dd>
<p><font size="-1">Defined in the <code>sis-utility</code> module</font></p>
</dl>
</section>
<section class="summary">
<ul class="summary-list">
<li>
<div id="class-summary">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab2', 2)" class="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('class-summary', 'class-summary-tab3', 2)" class="table-tab">Enum Classes</button></div>
<div id="class-summary.tabpanel" role="tabpanel">
<div class="summary-table two-column-summary" aria-labelledby="class-summary-tab0">
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DecimalFunctions.html" title="class in org.apache.sis.math">DecimalFunctions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Functions working on <code>float</code> and <code>double</code> values while taking in account their representation in base 10.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Fraction.html" title="class in org.apache.sis.math">Fraction</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">A value class for rational numbers.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab3"><a href="FunctionProperty.html" title="enum class in org.apache.sis.math">FunctionProperty</a></div>
<div class="col-last even-row-color class-summary class-summary-tab3">
<div class="block">The manners in which the inputs of a function are mapped to the outputs.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Line.html" title="class in org.apache.sis.math">Line</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Equation of a line in a two dimensional space (<var>x</var>,<var>y</var>).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="MathFunctions.html" title="class in org.apache.sis.math">MathFunctions</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Simple mathematical functions in addition to the ones provided in <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Math.html" title="class or interface in java.lang" class="external-link"><code>Math</code></a>.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="Plane.html" title="class in org.apache.sis.math">Plane</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Equation of a plane in a three-dimensional space (<var>x</var>,<var>y</var>,<var>z</var>).</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Statistics.html" title="class in org.apache.sis.math">Statistics</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Holds some statistics derived from a series of sample values.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="StatisticsFormat.html" title="class in org.apache.sis.math">StatisticsFormat</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Formats a <a href="Statistics.html" title="class in org.apache.sis.math"><code>Statistics</code></a> object.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="Vector.html" title="class in org.apache.sis.math">Vector</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">A vector of real numbers.</div>
</div>
</div>
</div>
</div>
</li>
</ul>
</section>
</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>