mirror of
https://github.com/macintoshplus/doc-en.git
synced 2026-04-26 10:08:02 +02:00
Mikhail Alferov
76 lines
2.0 KiB
XML
76 lines
2.0 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.expm1">
|
|
<refnamediv>
|
|
<refname>expm1</refname>
|
|
<refpurpose>
|
|
Returns <code>exp($num) - 1</code>, computed in a way that is accurate even
|
|
when the value of number is close to zero
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>float</type><methodname>expm1</methodname>
|
|
<methodparam><type>float</type><parameter>num</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>expm1</function> returns the equivalent to
|
|
<code>exp($<parameter>num</parameter>) - 1</code> computed in a way that is
|
|
accurate even if the value of <parameter>num</parameter> is near zero,
|
|
a case where <code>exp($<parameter>num</parameter>) - 1</code> would be
|
|
inaccurate due to subtraction of two numbers that are nearly equal.
|
|
</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>
|
|
<literal>e</literal> to the power of <parameter>num</parameter>, minus one.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>log1p</function></member>
|
|
<member><function>exp</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
|
|
-->
|