blob: 6c48cac72a73e36591c7977187ce05bfda9c29ed (
plain) (
blame)
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
|
.TH LIBJ2_SGN_J2I 3 LIBJ2
.SH NAME
libj2_sgn_j2i \- Get signum of value
.SH SYNOPSIS
.nf
#include <libj2.h>
int \fBlibj2_sgn_j2i\fP(const struct libj2_j2i *\fIa\fP);
int \fBlibj2_sgn_j2u\fP(const struct libj2_j2u *\fIa\fP);
.fi
.PP
Link with
.IR -lj2 .
.SH DESCRIPTION
The
.BR libj2_sgn_j2i ()
and
.BR libj2_sgn_j2u ()
function compares
.I a
against zero, returning whether
the value is positive, negative, or zero.
.PP
.I a
is assumed to be
.RI non- NULL .
.SH RETURN VALUE
The functions return -1 if the value of
.I a
is negative
(impossible for the
.BR libj2_sgn_j2u ()
function), +1 if the value is positive,
and 0 if zero.
.SH ERRORS
The functions cannot fail.
.SH HISTORY
The
.BR libj2_sgn_j2u ()
function was added in version 1.0 of
.BR libj2 .
.PP
The
.BR libj2_sgn_j2i ()
function was added in version 1.1 of
.BR libj2 .
.SH SEE ALSO
.BR libj2 (7),
.BR libj2_j2i_cmp_j2i (3),
.BR libj2_j2i_is_zero (3),
.BR libj2_j2i_is_negative (3),
.BR libj2_j2i_is_positive (3)
|
