New GMP functions and constants in PHP 5.6.1

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335011 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Leigh 2014-10-05 18:07:47 +00:00
parent 27acde0b15
commit 7f9ef66f58
3 changed files with 267 additions and 0 deletions

View file

@ -37,6 +37,61 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.gmp-msw-first">
<term>
<constant>GMP_MSW_FIRST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.gmp-lsw-first">
<term>
<constant>GMP_LSW_FIRST</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.gmp-little-endian">
<term>
<constant>GMP_LITTLE_ENDIAN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.gmp-big-endian">
<term>
<constant>GMP_BIG_ENDIAN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.gmp-native-endian">
<term>
<constant>GMP_NATIVE_ENDIAN</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.gmp-version">
<term>
<constant>GMP_VERSION</constant>

View file

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-export">
<refnamediv>
<refname>gmp_export</refname>
<refpurpose>Export to a binary string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>gmp_export</methodname>
<methodparam><type>GMP</type><parameter>gmpnumber</parameter></methodparam>
<methodparam><type>integer</type><parameter>word_size</parameter></methodparam>
<methodparam><type>integer</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Export a GMP number to a binary string
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>gmpnumber</parameter></term>
<listitem>
<para>
The GMP number being exported
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word_size</parameter></term>
<listitem>
<para>
Default value is 1. The number of bytes in each chunk of binary data. This is mainly used in conjunction with the options parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a string&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmp_export</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$number = gmp_init(6565);
echo gmp_export($number) . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
AA
]]>
</screen>
</example>
</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
-->

View file

@ -0,0 +1,108 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-import">
<refnamediv>
<refname>gmp_import</refname>
<refpurpose>Import from a binary string</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>GMP</type><methodname>gmp_import</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam><type>integer</type><parameter>word_size</parameter></methodparam>
<methodparam><type>integer</type><parameter>options</parameter></methodparam>
</methodsynopsis>
<para>
Import a GMP number from a binary string
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
<para>
The binary string being imported
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>word_size</parameter></term>
<listitem>
<para>
Default value is 1. The number of bytes in each chunk of binary data. This is mainly used in conjunction with the options parameter.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Default value is GMP_MSW_FIRST | GMP_NATIVE_ENDIAN.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a GMP number&return.falseforfailure;.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>gmp_import</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$number = gmp_import("\0");
echo gmp_strval($number) . "\n";
$number = gmp_import("\0\1\2");
echo gmp_strval($number) . "\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
0
528
]]>
</screen>
</example>
</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
-->