mirror of
https://github.com/php/doc-en.git
synced 2026-04-28 09:43:18 +02:00
Christoph M. Becker
72059f6530
Would be nice if we could actually link to these, but this is as good as it goes for now.
91 lines
2.3 KiB
XML
91 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.sqrt" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>sqrt</refname>
|
|
<refpurpose>Square root</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>float</type><methodname>sqrt</methodname>
|
|
<methodparam><type>float</type><parameter>num</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Returns the square root of <parameter>num</parameter>.
|
|
</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 square root of <parameter>num</parameter>
|
|
or the special value <literal>NAN</literal> for negative numbers.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>sqrt</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Precision depends on your precision directive
|
|
echo sqrt(9); // 3
|
|
echo sqrt(10); // 3.16227766 ...
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>pow</function></member>
|
|
<member><constant>M_SQRTPI</constant> - <code>sqrt(pi)</code></member>
|
|
<member><constant>M_2_SQRTPI</constant> - <code>2/sqrt(pi)</code></member>
|
|
<member><constant>M_SQRT2</constant> - <code>sqrt(2)</code></member>
|
|
<member><constant>M_SQRT3</constant> - <code>sqrt(3)</code></member>
|
|
<member><constant>M_SQRT1_2</constant> - <code>1/sqrt(2)</code></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
|
|
-->
|