php-doc-en/reference/gmp/functions/gmp-root.xml
Adam Harvey f2c41f5da1 Update new functions in PHP 5.6.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334641 c90b9560-bf6c-de11-be94-00142212c4b1
2014-08-28 06:47:08 +00:00

71 lines
1.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-root">
<refnamediv>
<refname>gmp_root</refname>
<refpurpose>Take the integer part of nth root</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>GMP</type><methodname>gmp_root</methodname>
<methodparam><type>GMP</type><parameter>a</parameter></methodparam>
<methodparam><type>int</type><parameter>nth</parameter></methodparam>
</methodsynopsis>
<para>
Takes the <parameter>nth</parameter> root of <parameter>a</parameter> and
returns the integer component of the result.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>a</parameter></term>
<listitem>
&gmp.parameter;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>nth</parameter></term>
<listitem>
<para>
The positive root to take of <parameter>a</parameter>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The integer component of the resultant root, as a GMP number.
</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
-->