reference/gmp/functions/gmp-sign.xml
a35fce69cc4174f61cfa228ad677797c833f9cba
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.gmp-sign">
3
+
<refentry xml:id="function.gmp-sign" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>gmp_sign</refname>
6
6
<refpurpose>Sign of number</refpurpose>
...
...
@@ -10,7 +10,7 @@
10
10
&reftitle.description;
11
11
<methodsynopsis>
12
12
<type>int</type><methodname>gmp_sign</methodname>
13
-
<methodparam><type>resource</type><parameter>a</parameter></methodparam>
13
+
<methodparam><type class="union"><type>GMP</type><type>int</type><type>string</type></type><parameter>num</parameter></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
16
Checks the sign of a number.
...
...
@@ -22,9 +22,13 @@
22
22
<para>
23
23
<variablelist>
24
24
<varlistentry>
25
-
<term><parameter>a</parameter></term>
25
+
<term><parameter>num</parameter></term>
26
26
<listitem>
27
-
&gmp.parameter;
27
+
<para>
28
+
Either a <classname>GMP</classname> object, or a numeric
29
+
string provided that it is possible to convert the latter to an
30
+
<type>int</type>.
31
+
</para>
28
32
</listitem>
29
33
</varlistentry>
30
34
</variablelist>
...
...
@@ -34,9 +38,9 @@
34
38
<refsect1 role="returnvalues">
35
39
&reftitle.returnvalues;
36
40
<para>
37
-
Returns 1 if <parameter>a</parameter> is positive,
38
-
-1 if <parameter>a</parameter> is negative,
39
-
and 0 if <parameter>a</parameter> is zero.
41
+
Returns 1 if <parameter>num</parameter> is positive,
42
+
-1 if <parameter>num</parameter> is negative,
43
+
and 0 if <parameter>num</parameter> is zero.
40
44
</para>
41
45
</refsect1>
42
46

...
...
@@ -71,8 +75,17 @@ echo gmp_sign("0") . "\n";
71
75
</para>
72
76
</refsect1>
73
77

74
-
</refentry>
78
+
<refsect1 role="seealso">
79
+
&reftitle.seealso;
80
+
<para>
81
+
<simplelist>
82
+
<member><function>gmp_abs</function></member>
83
+
<member><function>abs</function></member>
84
+
</simplelist>
85
+
</para>
86
+
</refsect1>
75
87

88
+
</refentry>
76
89
<!-- Keep this comment at the end of the file
77
90
Local variables:
78
91
mode: sgml
79
92