aboutsummaryrefslogtreecommitdiff
path: root/newlib/libm/common/isgreater.c
diff options
context:
space:
mode:
authorJeff Johnston <jjohnstn@redhat.com>2009-03-25 19:13:24 +0000
committerJeff Johnston <jjohnstn@redhat.com>2009-03-25 19:13:24 +0000
commit139f923bb4564fb021dce2b7ae460a3d8e3bb87d (patch)
tree96c1d8794c6828033a418bce8d8f1cc6eccba037 /newlib/libm/common/isgreater.c
parentbaea11cd6a53ccde63b5fefa4c7ae2b5426a668d (diff)
downloadnewlib-139f923bb4564fb021dce2b7ae460a3d8e3bb87d.zip
newlib-139f923bb4564fb021dce2b7ae460a3d8e3bb87d.tar.gz
newlib-139f923bb4564fb021dce2b7ae460a3d8e3bb87d.tar.bz2
2009-03-25 Craig Howland <howland@LGSInnovations.com>
* libc/include/math.h: (llround, llroundf): Declare. * libm/common/s_llround.c: New file, implementing llround(). * libm/common/sf_llround.c: New file, implementing llroundf(). * libm/common/sf_lround.c: Remove spurious cast in _DOUBLE_IS_32BITS version of function. * libm/common/sf_lrint.c: Ditto. * libm/common/sf_logb.c: Corrected return for subnormal argument by replacing existing function with a version created from sf_ilogb.c. * libm/common/s_logb.c: Ditto, except starting point s_ilogb.c. Also added documentation for logb() and logbf(). * libm/common/s_signbit.c: Add signbit() documentation. * libm/common/s_log2.c: Update return values to match what w_log2.c has, since log2 uses log(); add note about being derived instead of direct. * libm/common/sf_fma.c: Add casts to attempt to get correct results, as well as comments pointing out problems with the implementation. * libm/common/s_fma.c: Add fma() and fmaf() documentation. * libm/common/sf_remquo.c: Incorrect quotient returns for large values corrected by discarding existing function and replacing with Sun verion, with some enhancements. * libm/common/s_remquo.c: Ditto. Add remquo() and remquof() documentation. * libm/common/s_fmax.c: Add fmax() and fmaxf() documentation. * libm/common/s_fmin.c: Add fmin() and fminf() documentation. * libm/common/s_fdim.c: Return NAN for NAN arg, add fdim() and fdimf() documentation. * libm/common/sf_fdim.c: Return NAN for NAN arg, HUGE_VALF for inf arg. * libm/common/s_trunc.c: Add trunc() and truncf() documentation. * libm/common/s_rint.c: Add rint() and rintf() documentation. * libm/common/s_round.c: Add round() and roundf() documentation. * libm/common/s_scalbn.c: Add scalbln() and scalblnf() documentation. * libm/common/s_infinity.c: Add infinity() and infinityf() documentation. * libm/common/s_lround.c: Add lround(), lroundf(), llround(), and llroundf() documentation. * libm/common/s_lrint.c: Add lrint(), lrintf(), llrint(), and llrintf() documentation. * libm/common/isgreater.c: New file for documenting math.h function-like macros isgreater(), isgreaterequal(), isless(), islessequal(), islessgreater(), and isunordered(). * libm/common/s_isnan.c: Add documentation for function-like macros fpclassify(), isfinite(), isinf(), isnan(), and isnormal(). * libm/common/s_nearbyint.c: Add nearbyint() and nearbyintf() documentation. * libm/common/Makefile.am: Add s_llround.c (src); sf_llround.c (fsrc); s_fdim.def, s_fma.def, s_fmax.def, s_fmin.def, s_logb.def, s_lrint.def, s_lround.def, s_nearbyint.def, s_remquo.def, s_rint.def, s_round.def, s_signbit.def, s_trunc.def, and isgreater.def (chobj); re-name all existing chew files (chobj) to match source file base names (put in underscores), delete all special targets for chew files (leaving all to be generated by rule). * libm/common/Makefile.in: regenerate. * libm/math/w_exp2.c: Add "base 2" to documentation description (and delete TRAD_SYNOPSIS). * libm/math/w_gamma.c: Add tgamma() and tgammaf() documentation, along with some history behind the function names. * libm/math/math.tex: Add includes for newly-added documentation (see .def additions to common/Makefile.am and math/Makefile.am in this ChangeLog list), adjusted existing .def file names to match source file base names (added underscores); add mention of HUGE_VALF; rename "Version of library" section to "Error Handling" and add some text about floating-point exception; added section "Standards Compliance And Portability". * libm/math/Makefile.am: Add w_exp2.def (chobj); re-name all existing chew files (chobj) to match source file base names, delete all special targets for chew files (leaving all to be generated by rule). * libm/math/Makefile.in: regenerated * doc/makedoc.c: Change silent ignoring of commands < 5 characters to a failure when reading macro file for commands < 4 characters; add -v (verbose) option for printing some debugging information; get rid of spurious translation of "@*" to "*" (no source files used @*, so no existing doc pages were affected); clean up some compiler warnings. * doc/doc.str: add BUGS and SEEALSO sections (to match texi2pod.pl which has them); Remove ITEM command (redundant with makedoc built-in "o", not used in any present source file so nothing is lost, anyway). * HOWTO: New file to hold information for maintainers regarding how to do things. Initial sections on documentation and ELIX levels.
Diffstat (limited to 'newlib/libm/common/isgreater.c')
-rw-r--r--newlib/libm/common/isgreater.c75
1 files changed, 75 insertions, 0 deletions
diff --git a/newlib/libm/common/isgreater.c b/newlib/libm/common/isgreater.c
new file mode 100644
index 0000000..bd4e95e
--- /dev/null
+++ b/newlib/libm/common/isgreater.c
@@ -0,0 +1,75 @@
+/* isgreater.c: This file contains no source code, but rather only the
+ * man-page comments. All of the documented "functions" are actually macros
+ * defined in math.h (q.v.). */
+/*
+FUNCTION
+<<isgreater>>, <<isgreaterequal>>, <<isless>>, <<islessequal>>, <<islessgreater>>, and <<isunordered>>--comparison macros
+INDEX
+ isgreater
+INDEX
+ isgreaterequal
+INDEX
+ isless
+INDEX
+ islessequal
+INDEX
+ islessgreater
+INDEX
+ isunordered
+
+ANSI_SYNOPSIS
+ #include <math.h>
+ int isgreater(real-floating <[x]>, real-floating <[y]>);
+ int isgreaterequal(real-floating <[x]>, real-floating <[y]>);
+ int isless(real-floating <[x]>, real-floating <[y]>);
+ int islessequal(real-floating <[x]>, real-floating <[y]>);
+ int islessgreater(real-floating <[x]>, real-floating <[y]>);
+ int isunordered(real-floating <[x]>, real-floating <[y]>);
+
+DESCRIPTION
+<<isgreater>>, <<isgreaterequal>>, <<isless>>, <<islessequal>>,
+<<islessgreater>>, and <<isunordered>> are macros defined for use in
+comparing floating-point numbers without raising any floating-point
+exceptions.
+
+The relational operators (i.e. <, >, <=, and >=) support the usual mathematical
+relationships between numeric values. For any ordered pair of numeric
+values exactly one of the relationships--less, greater, and equal--is
+true. Relational operators may raise the "invalid" floating-point
+exception when argument values are NaNs. For a NaN and a numeric value, or
+for two NaNs, just the unordered relationship is true (i.e., if one or both
+of the arguments a NaN, the relationship is called unordered). The specified
+macros are quiet (non floating-point exception raising) versions of the
+relational operators, and other comparison macros that facilitate writing
+efficient code that accounts for NaNs without suffering the "invalid"
+floating-point exception. In the synopses shown, "real-floating" indicates
+that the argument is an expression of real floating type.
+
+Please note that saying that the macros do not raise floating-point
+exceptions, it is referring to the function that they are performing. It
+is certainly possible to give them an expression which causes an exception.
+For example:
+o+
+o NaN < 1.0
+ causes an "invalid" exception,
+o isless(NaN, 1.0)
+ does not, and
+o isless(NaN*0., 1.0)
+ causes an exception due to the "NaN*0.", but not from the
+resultant reduced comparison of isless(NaN, 1.0).
+o-
+
+RETURNS
+@comment Formatting note: "$@" forces a new line
+No floating-point exceptions are raised for any of the macros.@*
+The <<isgreater>> macro returns the value of (x) > (y).@*
+The <<isgreaterequal>> macro returns the value of (x) >= (y).@*
+The <<isless>> macro returns the value of (x) < (y).@*
+The <<islessequal>> macro returns the value of (x) <= (y).@*
+The <<islessgreater>> macro returns the value of (x) < (y) || (x) > (y).@*
+The <<isunordered>> macro returns 1 if either of its arguments is NaN and 0 otherwise.
+
+PORTABILITY
+C99, POSIX.
+
+*/