1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at 
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH isgreaterequal 3M "12 Jul 2006" "SunOS 5.11" "Mathematical Library Functions"
  12 .SH NAME
  13 isgreaterequal \- test if x greater than or equal to y
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  18 #include <math.h>
  19 
  20 \fBint\fR \fBisgreaterequal\fR(\fBreal-floating\fR \fIx\fR, \fBreal-floating\fR \fIy\fR);
  21 .fi
  22 
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBisgreaterequal()\fR macro determines whether its first argument is
  27 greater than or equal to its second argument. The value of
  28 \fBisgreaterequal\fR(\fIx\fR, \fIy\fR) is equal to (\fIx\fR) \(>= (\fIy\fR);
  29 however, unlike (\fIx\fR) \(>= (\fIy\fR), \fBisgreaterequal\fR(\fIx\fR,
  30 \fIy\fR) does not raise the invalid floating-point exception when \fIx\fR and
  31 \fIy\fR are unordered.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 Upon successful completion, the \fBisgreaterequal()\fR macro returns the value
  36 of (\fIx\fR) \(>= (\fIy\fR).
  37 .sp
  38 .LP
  39 If \fIx\fR or \fIy\fR is NaN, 0 is returned.
  40 .SH ERRORS
  41 .sp
  42 .LP
  43 No errors are defined.
  44 .SH USAGE
  45 .sp
  46 .LP
  47 The relational and equality operators support the usual mathematical
  48 relationships between numeric values. For any ordered pair of numeric values,
  49 exactly one of the relationships (less, greater, and equal) is true. Relational
  50 operators can raise the invalid floating-point exception when argument values
  51 are NaNs. For a NaN and a numeric value, or for two NaNs, just the unordered
  52 relationship is true. This macro is a quiet (non-floating-point exception
  53 raising) version of a relational operator. It facilitates writing efficient
  54 code that accounts for quiet NaNs without suffering the invalid floating-point
  55 exception. In the \fBSYNOPSIS\fR section, \fBreal-floating\fR indicates that
  56 the argument is an expression of \fBreal-floating\fR type.
  57 .SH ATTRIBUTES
  58 .sp
  59 .LP
  60 See \fBattributes\fR(5) for descriptions of the following attributes:
  61 .sp
  62 
  63 .sp
  64 .TS
  65 tab() box;
  66 cw(2.75i) |cw(2.75i) 
  67 lw(2.75i) |lw(2.75i) 
  68 .
  69 ATTRIBUTE TYPEATTRIBUTE VALUE
  70 _
  71 Interface StabilityStandard
  72 _
  73 MT-LevelMT-Safe
  74 .TE
  75 
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBisgreater\fR(3M), \fBisless\fR(3M), \fBislessequal\fR(3M),
  80 \fBislessgreater\fR(3M), \fBisunordered\fR(3M), \fBmath.h\fR(3HEAD),
  81 \fBattributes\fR(5), \fBstandards\fR(5)