man-pages/man3/signbit.3

57 lines
1.3 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright 2002 Walter Harms (walter.harms@informatik.uni-oldenburg.de)
.\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
.\" <mtk.manpages@gmail.com>
2004-11-03 13:51:07 +00:00
.\" Distributed under GPL
.\" Based on glibc infopages
2008-08-01 05:54:27 +00:00
.TH SIGNBIT 3 2008-08-05 "GNU" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
signbit \- test sign of a real floating-point number
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.B "#include <math.h>"
.sp
2007-12-17 17:04:19 +00:00
.BI "int signbit(" x ");"
2004-11-03 13:51:07 +00:00
.sp
Link with \fI\-lm\fP.
.sp
.in -4n
Feature Test Macro Requirements for glibc (see
.BR feature_test_macros (7)):
.in
.sp
.ad l
.BR signbit ():
_XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE; or
.I cc\ -std=c99
.ad b
2004-11-03 13:51:07 +00:00
.SH DESCRIPTION
2007-12-17 17:04:19 +00:00
.BR signbit ()
is a generic macro which can work on all real floating-point types.
2008-03-19 13:16:39 +00:00
It returns a non-zero value if the value of
2007-12-17 17:04:19 +00:00
.I x
has its sign bit set.
2004-11-03 13:51:07 +00:00
.PP
This is not the same as
2007-12-17 17:04:19 +00:00
.IR "x < 0.0" ,
because IEEE 754 floating point allows zero to be signed.
The comparison
2007-12-17 17:04:19 +00:00
.IR "-0.0 < 0.0"
is false, but
2007-12-17 17:04:19 +00:00
.IR "signbit(\-0.0)"
2008-03-19 13:16:39 +00:00
will return a non-zero value.
NaNs and infinities have a sign bit.
.SH RETURN VALUE
The
.BR signbit ()
macro returns non-zero if the sign of
2008-08-08 05:19:07 +00:00
.I x
is negative; otherwise it returns zero.
.SH ERRORS
No errors occur.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
C99, POSIX.1-2001.
This function is defined in IEC 559 (and the appendix with
2004-11-03 13:51:07 +00:00
recommended functions in IEEE 754/IEEE 854).
.SH "SEE ALSO"
.BR copysign (3)