Blame man-pages-posix-2013-a/man3p/isgreaterequal.3p

Packit 7cfc04
'\" et
Packit 7cfc04
.TH ISGREATEREQUAL "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
Packit 7cfc04
.SH PROLOG
Packit 7cfc04
This manual page is part of the POSIX Programmer's Manual.
Packit 7cfc04
The Linux implementation of this interface may differ (consult
Packit 7cfc04
the corresponding Linux manual page for details of Linux behavior),
Packit 7cfc04
or the interface may not be implemented on Linux.
Packit 7cfc04
Packit 7cfc04
.SH NAME
Packit 7cfc04
isgreaterequal
Packit 7cfc04
\(em test if x is greater than or equal to y
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.LP
Packit 7cfc04
.nf
Packit 7cfc04
#include <math.h>
Packit 7cfc04
.P
Packit 7cfc04
int isgreaterequal(real-floating \fIx\fP, real-floating \fIy\fP);
Packit 7cfc04
.fi
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The functionality described on this reference page is aligned with the
Packit 7cfc04
ISO\ C standard. Any conflict between the requirements described here and the
Packit 7cfc04
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2008 defers to the ISO\ C standard.
Packit 7cfc04
.P
Packit 7cfc04
The
Packit 7cfc04
\fIisgreaterequal\fR()
Packit 7cfc04
macro shall determine whether its first argument is greater than or
Packit 7cfc04
equal to its second argument. The value of
Packit 7cfc04
.IR isgreaterequal (\c
Packit 7cfc04
.IR x ,
Packit 7cfc04
.IR y )
Packit 7cfc04
shall be equal to (\fIx\fR)\ \(>=\ (\fIy\fR); however, unlike
Packit 7cfc04
(\fIx\fR)\ \(>=\ (\fIy\fR),
Packit 7cfc04
.IR isgreaterequal (\c
Packit 7cfc04
.IR x ,
Packit 7cfc04
.IR y )
Packit 7cfc04
shall not raise the invalid floating-point exception when
Packit 7cfc04
.IR x
Packit 7cfc04
and
Packit 7cfc04
.IR y
Packit 7cfc04
are unordered.
Packit 7cfc04
.SH "RETURN VALUE"
Packit 7cfc04
Upon successful completion, the
Packit 7cfc04
\fIisgreaterequal\fR()
Packit 7cfc04
macro shall return the value of (\fIx\fR)\ \(>=\ (\fIy\fR).
Packit 7cfc04
.P
Packit 7cfc04
If
Packit 7cfc04
.IR x
Packit 7cfc04
or
Packit 7cfc04
.IR y
Packit 7cfc04
is NaN, 0 shall be returned.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
No errors are defined.
Packit 7cfc04
.LP
Packit 7cfc04
.IR "The following sections are informative."
Packit 7cfc04
.SH EXAMPLES
Packit 7cfc04
None.
Packit 7cfc04
.SH "APPLICATION USAGE"
Packit 7cfc04
The relational and equality operators support the usual mathematical
Packit 7cfc04
relationships between numeric values. For any ordered pair of numeric
Packit 7cfc04
values, exactly one of the relationships (less, greater, and equal) is
Packit 7cfc04
true. Relational operators may raise the invalid floating-point
Packit 7cfc04
exception when argument values are NaNs. For a NaN and a numeric value,
Packit 7cfc04
or for two NaNs, just the unordered relationship is true. This macro
Packit 7cfc04
is a quiet (non-floating-point exception raising) version of a
Packit 7cfc04
relational operator. It facilitates writing efficient code that
Packit 7cfc04
accounts for NaNs without suffering the invalid floating-point
Packit 7cfc04
exception. In the SYNOPSIS section,
Packit 7cfc04
.BR real-floating
Packit 7cfc04
indicates that the argument shall be an expression of
Packit 7cfc04
.BR real-floating
Packit 7cfc04
type.
Packit 7cfc04
.SH RATIONALE
Packit 7cfc04
None.
Packit 7cfc04
.SH "FUTURE DIRECTIONS"
Packit 7cfc04
None.
Packit 7cfc04
.SH "SEE ALSO"
Packit 7cfc04
.IR "\fIisgreater\fR\^(\|)",
Packit 7cfc04
.IR "\fIisless\fR\^(\|)",
Packit 7cfc04
.IR "\fIislessequal\fR\^(\|)",
Packit 7cfc04
.IR "\fIislessgreater\fR\^(\|)",
Packit 7cfc04
.IR "\fIisunordered\fR\^(\|)"
Packit 7cfc04
.P
Packit 7cfc04
The Base Definitions volume of POSIX.1\(hy2008,
Packit 7cfc04
.IR "\fB<math.h>\fP"
Packit 7cfc04
.SH COPYRIGHT
Packit 7cfc04
Portions of this text are reprinted and reproduced in electronic form
Packit 7cfc04
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
Packit 7cfc04
-- Portable Operating System Interface (POSIX), The Open Group Base
Packit 7cfc04
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Packit 7cfc04
Electrical and Electronics Engineers, Inc and The Open Group.
Packit 7cfc04
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
Packit 7cfc04
event of any discrepancy between this version and the original IEEE and
Packit 7cfc04
The Open Group Standard, the original IEEE and The Open Group Standard
Packit 7cfc04
is the referee document. The original Standard can be obtained online at
Packit 7cfc04
http://www.unix.org/online.html .
Packit 7cfc04
Packit 7cfc04
Any typographical or formatting errors that appear
Packit 7cfc04
in this page are most likely
Packit 7cfc04
to have been introduced during the conversion of the source files to
Packit 7cfc04
man page format. To report such errors, see
Packit 7cfc04
https://www.kernel.org/doc/man-pages/reporting_bugs.html .