php-doc-en/reference/gmp/functions/gmp-init.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-init">
 <refnamediv>
  <refname>gmp_init</refname>
  <refpurpose>Create GMP number</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>gmp_init</methodname>
   <methodparam><type>mixed</type><parameter>number</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>base</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   Creates a GMP number from an integer or string. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>number</parameter></term>
     <listitem>
      <para>
       An integer or a string. The string representation can be decimal, 
       hexadecimal or octal.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>base</parameter></term>
     <listitem>
      <para>
       The base. Defaults to 0.
      </para>
      <para>
       The base may vary from 2 to 36. If base is 0 (default value), the
       actual base is determined from the leading characters: if the first
       two characters are <literal>0x</literal> or <literal>0X</literal>,
       hexadecimal is assumed, otherwise if the first character is "0",
       octal is assumed, otherwise decimal is assumed.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &gmp.return;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.1.0</entry>
       <entry>
        The optional <parameter>base</parameter>  parameter was added.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Creating GMP number</title>
    <programlisting role="php">
<![CDATA[
<?php
$a = gmp_init(123456);
$b = gmp_init("0xFFFFDEBACDFEDF7200");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    It is not necessary to call this function if you want to use
    integer or string in place of GMP number in GMP functions, like
    <function>gmp_add</function>. Function arguments are
    automatically converted to GMP numbers, if such conversion is
    possible and needed, using the same rules as
    <function>gmp_init</function>.
   </para>
  </note>
 </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
-->