php-doc-en/reference/math/functions/atan.xml
2020-12-26 19:26:31 +00:00

74 lines
1.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.atan" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>atan</refname>
<refpurpose>Arc tangent</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>float</type><methodname>atan</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
</methodsynopsis>
<para>
Returns the arc tangent of <parameter>num</parameter> in radians.
<function>atan</function> is the inverse function of
<function>tan</function>, which means that
<literal>a==tan(atan(a))</literal> for every value of a that is within
<function>atan</function>'s range.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
The argument to process
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The arc tangent of <parameter>num</parameter> in radians.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>tan</function></member>
<member><function>atanh</function></member>
<member><function>asin</function></member>
<member><function>acos</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->