Documenting a bunch of mathematical functions:

sinh, cosh, tanh, asinh, acosh, atanh

The last three are not available on windows...


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@61964 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Gabor Hojtsy 2001-11-11 10:42:08 +00:00
parent 9bed3c9845
commit 68e88055ce

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.56 $ -->
<!-- $Revision: 1.57 $ -->
<reference id="ref.math">
<title>Mathematical Functions</title>
<titleabbrev>Math</titleabbrev>
@ -162,10 +162,37 @@
</funcprototype>
</funcsynopsis>
<para>
Returns the arc cosine of arg in radians.
Returns the arc cosine of <parameter>arg</parameter> in radians.
</para>
<para>
See also <function>asin</function> and <function>atan</function>.
See also <function>acosh</function>, <function>asin</function>
and <function>atan</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.acosh">
<refnamediv>
<refname>acosh</refname>
<refpurpose>Inverse hyperbolic cosine</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>acosh</function></funcdef>
<paramdef>float <parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the inverse hyperbolic cosine of
<parameter>arg</parameter>, i.e. the value whose
hyperbolic cosine is <parameter>arg</parameter>.
</para>
&note.no-windows;
<para>
See also <function>acos</function>, <function>asin</function>
and <function>atan</function>.
</para>
</refsect1>
</refentry>
@ -187,7 +214,34 @@
Returns the arc sine of arg in radians.
</para>
<para>
See also <function>acos</function> and <function>atan</function>.
See also <function>asinh</function>, <function>acos</function>
and <function>atan</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.asinh">
<refnamediv>
<refname>asinh</refname>
<refpurpose>Inverse hyperbolic sine</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>asinh</function></funcdef>
<paramdef>float <parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the inverse hyperbolic sine of
<parameter>arg</parameter>, i.e. the value whose
hyperbolic sine is <parameter>arg</parameter>.
</para>
&note.no-windows;
<para>
See also <function>asin</function>, <function>acos</function>
and <function>atan</function>.
</para>
</refsect1>
</refentry>
@ -209,7 +263,34 @@
Returns the arc tangent of arg in radians.
</para>
<para>
See also <function>asin</function> and <function>acos</function>.
See also <function>atanh</function>, <function>asin</function>
and <function>acos</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.atanh">
<refnamediv>
<refname>atanh</refname>
<refpurpose>Inverse hyperbolic tangent</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>atanh</function></funcdef>
<paramdef>float <parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the inverse hyperbolic tangent of
<parameter>arg</parameter>, i.e. the value whose
hyperbolic tangent is <parameter>arg</parameter>.
</para>
&note.no-windows;
<para>
See also <function>atan</function>, <function>asin</function>
and <function>acos</function>.
</para>
</refsect1>
</refentry>
@ -359,6 +440,30 @@ $binary = base_convert ($hexadecimal, 16, 2);
</refsect1>
</refentry>
<refentry id="function.cosh">
<refnamediv>
<refname>cosh</refname>
<refpurpose>Hyperbolic cosine</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>cosh</function></funcdef>
<paramdef>float <parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the hyperbolic cosine of <parameter>arg</parameter>,
defined as <literal>(exp(arg) + exp(-arg))/2</literal>.
</para>
<para>
See also <function>cos</function>, <function>acosh</function>,
<function>sin</function> and <function>tan</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.decbin">
<refnamediv>
<refname>decbin</refname>
@ -1190,6 +1295,30 @@ $foo = round(1241757, -3); // $foo == 1242000
</refsect1>
</refentry>
<refentry id="function.sinh">
<refnamediv>
<refname>sinh</refname>
<refpurpose>Hyperbolic sine</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>sinh</function></funcdef>
<paramdef>float <parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the hyperbolic sine of <parameter>arg</parameter>,
defined as <literal>(exp(arg) - exp(-arg))/2</literal>.
</para>
<para>
See also <function>sin</function>, <function>asinh</function>,
<function>cos</function> and <function>tan</function>.
</para>
</refsect1>
</refentry>
<refentry id="function.sqrt">
<refnamediv>
<refname>sqrt</refname>
@ -1268,6 +1397,30 @@ $randval = rand();
</refsect1>
</refentry>
<refentry id="function.tanh">
<refnamediv>
<refname>tanh</refname>
<refpurpose>Hyperbolic tangent</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>float <function>tanh</function></funcdef>
<paramdef>float <parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns the hyperbolic tangent of <parameter>arg</parameter>,
defined as <literal>sinh(arg)/cosh(arg)</literal>.
</para>
<para>
See also <function>tan</function>, <function>atanh</function>,
<function>sin</function> and <function>cos</function>.
</para>
</refsect1>
</refentry>
</reference>
<!-- Keep this comment at the end of the file