User's guide for special functions now uses the APT format, instead of the XDOC
format. git-svn-id: https://svn.apache.org/repos/asf/commons/proper/math/trunk@1391302 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Sebastien Brisard
parent
9462626718
commit
07f51c0dea
|
|
@ -0,0 +1,67 @@
|
|||
~~
|
||||
~~ Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
~~ contributor license agreements. See the NOTICE file distributed with
|
||||
~~ this work for additional information regarding copyright ownership.
|
||||
~~ The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
~~ (the "License"); you may not use this file except in compliance with
|
||||
~~ the License. You may obtain a copy of the License at
|
||||
~~
|
||||
~~ http://www.apache.org/licenses/LICENSE-2.0
|
||||
~~
|
||||
~~ Unless required by applicable law or agreed to in writing, software
|
||||
~~ distributed under the License is distributed on an "AS IS" BASIS,
|
||||
~~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
~~ See the License for the specific language governing permissions and
|
||||
~~ limitations under the License.
|
||||
~~
|
||||
|
||||
-----------------------------------------------
|
||||
The Commons Math User Guide - Special Functions
|
||||
-----------------------------------------------
|
||||
|
||||
5 Special Functions
|
||||
|
||||
* 5.1 Overview
|
||||
|
||||
The special functions portion of Commons-Math contains several useful
|
||||
functions not provided by <<<java.lang.Math>>>. These functions mostly serve
|
||||
as building blocks for other portions of Commons-Math but, as others may find
|
||||
them useful as stand-alone methods, these special functions were included as
|
||||
part of the Commons-Math public API.
|
||||
|
||||
* 5.2 Erf functions
|
||||
|
||||
{{{../apidocs/org/apache/commons/math3/special/Erf.html}Erf}} contains
|
||||
several useful functions involving the Error Function, Erf.
|
||||
|
||||
*----------------+---------+-------------------------------------------------------------------+
|
||||
|| Function || Method || Reference |
|
||||
*----------------+---------+-------------------------------------------------------------------+
|
||||
| Error Function |erf | See {{{http://mathworld.wolfram.com/Erf.html}Erf}} from MathWorld |
|
||||
*----------------+---------+-------------------------------------------------------------------+
|
||||
|
||||
* 5.3 Gamma functions
|
||||
|
||||
{{{../apidocs/org/apache/commons/math3/special/Gamma.html}Gamma}} contains
|
||||
several useful functions involving the Gamma Function.
|
||||
|
||||
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|| Function || Method || Reference |
|
||||
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| Log Gamma | logGamma | See {{{http://mathworld.wolfram.com/GammaFunction.html}Gamma Function}} from MathWorld |
|
||||
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
| Regularized Gamma | regularizedGammaP | See {{{http://mathworld.wolfram.com/RegularizedGammaFunction.html}Regularized Gamma Function}} from MathWorld |
|
||||
*-------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
* 5.4 Beta funtions
|
||||
|
||||
{{{../apidocs/org/apache/commons/math3/special/Beta.html}Beta}} contains
|
||||
several useful functions involving the Beta Function.
|
||||
|
||||
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|| Function || Method || Reference |
|
||||
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| Log Beta | logBeta | See {{{http://mathworld.wolfram.com/BetaFunction.html}Beta Function}} from MathWorld |
|
||||
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
|
||||
| Regularized Beta | regularizedBeta | See {{{http://mathworld.wolfram.com/RegularizedBetaFunction.html}Regularized Beta Function}} from MathWorld |
|
||||
*------------------+-----------------+-------------------------------------------------------------------------------------------------------------+
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
Licensed to the Apache Software Foundation (ASF) under one or more
|
||||
contributor license agreements. See the NOTICE file distributed with
|
||||
this work for additional information regarding copyright ownership.
|
||||
The ASF licenses this file to You under the Apache License, Version 2.0
|
||||
(the "License"); you may not use this file except in compliance with
|
||||
the License. You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
-->
|
||||
|
||||
<?xml-stylesheet type="text/xsl" href="./xdoc.xsl"?>
|
||||
<!-- $Id$ -->
|
||||
<document url="special.html">
|
||||
<properties>
|
||||
<title>The Commons Math User Guide - Special Functions</title>
|
||||
</properties>
|
||||
<body>
|
||||
<section name="5 Special Functions">
|
||||
<subsection name="5.1 Overview" href="overview">
|
||||
<p>
|
||||
The special functions portion of Commons-Math contains several useful functions not
|
||||
provided by <code>java.lang.Math</code>. These functions mostly serve as building blocks
|
||||
for other portions of Commons-Math but, as others may find them useful as stand-alone
|
||||
methods, these special functions were included as part of the Commons-Math public API.
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="5.2 Erf functions" href="erf">
|
||||
<p>
|
||||
<a href="../apidocs/org/apache/commons/math3/special/Erf.html">Erf</a> contains
|
||||
several useful functions involving the Error Function, Erf.
|
||||
<table>
|
||||
<tr><th>Function</th><th>Method</th><th>Reference</th></tr>
|
||||
<tr><td>Error Function</td><td>erf</td><td>See <a href="http://mathworld.wolfram.com/Erf.html">Erf</a> from MathWorld</td></tr>
|
||||
</table>
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="5.3 Gamma functions" href="gamma">
|
||||
<p>
|
||||
<a href="../apidocs/org/apache/commons/math3/special/Gamma.html">Gamma</a>
|
||||
contains several useful functions involving the Gamma Function.
|
||||
<table>
|
||||
<tr><th>Function</th><th>Method</th><th>Reference</th></tr>
|
||||
<tr><td>Log Gamma</td><td>logGamma</td><td>See <a href="http://mathworld.wolfram.com/GammaFunction.html">Gamma Function</a> from MathWorld</td></tr>
|
||||
<tr><td>Regularized Gamma</td><td>regularizedGammaP</td><td>See <a href="http://mathworld.wolfram.com/RegularizedGammaFunction.html">Regularized Gamma Function</a> from MathWorld</td></tr>
|
||||
</table>
|
||||
</p>
|
||||
</subsection>
|
||||
<subsection name="5.4 Beta funtions" href="beta">
|
||||
<p>
|
||||
<a href="../apidocs/org/apache/commons/math3/special/Beta.html">Beta</a>
|
||||
contains several useful functions involving the Beta Function.
|
||||
<table>
|
||||
<tr><th>Function</th><th>Method</th><th>Reference</th></tr>
|
||||
<tr><td>Log Beta</td><td>logBeta</td><td>See <a href="http://mathworld.wolfram.com/BetaFunction.html">Beta Function</a> from MathWorld</td></tr>
|
||||
<tr><td>Regularized Beta</td><td>regularizedBeta</td><td>See <a href="http://mathworld.wolfram.com/RegularizedBetaFunction.html">Regularized Beta Function</a> from MathWorld</td></tr>
|
||||
</table>
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
Loading…
Reference in New Issue