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

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/gmp.xml, last change in rev 1.1 -->
  <refentry id="function.gmp-init">
   <refnamediv>
    <refname>gmp_init</refname>
    <refpurpose>Create GMP number</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <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></methodparam>
     </methodsynopsis>
    <para>
     Creates a GMP number from an integer or string. String
     representation can be decimal or hexadecimal. In the latter case,
     the string should start with <literal>0x</literal>.
     Optional parameter <parameter>base</parameter> is available since
     PHP 4.1.0.
    </para>
    <para>
     <example>
      <title>Creating GMP number</title>
      <programlisting role="php">
<![CDATA[
<?php
$a = gmp_init(123456);
$b = gmp_init("0xFFFFDEBACDFEDF7200");
?>
]]>
      </programlisting>
     </example>
    </para>

    <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:"../../../../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
-->