1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_sign">
<refmeta>
<refentrytitle>sign</refentrytitle>
<refmiscinfo>type</refmiscinfo>
<refmiscinfo>number</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sign</refname>
<refpurpose>returns -1, 0, or 1 depending on the sign of its numerical</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_sign">
<funcprototype id="fproto_sign">
<funcdef><function>sign</function></funcdef>
<paramdef><parameter>num</parameter> numeric</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>sign returns either -1, 0 or 1 depending whether its numeric argument is negative, zero or positive.
</para>
<screen>
sign(-12) -> -1
sign(0) -> 0
sign(910) -> 1
sign(atof('-1.23456789')) -> -1
sign(0.0) -> 0
</screen>
</refsect1>
</refentry>
|
