Blame trionan.c

Packit 423ecb
/*************************************************************************
Packit 423ecb
 *
Packit 423ecb
 * $Id$
Packit 423ecb
 *
Packit 423ecb
 * Copyright (C) 2001 Bjorn Reese <breese@users.sourceforge.net>
Packit 423ecb
 *
Packit 423ecb
 * Permission to use, copy, modify, and distribute this software for any
Packit 423ecb
 * purpose with or without fee is hereby granted, provided that the above
Packit 423ecb
 * copyright notice and this permission notice appear in all copies.
Packit 423ecb
 *
Packit 423ecb
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
Packit 423ecb
 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
Packit 423ecb
 * MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE AUTHORS AND
Packit 423ecb
 * CONTRIBUTORS ACCEPT NO RESPONSIBILITY IN ANY CONCEIVABLE MANNER.
Packit 423ecb
 *
Packit 423ecb
 ************************************************************************
Packit 423ecb
 *
Packit 423ecb
 * Functions to handle special quantities in floating-point numbers
Packit 423ecb
 * (that is, NaNs and infinity). They provide the capability to detect
Packit 423ecb
 * and fabricate special quantities.
Packit 423ecb
 *
Packit 423ecb
 * Although written to be as portable as possible, it can never be
Packit 423ecb
 * guaranteed to work on all platforms, as not all hardware supports
Packit 423ecb
 * special quantities.
Packit 423ecb
 *
Packit 423ecb
 * The approach used here (approximately) is to:
Packit 423ecb
 *
Packit 423ecb
 *   1. Use C99 functionality when available.
Packit 423ecb
 *   2. Use IEEE 754 bit-patterns if possible.
Packit 423ecb
 *   3. Use platform-specific techniques.
Packit 423ecb
 *
Packit 423ecb
 ************************************************************************/
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * TODO:
Packit 423ecb
 *  o Put all the magic into trio_fpclassify_and_signbit(), and use this from
Packit 423ecb
 *    trio_isnan() etc.
Packit 423ecb
 */
Packit 423ecb
Packit 423ecb
/*************************************************************************
Packit 423ecb
 * Include files
Packit 423ecb
 */
Packit 423ecb
#include "triodef.h"
Packit 423ecb
#include "trionan.h"
Packit 423ecb
Packit 423ecb
#include <math.h>
Packit 423ecb
#include <string.h>
Packit 423ecb
#include <limits.h>
Packit 423ecb
#include <float.h>
Packit 423ecb
#if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
# include <signal.h>
Packit 423ecb
#endif
Packit 423ecb
#if defined(TRIO_COMPILER_DECC)
Packit 423ecb
#  if defined(__linux__)
Packit 423ecb
#   include <cpml.h>
Packit 423ecb
#  else
Packit 423ecb
#   include <fp_class.h>
Packit 423ecb
#  endif
Packit 423ecb
#endif
Packit 423ecb
#include <assert.h>
Packit 423ecb
Packit 423ecb
#if defined(TRIO_DOCUMENTATION)
Packit 423ecb
# include "doc/doc_nan.h"
Packit 423ecb
#endif
Packit 423ecb
/** @addtogroup SpecialQuantities
Packit 423ecb
    @{
Packit 423ecb
*/
Packit 423ecb
Packit 423ecb
/*************************************************************************
Packit 423ecb
 * Definitions
Packit 423ecb
 */
Packit 423ecb
Packit 423ecb
#define TRIO_TRUE (1 == 1)
Packit 423ecb
#define TRIO_FALSE (0 == 1)
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * We must enable IEEE floating-point on Alpha
Packit 423ecb
 */
Packit 423ecb
#if defined(__alpha) && !defined(_IEEE_FP)
Packit 423ecb
# if defined(TRIO_COMPILER_DECC)
Packit 423ecb
#  if defined(TRIO_PLATFORM_VMS)
Packit 423ecb
#   error "Must be compiled with option /IEEE_MODE=UNDERFLOW_TO_ZERO/FLOAT=IEEE"
Packit 423ecb
#  else
Packit 423ecb
#   if !defined(_CFE)
Packit 423ecb
#    error "Must be compiled with option -ieee"
Packit 423ecb
#   endif
Packit 423ecb
#  endif
Packit 423ecb
# elif defined(TRIO_COMPILER_GCC) && (defined(__osf__) || defined(__linux__))
Packit 423ecb
#  error "Must be compiled with option -mieee"
Packit 423ecb
# endif
Packit 423ecb
#endif /* __alpha && ! _IEEE_FP */
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * In ANSI/IEEE 754-1985 64-bits double format numbers have the
Packit 423ecb
 * following properties (amoungst others)
Packit 423ecb
 *
Packit 423ecb
 *   o FLT_RADIX == 2: binary encoding
Packit 423ecb
 *   o DBL_MAX_EXP == 1024: 11 bits exponent, where one bit is used
Packit 423ecb
 *     to indicate special numbers (e.g. NaN and Infinity), so the
Packit 423ecb
 *     maximum exponent is 10 bits wide (2^10 == 1024).
Packit 423ecb
 *   o DBL_MANT_DIG == 53: The mantissa is 52 bits wide, but because
Packit 423ecb
 *     numbers are normalized the initial binary 1 is represented
Packit 423ecb
 *     implicitly (the so-called "hidden bit"), which leaves us with
Packit 423ecb
 *     the ability to represent 53 bits wide mantissa.
Packit 423ecb
 */
Packit 423ecb
#if (FLT_RADIX == 2) && (DBL_MAX_EXP == 1024) && (DBL_MANT_DIG == 53)
Packit 423ecb
# define USE_IEEE_754
Packit 423ecb
#endif
Packit 423ecb
Packit 423ecb
Packit 423ecb
/*************************************************************************
Packit 423ecb
 * Constants
Packit 423ecb
 */
Packit 423ecb
Packit 423ecb
static TRIO_CONST char rcsid[] = "@(#)$Id$";
Packit 423ecb
Packit 423ecb
#if defined(USE_IEEE_754)
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * Endian-agnostic indexing macro.
Packit 423ecb
 *
Packit 423ecb
 * The value of internalEndianMagic, when converted into a 64-bit
Packit 423ecb
 * integer, becomes 0x0706050403020100 (we could have used a 64-bit
Packit 423ecb
 * integer value instead of a double, but not all platforms supports
Packit 423ecb
 * that type). The value is automatically encoded with the correct
Packit 423ecb
 * endianess by the compiler, which means that we can support any
Packit 423ecb
 * kind of endianess. The individual bytes are then used as an index
Packit 423ecb
 * for the IEEE 754 bit-patterns and masks.
Packit 423ecb
 */
Packit 423ecb
#define TRIO_DOUBLE_INDEX(x) (((unsigned char *)&internalEndianMagic)[7-(x)])
Packit 423ecb
Packit 423ecb
#if (defined(__BORLANDC__) && __BORLANDC__ >= 0x0590)
Packit 423ecb
static TRIO_CONST double internalEndianMagic = 7.949928895127362e-275;
Packit 423ecb
#else
Packit 423ecb
static TRIO_CONST double internalEndianMagic = 7.949928895127363e-275;
Packit 423ecb
#endif
Packit 423ecb
Packit 423ecb
/* Mask for the exponent */
Packit 423ecb
static TRIO_CONST unsigned char ieee_754_exponent_mask[] = {
Packit 423ecb
  0x7F, 0xF0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
Packit 423ecb
};
Packit 423ecb
Packit 423ecb
/* Mask for the mantissa */
Packit 423ecb
static TRIO_CONST unsigned char ieee_754_mantissa_mask[] = {
Packit 423ecb
  0x00, 0x0F, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
Packit 423ecb
};
Packit 423ecb
Packit 423ecb
/* Mask for the sign bit */
Packit 423ecb
static TRIO_CONST unsigned char ieee_754_sign_mask[] = {
Packit 423ecb
  0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
Packit 423ecb
};
Packit 423ecb
Packit 423ecb
/* Bit-pattern for negative zero */
Packit 423ecb
static TRIO_CONST unsigned char ieee_754_negzero_array[] = {
Packit 423ecb
  0x80, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
Packit 423ecb
};
Packit 423ecb
Packit 423ecb
/* Bit-pattern for infinity */
Packit 423ecb
static TRIO_CONST unsigned char ieee_754_infinity_array[] = {
Packit 423ecb
  0x7F, 0xF0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
Packit 423ecb
};
Packit 423ecb
Packit 423ecb
/* Bit-pattern for quiet NaN */
Packit 423ecb
static TRIO_CONST unsigned char ieee_754_qnan_array[] = {
Packit 423ecb
  0x7F, 0xF8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
Packit 423ecb
};
Packit 423ecb
Packit 423ecb
Packit 423ecb
/*************************************************************************
Packit 423ecb
 * Functions
Packit 423ecb
 */
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * trio_make_double
Packit 423ecb
 */
Packit 423ecb
TRIO_PRIVATE double
Packit 423ecb
trio_make_double
Packit 423ecb
TRIO_ARGS1((values),
Packit 423ecb
	   TRIO_CONST unsigned char *values)
Packit 423ecb
{
Packit 423ecb
  TRIO_VOLATILE double result;
Packit 423ecb
  int i;
Packit 423ecb
Packit 423ecb
  for (i = 0; i < (int)sizeof(double); i++) {
Packit 423ecb
    ((TRIO_VOLATILE unsigned char *)&result)[TRIO_DOUBLE_INDEX(i)] = values[i];
Packit 423ecb
  }
Packit 423ecb
  return result;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * trio_is_special_quantity
Packit 423ecb
 */
Packit 423ecb
TRIO_PRIVATE int
Packit 423ecb
trio_is_special_quantity
Packit 423ecb
TRIO_ARGS2((number, has_mantissa),
Packit 423ecb
	   double number,
Packit 423ecb
	   int *has_mantissa)
Packit 423ecb
{
Packit 423ecb
  unsigned int i;
Packit 423ecb
  unsigned char current;
Packit 423ecb
  int is_special_quantity = TRIO_TRUE;
Packit 423ecb
Packit 423ecb
  *has_mantissa = 0;
Packit 423ecb
Packit 423ecb
  for (i = 0; i < (unsigned int)sizeof(double); i++) {
Packit 423ecb
    current = ((unsigned char *)&number)[TRIO_DOUBLE_INDEX(i)];
Packit 423ecb
    is_special_quantity
Packit 423ecb
      &= ((current & ieee_754_exponent_mask[i]) == ieee_754_exponent_mask[i]);
Packit 423ecb
    *has_mantissa |= (current & ieee_754_mantissa_mask[i]);
Packit 423ecb
  }
Packit 423ecb
  return is_special_quantity;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * trio_is_negative
Packit 423ecb
 */
Packit 423ecb
TRIO_PRIVATE int
Packit 423ecb
trio_is_negative
Packit 423ecb
TRIO_ARGS1((number),
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
  unsigned int i;
Packit 423ecb
  int is_negative = TRIO_FALSE;
Packit 423ecb
Packit 423ecb
  for (i = 0; i < (unsigned int)sizeof(double); i++) {
Packit 423ecb
    is_negative |= (((unsigned char *)&number)[TRIO_DOUBLE_INDEX(i)]
Packit 423ecb
		    & ieee_754_sign_mask[i]);
Packit 423ecb
  }
Packit 423ecb
  return is_negative;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
#endif /* USE_IEEE_754 */
Packit 423ecb
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Generate negative zero.
Packit 423ecb
Packit 423ecb
   @return Floating-point representation of negative zero.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC double
Packit 423ecb
trio_nzero(TRIO_NOARGS)
Packit 423ecb
{
Packit 423ecb
#if defined(USE_IEEE_754)
Packit 423ecb
  return trio_make_double(ieee_754_negzero_array);
Packit 423ecb
#else
Packit 423ecb
  TRIO_VOLATILE double zero = 0.0;
Packit 423ecb
Packit 423ecb
  return -zero;
Packit 423ecb
#endif
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Generate positive infinity.
Packit 423ecb
Packit 423ecb
   @return Floating-point representation of positive infinity.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC double
Packit 423ecb
trio_pinf(TRIO_NOARGS)
Packit 423ecb
{
Packit 423ecb
  /* Cache the result */
Packit 423ecb
  static double result = 0.0;
Packit 423ecb
Packit 423ecb
  if (result == 0.0) {
Packit 423ecb
Packit 423ecb
#if defined(INFINITY) && defined(__STDC_IEC_559__)
Packit 423ecb
    result = (double)INFINITY;
Packit 423ecb
Packit 423ecb
#elif defined(USE_IEEE_754)
Packit 423ecb
    result = trio_make_double(ieee_754_infinity_array);
Packit 423ecb
Packit 423ecb
#else
Packit 423ecb
    /*
Packit 423ecb
     * If HUGE_VAL is different from DBL_MAX, then HUGE_VAL is used
Packit 423ecb
     * as infinity. Otherwise we have to resort to an overflow
Packit 423ecb
     * operation to generate infinity.
Packit 423ecb
     */
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
    void (*signal_handler)(int) = signal(SIGFPE, SIG_IGN);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
    result = HUGE_VAL;
Packit 423ecb
    if (HUGE_VAL == DBL_MAX) {
Packit 423ecb
      /* Force overflow */
Packit 423ecb
      result += HUGE_VAL;
Packit 423ecb
    }
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
    signal(SIGFPE, signal_handler);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
  }
Packit 423ecb
  return result;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Generate negative infinity.
Packit 423ecb
Packit 423ecb
   @return Floating-point value of negative infinity.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC double
Packit 423ecb
trio_ninf(TRIO_NOARGS)
Packit 423ecb
{
Packit 423ecb
  static double result = 0.0;
Packit 423ecb
Packit 423ecb
  if (result == 0.0) {
Packit 423ecb
    /*
Packit 423ecb
     * Negative infinity is calculated by negating positive infinity,
Packit 423ecb
     * which can be done because it is legal to do calculations on
Packit 423ecb
     * infinity (for example,  1 / infinity == 0).
Packit 423ecb
     */
Packit 423ecb
    result = -trio_pinf();
Packit 423ecb
  }
Packit 423ecb
  return result;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Generate NaN.
Packit 423ecb
Packit 423ecb
   @return Floating-point representation of NaN.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC double
Packit 423ecb
trio_nan(TRIO_NOARGS)
Packit 423ecb
{
Packit 423ecb
  /* Cache the result */
Packit 423ecb
  static double result = 0.0;
Packit 423ecb
Packit 423ecb
  if (result == 0.0) {
Packit 423ecb
Packit 423ecb
#if defined(TRIO_COMPILER_SUPPORTS_C99)
Packit 423ecb
    result = nan("");
Packit 423ecb
Packit 423ecb
#elif defined(NAN) && defined(__STDC_IEC_559__)
Packit 423ecb
    result = (double)NAN;
Packit 423ecb
Packit 423ecb
#elif defined(USE_IEEE_754)
Packit 423ecb
    result = trio_make_double(ieee_754_qnan_array);
Packit 423ecb
Packit 423ecb
#else
Packit 423ecb
    /*
Packit 423ecb
     * There are several ways to generate NaN. The one used here is
Packit 423ecb
     * to divide infinity by infinity. I would have preferred to add
Packit 423ecb
     * negative infinity to positive infinity, but that yields wrong
Packit 423ecb
     * result (infinity) on FreeBSD.
Packit 423ecb
     *
Packit 423ecb
     * This may fail if the hardware does not support NaN, or if
Packit 423ecb
     * the Invalid Operation floating-point exception is unmasked.
Packit 423ecb
     */
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
    void (*signal_handler)(int) = signal(SIGFPE, SIG_IGN);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
    result = trio_pinf() / trio_pinf();
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
    signal(SIGFPE, signal_handler);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
  }
Packit 423ecb
  return result;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Check for NaN.
Packit 423ecb
Packit 423ecb
   @param number An arbitrary floating-point number.
Packit 423ecb
   @return Boolean value indicating whether or not the number is a NaN.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC int
Packit 423ecb
trio_isnan
Packit 423ecb
TRIO_ARGS1((number),
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
#if (defined(TRIO_COMPILER_SUPPORTS_C99) && defined(isnan)) \
Packit 423ecb
 || defined(TRIO_COMPILER_SUPPORTS_UNIX95)
Packit 423ecb
  /*
Packit 423ecb
   * C99 defines isnan() as a macro. UNIX95 defines isnan() as a
Packit 423ecb
   * function. This function was already present in XPG4, but this
Packit 423ecb
   * is a bit tricky to detect with compiler defines, so we choose
Packit 423ecb
   * the conservative approach and only use it for UNIX95.
Packit 423ecb
   */
Packit 423ecb
  return isnan(number);
Packit 423ecb
Packit 423ecb
#elif defined(TRIO_COMPILER_MSVC) || defined(TRIO_COMPILER_BCB)
Packit 423ecb
  /*
Packit 423ecb
   * Microsoft Visual C++ and Borland C++ Builder have an _isnan()
Packit 423ecb
   * function.
Packit 423ecb
   */
Packit 423ecb
  return _isnan(number) ? TRIO_TRUE : TRIO_FALSE;
Packit 423ecb
Packit 423ecb
#elif defined(USE_IEEE_754)
Packit 423ecb
  /*
Packit 423ecb
   * Examine IEEE 754 bit-pattern. A NaN must have a special exponent
Packit 423ecb
   * pattern, and a non-empty mantissa.
Packit 423ecb
   */
Packit 423ecb
  int has_mantissa;
Packit 423ecb
  int is_special_quantity;
Packit 423ecb
Packit 423ecb
  is_special_quantity = trio_is_special_quantity(number, &has_mantissa);
Packit 423ecb
Packit 423ecb
  return (is_special_quantity && has_mantissa);
Packit 423ecb
Packit 423ecb
#else
Packit 423ecb
  /*
Packit 423ecb
   * Fallback solution
Packit 423ecb
   */
Packit 423ecb
  int status;
Packit 423ecb
  double integral, fraction;
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  void (*signal_handler)(int) = signal(SIGFPE, SIG_IGN);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  status = (/*
Packit 423ecb
	     * NaN is the only number which does not compare to itself
Packit 423ecb
	     */
Packit 423ecb
	    ((TRIO_VOLATILE double)number != (TRIO_VOLATILE double)number) ||
Packit 423ecb
	    /*
Packit 423ecb
	     * Fallback solution if NaN compares to NaN
Packit 423ecb
	     */
Packit 423ecb
	    ((number != 0.0) &&
Packit 423ecb
	     (fraction = modf(number, &integral),
Packit 423ecb
	      integral == fraction)));
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  signal(SIGFPE, signal_handler);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  return status;
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Check for infinity.
Packit 423ecb
Packit 423ecb
   @param number An arbitrary floating-point number.
Packit 423ecb
   @return 1 if positive infinity, -1 if negative infinity, 0 otherwise.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC int
Packit 423ecb
trio_isinf
Packit 423ecb
TRIO_ARGS1((number),
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
#if defined(TRIO_COMPILER_DECC) && !defined(__linux__)
Packit 423ecb
  /*
Packit 423ecb
   * DECC has an isinf() macro, but it works differently than that
Packit 423ecb
   * of C99, so we use the fp_class() function instead.
Packit 423ecb
   */
Packit 423ecb
  return ((fp_class(number) == FP_POS_INF)
Packit 423ecb
	  ? 1
Packit 423ecb
	  : ((fp_class(number) == FP_NEG_INF) ? -1 : 0));
Packit 423ecb
Packit 423ecb
#elif defined(isinf)
Packit 423ecb
  /*
Packit 423ecb
   * C99 defines isinf() as a macro.
Packit 423ecb
   */
Packit 423ecb
  return isinf(number)
Packit 423ecb
    ? ((number > 0.0) ? 1 : -1)
Packit 423ecb
    : 0;
Packit 423ecb
Packit 423ecb
#elif defined(TRIO_COMPILER_MSVC) || defined(TRIO_COMPILER_BCB)
Packit 423ecb
  /*
Packit 423ecb
   * Microsoft Visual C++ and Borland C++ Builder have an _fpclass()
Packit 423ecb
   * function that can be used to detect infinity.
Packit 423ecb
   */
Packit 423ecb
  return ((_fpclass(number) == _FPCLASS_PINF)
Packit 423ecb
	  ? 1
Packit 423ecb
	  : ((_fpclass(number) == _FPCLASS_NINF) ? -1 : 0));
Packit 423ecb
Packit 423ecb
#elif defined(USE_IEEE_754)
Packit 423ecb
  /*
Packit 423ecb
   * Examine IEEE 754 bit-pattern. Infinity must have a special exponent
Packit 423ecb
   * pattern, and an empty mantissa.
Packit 423ecb
   */
Packit 423ecb
  int has_mantissa;
Packit 423ecb
  int is_special_quantity;
Packit 423ecb
Packit 423ecb
  is_special_quantity = trio_is_special_quantity(number, &has_mantissa);
Packit 423ecb
Packit 423ecb
  return (is_special_quantity && !has_mantissa)
Packit 423ecb
    ? ((number < 0.0) ? -1 : 1)
Packit 423ecb
    : 0;
Packit 423ecb
Packit 423ecb
#else
Packit 423ecb
  /*
Packit 423ecb
   * Fallback solution.
Packit 423ecb
   */
Packit 423ecb
  int status;
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  void (*signal_handler)(int) = signal(SIGFPE, SIG_IGN);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  double infinity = trio_pinf();
Packit 423ecb
Packit 423ecb
  status = ((number == infinity)
Packit 423ecb
	    ? 1
Packit 423ecb
	    : ((number == -infinity) ? -1 : 0));
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  signal(SIGFPE, signal_handler);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  return status;
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
#if 0
Packit 423ecb
	/* Temporary fix - this routine is not used anywhere */
Packit 423ecb
/**
Packit 423ecb
   Check for finity.
Packit 423ecb
Packit 423ecb
   @param number An arbitrary floating-point number.
Packit 423ecb
   @return Boolean value indicating whether or not the number is a finite.
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC int
Packit 423ecb
trio_isfinite
Packit 423ecb
TRIO_ARGS1((number),
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
#if defined(TRIO_COMPILER_SUPPORTS_C99) && defined(isfinite)
Packit 423ecb
  /*
Packit 423ecb
   * C99 defines isfinite() as a macro.
Packit 423ecb
   */
Packit 423ecb
  return isfinite(number);
Packit 423ecb
Packit 423ecb
#elif defined(TRIO_COMPILER_MSVC) || defined(TRIO_COMPILER_BCB)
Packit 423ecb
  /*
Packit 423ecb
   * Microsoft Visual C++ and Borland C++ Builder use _finite().
Packit 423ecb
   */
Packit 423ecb
  return _finite(number);
Packit 423ecb
Packit 423ecb
#elif defined(USE_IEEE_754)
Packit 423ecb
  /*
Packit 423ecb
   * Examine IEEE 754 bit-pattern. For finity we do not care about the
Packit 423ecb
   * mantissa.
Packit 423ecb
   */
Packit 423ecb
  int dummy;
Packit 423ecb
Packit 423ecb
  return (! trio_is_special_quantity(number, &dummy));
Packit 423ecb
Packit 423ecb
#else
Packit 423ecb
  /*
Packit 423ecb
   * Fallback solution.
Packit 423ecb
   */
Packit 423ecb
  return ((trio_isinf(number) == 0) && (trio_isnan(number) == 0));
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
Packit 423ecb
/*
Packit 423ecb
 * The sign of NaN is always false
Packit 423ecb
 */
Packit 423ecb
TRIO_PUBLIC int
Packit 423ecb
trio_fpclassify_and_signbit
Packit 423ecb
TRIO_ARGS2((number, is_negative),
Packit 423ecb
	   double number,
Packit 423ecb
	   int *is_negative)
Packit 423ecb
{
Packit 423ecb
#if defined(fpclassify) && defined(signbit)
Packit 423ecb
  /*
Packit 423ecb
   * C99 defines fpclassify() and signbit() as a macros
Packit 423ecb
   */
Packit 423ecb
  *is_negative = signbit(number);
Packit 423ecb
  switch (fpclassify(number)) {
Packit 423ecb
  case FP_NAN:
Packit 423ecb
    return TRIO_FP_NAN;
Packit 423ecb
  case FP_INFINITE:
Packit 423ecb
    return TRIO_FP_INFINITE;
Packit 423ecb
  case FP_SUBNORMAL:
Packit 423ecb
    return TRIO_FP_SUBNORMAL;
Packit 423ecb
  case FP_ZERO:
Packit 423ecb
    return TRIO_FP_ZERO;
Packit 423ecb
  default:
Packit 423ecb
    return TRIO_FP_NORMAL;
Packit 423ecb
  }
Packit 423ecb
Packit 423ecb
#else
Packit 423ecb
# if defined(TRIO_COMPILER_DECC)
Packit 423ecb
  /*
Packit 423ecb
   * DECC has an fp_class() function.
Packit 423ecb
   */
Packit 423ecb
#  define TRIO_FPCLASSIFY(n) fp_class(n)
Packit 423ecb
#  define TRIO_QUIET_NAN FP_QNAN
Packit 423ecb
#  define TRIO_SIGNALLING_NAN FP_SNAN
Packit 423ecb
#  define TRIO_POSITIVE_INFINITY FP_POS_INF
Packit 423ecb
#  define TRIO_NEGATIVE_INFINITY FP_NEG_INF
Packit 423ecb
#  define TRIO_POSITIVE_SUBNORMAL FP_POS_DENORM
Packit 423ecb
#  define TRIO_NEGATIVE_SUBNORMAL FP_NEG_DENORM
Packit 423ecb
#  define TRIO_POSITIVE_ZERO FP_POS_ZERO
Packit 423ecb
#  define TRIO_NEGATIVE_ZERO FP_NEG_ZERO
Packit 423ecb
#  define TRIO_POSITIVE_NORMAL FP_POS_NORM
Packit 423ecb
#  define TRIO_NEGATIVE_NORMAL FP_NEG_NORM
Packit 423ecb
Packit 423ecb
# elif defined(TRIO_COMPILER_MSVC) || defined(TRIO_COMPILER_BCB)
Packit 423ecb
  /*
Packit 423ecb
   * Microsoft Visual C++ and Borland C++ Builder have an _fpclass()
Packit 423ecb
   * function.
Packit 423ecb
   */
Packit 423ecb
#  define TRIO_FPCLASSIFY(n) _fpclass(n)
Packit 423ecb
#  define TRIO_QUIET_NAN _FPCLASS_QNAN
Packit 423ecb
#  define TRIO_SIGNALLING_NAN _FPCLASS_SNAN
Packit 423ecb
#  define TRIO_POSITIVE_INFINITY _FPCLASS_PINF
Packit 423ecb
#  define TRIO_NEGATIVE_INFINITY _FPCLASS_NINF
Packit 423ecb
#  define TRIO_POSITIVE_SUBNORMAL _FPCLASS_PD
Packit 423ecb
#  define TRIO_NEGATIVE_SUBNORMAL _FPCLASS_ND
Packit 423ecb
#  define TRIO_POSITIVE_ZERO _FPCLASS_PZ
Packit 423ecb
#  define TRIO_NEGATIVE_ZERO _FPCLASS_NZ
Packit 423ecb
#  define TRIO_POSITIVE_NORMAL _FPCLASS_PN
Packit 423ecb
#  define TRIO_NEGATIVE_NORMAL _FPCLASS_NN
Packit 423ecb
Packit 423ecb
# elif defined(FP_PLUS_NORM)
Packit 423ecb
  /*
Packit 423ecb
   * HP-UX 9.x and 10.x have an fpclassify() function, that is different
Packit 423ecb
   * from the C99 fpclassify() macro supported on HP-UX 11.x.
Packit 423ecb
   *
Packit 423ecb
   * AIX has class() for C, and _class() for C++, which returns the
Packit 423ecb
   * same values as the HP-UX fpclassify() function.
Packit 423ecb
   */
Packit 423ecb
#  if defined(TRIO_PLATFORM_AIX)
Packit 423ecb
#   if defined(__cplusplus)
Packit 423ecb
#    define TRIO_FPCLASSIFY(n) _class(n)
Packit 423ecb
#   else
Packit 423ecb
#    define TRIO_FPCLASSIFY(n) class(n)
Packit 423ecb
#   endif
Packit 423ecb
#  else
Packit 423ecb
#   define TRIO_FPCLASSIFY(n) fpclassify(n)
Packit 423ecb
#  endif
Packit 423ecb
#  define TRIO_QUIET_NAN FP_QNAN
Packit 423ecb
#  define TRIO_SIGNALLING_NAN FP_SNAN
Packit 423ecb
#  define TRIO_POSITIVE_INFINITY FP_PLUS_INF
Packit 423ecb
#  define TRIO_NEGATIVE_INFINITY FP_MINUS_INF
Packit 423ecb
#  define TRIO_POSITIVE_SUBNORMAL FP_PLUS_DENORM
Packit 423ecb
#  define TRIO_NEGATIVE_SUBNORMAL FP_MINUS_DENORM
Packit 423ecb
#  define TRIO_POSITIVE_ZERO FP_PLUS_ZERO
Packit 423ecb
#  define TRIO_NEGATIVE_ZERO FP_MINUS_ZERO
Packit 423ecb
#  define TRIO_POSITIVE_NORMAL FP_PLUS_NORM
Packit 423ecb
#  define TRIO_NEGATIVE_NORMAL FP_MINUS_NORM
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
# if defined(TRIO_FPCLASSIFY)
Packit 423ecb
  switch (TRIO_FPCLASSIFY(number)) {
Packit 423ecb
  case TRIO_QUIET_NAN:
Packit 423ecb
  case TRIO_SIGNALLING_NAN:
Packit 423ecb
    *is_negative = TRIO_FALSE; /* NaN has no sign */
Packit 423ecb
    return TRIO_FP_NAN;
Packit 423ecb
  case TRIO_POSITIVE_INFINITY:
Packit 423ecb
    *is_negative = TRIO_FALSE;
Packit 423ecb
    return TRIO_FP_INFINITE;
Packit 423ecb
  case TRIO_NEGATIVE_INFINITY:
Packit 423ecb
    *is_negative = TRIO_TRUE;
Packit 423ecb
    return TRIO_FP_INFINITE;
Packit 423ecb
  case TRIO_POSITIVE_SUBNORMAL:
Packit 423ecb
    *is_negative = TRIO_FALSE;
Packit 423ecb
    return TRIO_FP_SUBNORMAL;
Packit 423ecb
  case TRIO_NEGATIVE_SUBNORMAL:
Packit 423ecb
    *is_negative = TRIO_TRUE;
Packit 423ecb
    return TRIO_FP_SUBNORMAL;
Packit 423ecb
  case TRIO_POSITIVE_ZERO:
Packit 423ecb
    *is_negative = TRIO_FALSE;
Packit 423ecb
    return TRIO_FP_ZERO;
Packit 423ecb
  case TRIO_NEGATIVE_ZERO:
Packit 423ecb
    *is_negative = TRIO_TRUE;
Packit 423ecb
    return TRIO_FP_ZERO;
Packit 423ecb
  case TRIO_POSITIVE_NORMAL:
Packit 423ecb
    *is_negative = TRIO_FALSE;
Packit 423ecb
    return TRIO_FP_NORMAL;
Packit 423ecb
  case TRIO_NEGATIVE_NORMAL:
Packit 423ecb
    *is_negative = TRIO_TRUE;
Packit 423ecb
    return TRIO_FP_NORMAL;
Packit 423ecb
  default:
Packit 423ecb
    /* Just in case... */
Packit 423ecb
    *is_negative = (number < 0.0);
Packit 423ecb
    return TRIO_FP_NORMAL;
Packit 423ecb
  }
Packit 423ecb
Packit 423ecb
# else
Packit 423ecb
  /*
Packit 423ecb
   * Fallback solution.
Packit 423ecb
   */
Packit 423ecb
  int rc;
Packit 423ecb
Packit 423ecb
  if (number == 0.0) {
Packit 423ecb
    /*
Packit 423ecb
     * In IEEE 754 the sign of zero is ignored in comparisons, so we
Packit 423ecb
     * have to handle this as a special case by examining the sign bit
Packit 423ecb
     * directly.
Packit 423ecb
     */
Packit 423ecb
#  if defined(USE_IEEE_754)
Packit 423ecb
    *is_negative = trio_is_negative(number);
Packit 423ecb
#  else
Packit 423ecb
    *is_negative = TRIO_FALSE; /* FIXME */
Packit 423ecb
#  endif
Packit 423ecb
    return TRIO_FP_ZERO;
Packit 423ecb
  }
Packit 423ecb
  if (trio_isnan(number)) {
Packit 423ecb
    *is_negative = TRIO_FALSE;
Packit 423ecb
    return TRIO_FP_NAN;
Packit 423ecb
  }
Packit 423ecb
  if ((rc = trio_isinf(number))) {
Packit 423ecb
    *is_negative = (rc == -1);
Packit 423ecb
    return TRIO_FP_INFINITE;
Packit 423ecb
  }
Packit 423ecb
  if ((number > 0.0) && (number < DBL_MIN)) {
Packit 423ecb
    *is_negative = TRIO_FALSE;
Packit 423ecb
    return TRIO_FP_SUBNORMAL;
Packit 423ecb
  }
Packit 423ecb
  if ((number < 0.0) && (number > -DBL_MIN)) {
Packit 423ecb
    *is_negative = TRIO_TRUE;
Packit 423ecb
    return TRIO_FP_SUBNORMAL;
Packit 423ecb
  }
Packit 423ecb
  *is_negative = (number < 0.0);
Packit 423ecb
  return TRIO_FP_NORMAL;
Packit 423ecb
Packit 423ecb
# endif
Packit 423ecb
#endif
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
/**
Packit 423ecb
   Examine the sign of a number.
Packit 423ecb
Packit 423ecb
   @param number An arbitrary floating-point number.
Packit 423ecb
   @return Boolean value indicating whether or not the number has the
Packit 423ecb
   sign bit set (i.e. is negative).
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC int
Packit 423ecb
trio_signbit
Packit 423ecb
TRIO_ARGS1((number),
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
  int is_negative;
Packit 423ecb
Packit 423ecb
  (void)trio_fpclassify_and_signbit(number, &is_negative);
Packit 423ecb
  return is_negative;
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
#if 0
Packit 423ecb
	/* Temporary fix - this routine is not used in libxml */
Packit 423ecb
/**
Packit 423ecb
   Examine the class of a number.
Packit 423ecb
Packit 423ecb
   @param number An arbitrary floating-point number.
Packit 423ecb
   @return Enumerable value indicating the class of @p number
Packit 423ecb
*/
Packit 423ecb
TRIO_PUBLIC int
Packit 423ecb
trio_fpclassify
Packit 423ecb
TRIO_ARGS1((number),
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
  int dummy;
Packit 423ecb
Packit 423ecb
  return trio_fpclassify_and_signbit(number, &dummy);
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
#endif
Packit 423ecb
Packit 423ecb
/** @} SpecialQuantities */
Packit 423ecb
Packit 423ecb
/*************************************************************************
Packit 423ecb
 * For test purposes.
Packit 423ecb
 *
Packit 423ecb
 * Add the following compiler option to include this test code.
Packit 423ecb
 *
Packit 423ecb
 *  Unix : -DSTANDALONE
Packit 423ecb
 *  VMS  : /DEFINE=(STANDALONE)
Packit 423ecb
 */
Packit 423ecb
#if defined(STANDALONE)
Packit 423ecb
# include <stdio.h>
Packit 423ecb
Packit 423ecb
static TRIO_CONST char *
Packit 423ecb
getClassification
Packit 423ecb
TRIO_ARGS1((type),
Packit 423ecb
	   int type)
Packit 423ecb
{
Packit 423ecb
  switch (type) {
Packit 423ecb
  case TRIO_FP_INFINITE:
Packit 423ecb
    return "FP_INFINITE";
Packit 423ecb
  case TRIO_FP_NAN:
Packit 423ecb
    return "FP_NAN";
Packit 423ecb
  case TRIO_FP_NORMAL:
Packit 423ecb
    return "FP_NORMAL";
Packit 423ecb
  case TRIO_FP_SUBNORMAL:
Packit 423ecb
    return "FP_SUBNORMAL";
Packit 423ecb
  case TRIO_FP_ZERO:
Packit 423ecb
    return "FP_ZERO";
Packit 423ecb
  default:
Packit 423ecb
    return "FP_UNKNOWN";
Packit 423ecb
  }
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
static void
Packit 423ecb
print_class
Packit 423ecb
TRIO_ARGS2((prefix, number),
Packit 423ecb
	   TRIO_CONST char *prefix,
Packit 423ecb
	   double number)
Packit 423ecb
{
Packit 423ecb
  printf("%-6s: %s %-15s %g\n",
Packit 423ecb
	 prefix,
Packit 423ecb
	 trio_signbit(number) ? "-" : "+",
Packit 423ecb
	 getClassification(TRIO_FPCLASSIFY(number)),
Packit 423ecb
	 number);
Packit 423ecb
}
Packit 423ecb
Packit 423ecb
int main(TRIO_NOARGS)
Packit 423ecb
{
Packit 423ecb
  double my_nan;
Packit 423ecb
  double my_pinf;
Packit 423ecb
  double my_ninf;
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  void (*signal_handler) TRIO_PROTO((int));
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  my_nan = trio_nan();
Packit 423ecb
  my_pinf = trio_pinf();
Packit 423ecb
  my_ninf = trio_ninf();
Packit 423ecb
Packit 423ecb
  print_class("Nan", my_nan);
Packit 423ecb
  print_class("PInf", my_pinf);
Packit 423ecb
  print_class("NInf", my_ninf);
Packit 423ecb
  print_class("PZero", 0.0);
Packit 423ecb
  print_class("NZero", -0.0);
Packit 423ecb
  print_class("PNorm", 1.0);
Packit 423ecb
  print_class("NNorm", -1.0);
Packit 423ecb
  print_class("PSub", 1.01e-307 - 1.00e-307);
Packit 423ecb
  print_class("NSub", 1.00e-307 - 1.01e-307);
Packit 423ecb
Packit 423ecb
  printf("NaN : %4g 0x%02x%02x%02x%02x%02x%02x%02x%02x (%2d, %2d)\n",
Packit 423ecb
	 my_nan,
Packit 423ecb
	 ((unsigned char *)&my_nan)[0],
Packit 423ecb
	 ((unsigned char *)&my_nan)[1],
Packit 423ecb
	 ((unsigned char *)&my_nan)[2],
Packit 423ecb
	 ((unsigned char *)&my_nan)[3],
Packit 423ecb
	 ((unsigned char *)&my_nan)[4],
Packit 423ecb
	 ((unsigned char *)&my_nan)[5],
Packit 423ecb
	 ((unsigned char *)&my_nan)[6],
Packit 423ecb
	 ((unsigned char *)&my_nan)[7],
Packit 423ecb
	 trio_isnan(my_nan), trio_isinf(my_nan));
Packit 423ecb
  printf("PInf: %4g 0x%02x%02x%02x%02x%02x%02x%02x%02x (%2d, %2d)\n",
Packit 423ecb
	 my_pinf,
Packit 423ecb
	 ((unsigned char *)&my_pinf)[0],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[1],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[2],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[3],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[4],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[5],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[6],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[7],
Packit 423ecb
	 trio_isnan(my_pinf), trio_isinf(my_pinf));
Packit 423ecb
  printf("NInf: %4g 0x%02x%02x%02x%02x%02x%02x%02x%02x (%2d, %2d)\n",
Packit 423ecb
	 my_ninf,
Packit 423ecb
	 ((unsigned char *)&my_ninf)[0],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[1],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[2],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[3],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[4],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[5],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[6],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[7],
Packit 423ecb
	 trio_isnan(my_ninf), trio_isinf(my_ninf));
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  signal_handler = signal(SIGFPE, SIG_IGN);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  my_pinf = DBL_MAX + DBL_MAX;
Packit 423ecb
  my_ninf = -my_pinf;
Packit 423ecb
  my_nan = my_pinf / my_pinf;
Packit 423ecb
Packit 423ecb
# if defined(TRIO_PLATFORM_UNIX)
Packit 423ecb
  signal(SIGFPE, signal_handler);
Packit 423ecb
# endif
Packit 423ecb
Packit 423ecb
  printf("NaN : %4g 0x%02x%02x%02x%02x%02x%02x%02x%02x (%2d, %2d)\n",
Packit 423ecb
	 my_nan,
Packit 423ecb
	 ((unsigned char *)&my_nan)[0],
Packit 423ecb
	 ((unsigned char *)&my_nan)[1],
Packit 423ecb
	 ((unsigned char *)&my_nan)[2],
Packit 423ecb
	 ((unsigned char *)&my_nan)[3],
Packit 423ecb
	 ((unsigned char *)&my_nan)[4],
Packit 423ecb
	 ((unsigned char *)&my_nan)[5],
Packit 423ecb
	 ((unsigned char *)&my_nan)[6],
Packit 423ecb
	 ((unsigned char *)&my_nan)[7],
Packit 423ecb
	 trio_isnan(my_nan), trio_isinf(my_nan));
Packit 423ecb
  printf("PInf: %4g 0x%02x%02x%02x%02x%02x%02x%02x%02x (%2d, %2d)\n",
Packit 423ecb
	 my_pinf,
Packit 423ecb
	 ((unsigned char *)&my_pinf)[0],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[1],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[2],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[3],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[4],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[5],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[6],
Packit 423ecb
	 ((unsigned char *)&my_pinf)[7],
Packit 423ecb
	 trio_isnan(my_pinf), trio_isinf(my_pinf));
Packit 423ecb
  printf("NInf: %4g 0x%02x%02x%02x%02x%02x%02x%02x%02x (%2d, %2d)\n",
Packit 423ecb
	 my_ninf,
Packit 423ecb
	 ((unsigned char *)&my_ninf)[0],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[1],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[2],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[3],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[4],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[5],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[6],
Packit 423ecb
	 ((unsigned char *)&my_ninf)[7],
Packit 423ecb
	 trio_isnan(my_ninf), trio_isinf(my_ninf));
Packit 423ecb
Packit 423ecb
  return 0;
Packit 423ecb
}
Packit 423ecb
#endif