Make floatingPointIsFinite() return int. Fix comment about comparisons and IEEE NaN.

2 files changed, 13 insertions, 5 deletions

diff --git a/ChangeLog b/ChangeLog
index 7e47be2..3225141 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2007-03-04  Steve M. Robbins  <smr@sumost.ca>
+
+	* include/cppunit/portability/FloatingPoint.h (floatingPointIsFinite): Change
+	return type to int, following the convention of isfinite(), finite(), etc.
+
 2007-02-25  Baptiste Lepilleur <blep@users.sourceforge.net>
 
    * doc/cookbook.dox: changed suite() to return a TestSuite instead
diff --git a/include/cppunit/portability/FloatingPoint.h b/include/cppunit/portability/FloatingPoint.h
index 584c433..e8c91b3 100644
--- a/include/cppunit/portability/FloatingPoint.h
+++ b/include/cppunit/portability/FloatingPoint.h
@@ -7,8 +7,11 @@
 CPPUNIT_NS_BEGIN
 
 /// \brief Tests if a floating-point is a NaN.
-// According to IEEE-754 floating point standard, NaN comparison should always
-// be 'false'. 
+// According to IEEE-754 floating point standard, 
+// (see e.g. page 8 of
+// http://www.cs.berkeley.edu/~wkahan/ieee754status/ieee754.ps) 
+// all comparisons with NaN are false except "x != x", which is true.
+//
 // At least Microsoft Visual Studio 6 is known not to implement this test correctly.
 // It emits the following code to test equality:
 //  fcomp       qword ptr [nan]
@@ -32,12 +35,12 @@ inline bool floatingPointIsUnordered( double x )
 
 /// \brief Tests if a floating-point is finite.
 /// @return \c true if x is neither a NaN, nor +inf, nor -inf, \c false otherwise.
-inline bool floatingPointIsFinite( double x )
+inline int floatingPointIsFinite( double x )
 {
 #if defined(CPPUNIT_HAVE_ISFINITE)
-   return (bool)isfinite( x );
+   return isfinite( x );
 #elif defined(CPPUNIT_HAVE_FINITE)
-   return (bool)finite( x );
+   return finite( x );
 #elif defined(CPPUNIT_HAVE__FINITE)
    return _finite(x);
 #else