mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
0c9c2dd669
Cf. <https://github.com/php/doc-en/pull/289>. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@352191 c90b9560-bf6c-de11-be94-00142212c4b1
84 lines
2.3 KiB
XML
84 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.log" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>log</refname>
|
|
<refpurpose>Natural logarithm</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>float</type><methodname>log</methodname>
|
|
<methodparam><type>float</type><parameter>num</parameter></methodparam>
|
|
<methodparam choice="opt"><type>float</type><parameter>base</parameter><initializer><constant>M_E</constant></initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
If the optional <parameter>base</parameter> parameter is specified,
|
|
<function>log</function> returns log<subscript>base</subscript>
|
|
<parameter>num</parameter>, otherwise <function>log</function>
|
|
returns the natural logarithm of <parameter>num</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>num</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value to calculate the logarithm for
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>base</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The optional logarithmic base to use
|
|
(defaults to 'e' and so to the natural logarithm).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The logarithm of <parameter>num</parameter> to
|
|
<parameter>base</parameter>, if given, or the
|
|
natural logarithm.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>log10</function></member>
|
|
<member><function>exp</function></member>
|
|
<member><function>pow</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
|
|
-->
|