.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)