lo-ieee.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1996-2025 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
 
#if ! defined (octave_lo_ieee_h)
#define octave_lo_ieee_h 1
 
#include "octave-config.h"
 
#if defined (__cplusplus)
#  include <cmath>
 
extern "C" {
#else
#  include <math.h>
#endif
 
/*  Octave's idea of infinity.  */
#define octave_Inf (lo_ieee_inf_value ())
 
/* Octave's idea of a missing value.  */
#define octave_NA (lo_ieee_na_value ())
 
/* Octave's idea of not a number.  */
#define octave_NaN (lo_ieee_nan_value ())
 
/*  Octave's idea of infinity.  */
#define octave_Float_Inf (lo_ieee_float_inf_value ())
 
/* Octave's idea of a missing value.  */
#define octave_Float_NA (lo_ieee_float_na_value ())
 
/* Octave's idea of not a number.  */
#define octave_Float_NaN (lo_ieee_float_nan_value ())
 
/* FIXME: This code assumes that a double has twice the
          number of bits as an int */
 
typedef union
  {
  double value;
  unsigned int word[2];
} lo_ieee_double;
 
typedef union
  {
  float value;
  unsigned int word;
} lo_ieee_float;
 
extern OCTAVE_API void octave_ieee_init (void);
 
#if defined (__cplusplus)
OCTAVE_DEPRECATED (10, "use std::isnan instead")
inline int __lo_ieee_isnan (double x) { return std::isnan (x); }
OCTAVE_DEPRECATED (10, "use std::isfinite instead")
inline int __lo_ieee_isfinite (double x) { return std::isfinite (x); }
OCTAVE_DEPRECATED (10, "use std::isinf instead")
inline int __lo_ieee_isinf (double x) { return std::isinf (x); }
 
OCTAVE_DEPRECATED (10, "use std::signbit instead")
inline int __lo_ieee_signbit (double x) { return std::signbit (x); }
 
OCTAVE_DEPRECATED (10, "use std::isnan instead")
inline int __lo_ieee_float_isnan (float x) { return std::isnan (x); }
OCTAVE_DEPRECATED (10, "use std::isfinite instead")
inline int __lo_ieee_float_isfinite (float x) { return std::isfinite (x); }
OCTAVE_DEPRECATED (10, "use std::isinf instead")
inline int __lo_ieee_float_isinf (float x) { return std::isinf (x); }
 
OCTAVE_DEPRECATED (10, "use std::signbit instead")
inline int __lo_ieee_float_signbit (float x) { return std::signbit (x); }
#else
OCTAVE_DEPRECATED (10, "use isnan instead")
inline int __lo_ieee_isnan (double x) { return isnan (x); }
OCTAVE_DEPRECATED (10, "use isfinite instead")
inline int __lo_ieee_isfinite (double x) { return isfinite (x); }
OCTAVE_DEPRECATED (10, "use isinf instead")
inline int __lo_ieee_isinf (double x) { return isinf (x); }
 
OCTAVE_DEPRECATED (10, "use signbit instead")
inline int __lo_ieee_signbit (double x) { return signbit (x); }
 
OCTAVE_DEPRECATED (10, "use isnan instead")
inline int __lo_ieee_float_isnan (float x) { return isnan (x); }
OCTAVE_DEPRECATED (10, "use isfinite instead")
inline int __lo_ieee_float_isfinite (float x) { return isfinite (x); }
OCTAVE_DEPRECATED (10, "use isinf instead")
inline int __lo_ieee_float_isinf (float x) { return isinf (x); }
 
OCTAVE_DEPRECATED (10, "use signbit instead")
inline int __lo_ieee_float_signbit (float x) { return signbit (x); }
#endif
 
extern OCTAVE_API int __lo_ieee_is_NA (double);
 
extern OCTAVE_API double lo_ieee_inf_value (void);
extern OCTAVE_API double lo_ieee_na_value (void);
extern OCTAVE_API double lo_ieee_nan_value (void);
 
extern OCTAVE_API int __lo_ieee_float_is_NA (float);
 
extern OCTAVE_API float lo_ieee_float_inf_value (void);
extern OCTAVE_API float lo_ieee_float_na_value (void);
extern OCTAVE_API float lo_ieee_float_nan_value (void);
 
#if defined (__cplusplus)
}
#endif
 
#define lo_ieee_isnan(x)                                \
  (sizeof (x) == sizeof (float)                         \
   ? __lo_ieee_float_isnan (x) : __lo_ieee_isnan (x))
 
#define lo_ieee_isfinite(x)                                   \
  (sizeof (x) == sizeof (float)                               \
   ? __lo_ieee_float_isfinite (x) : __lo_ieee_isfinite (x))
 
#define lo_ieee_isinf(x)                                \
  (sizeof (x) == sizeof (float)                         \
   ? __lo_ieee_float_isinf (x) : __lo_ieee_isinf (x))
 
#define lo_ieee_is_NA(x)                                \
  (sizeof (x) == sizeof (float)                         \
   ? __lo_ieee_float_is_NA (x) : __lo_ieee_is_NA (x))
 
#define lo_ieee_signbit(x)                                      \
  (sizeof (x) == sizeof (float)                                 \
   ? __lo_ieee_float_signbit (x) : __lo_ieee_signbit (x))
 
#if defined (__cplusplus)
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
template <typename T>
struct numeric_limits
{
public:
  static T NA () { return static_cast<T> (0); }
  static T NaN () { return static_cast<T> (0); }
  static T Inf () { return static_cast<T> (0); }
};
 
template <>
struct numeric_limits<double>
{
public:
  static double NA () { return octave_NA; }
  static double NaN () { return octave_NaN; }
  static double Inf () { return octave_Inf; }
};
 
template <>
struct numeric_limits<float>
{
public:
  static float NA () { return octave_Float_NA; }
  static float NaN () { return octave_Float_NaN; }
  static float Inf () { return octave_Float_Inf; }
};
 
OCTAVE_END_NAMESPACE(octave)
 
#endif
 
#endif