share/man/man3m/isgreaterequal.3m

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