src/libpspp/misc.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #if !libpspp_misc_h
  18 #define libpspp_misc_h 1
  19
  20 #include <float.h>
  21 #include <math.h>
  22
  23 #define EPSILON (10 * DBL_EPSILON)
  24
  25 /* Divides nonnegative X by positive Y, rounding up. */
  26 #define DIV_RND_UP(X, Y) (((X) + ((Y) - 1)) / (Y))
  27
  28 /* Returns nonnegative difference between {nonnegative X} and {the
  29    least multiple of positive Y greater than or equal to X}. */
  30 #define REM_RND_UP(X, Y) ((X) % (Y) ? (Y) - (X) % (Y) : 0)
  31
  32 /* Rounds X up to the next multiple of Y. */
  33 #define ROUND_UP(X, Y) (((X) + ((Y) - 1)) / (Y) * (Y))
  34
  35 /* Rounds X down to the previous multiple of Y. */
  36 #define ROUND_DOWN(X, Y) ((X) / (Y) * (Y))
  37
  38 #define SQR(X) ((X) * (X))
  39
  40 int intlog10 (unsigned);
  41
  42 /* Returns the square of X. */
  43 static inline double
  44 pow2 (double x)
  45 {
  46   return x * x;
  47 }
  48
  49 /* Returns the cube of X. */
  50 static inline double
  51 pow3 (double x)
  52 {
  53   return x * x * x;
  54 }
  55
  56 /* Returns the fourth power of X. */
  57 static inline double
  58 pow4 (double x)
  59 {
  60   double y = x * x;
  61   y *= y;
  62   return y;
  63 }
  64
  65 /* Set *DEST to the lower of *DEST and SRC */
  66 static inline void
  67 minimize (double *dest, double src)
  68 {
  69   if (src < *dest)
  70     *dest = src;
  71 }
  72
  73
  74 /* Set *DEST to the greater of *DEST and SRC */
  75 static inline void
  76 maximize (double *dest, double src)
  77 {
  78   if (src > *dest)
  79     *dest = src;
  80 }
  81
  82 #endif /* libpspp/misc.h */