about summary refs log tree commit diff
path: root/lib/util/pm_c_util.h
blob: 110d7536d2ac5052b0cba99abb7eb5976f0c7b62 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
#ifndef PM_C_UTIL_INCLUDED
#define PM_C_UTIL_INCLUDED

/* Note that for MAX and MIN, if either of the operands is a floating point
   Not-A-Number, the result is the second operand.  So if you're computing a
   running maximum and want to ignore the NaNs in the computation, put the
   running maximum variable second.
*/
#undef MAX
#define MAX(a,b) ((a) > (b) ? (a) : (b))
#undef MIN
#define MIN(a,b) ((a) < (b) ? (a) : (b))
#undef ABS
#define ABS(a) ((a) >= 0 ? (a) : -(a))
#undef SGN
#define SGN(a)          (((a)<0) ? -1 : 1)
#undef ODD
#define ODD(n) ((n) & 1)
#undef ROUND
#define ROUND(X) (((X) >= 0) ? (int)((X)+0.5) : (int)((X)-0.5))
#undef ROUNDU
#define ROUNDU(X) ((unsigned int)((X)+0.5))
    /* Note that imprecision in floating point arithmetic can make an exact
       half fractional part round down instead of up.  What should be
       1000.5 might actually be 1000.49999999999.

       Use 'pnm_unnormalized_sample' instead of ROUNDU(samplen*maxval) to get
       consistent rounding up when you are unnormalizing sample values.
    */

/* ROUNDUP rounds up to a specified multiple.  E.g. ROUNDUP(22, 8) == 24 */

#undef ROUNDUP
#define ROUNDUP(X,M) (((X)+(M)-1)/(M)*(M))
#undef ROUNDDN
#define ROUNDDN(X,M) ((X)/(M)*(M))

#define ROUNDDIV(DIVIDEND,DIVISOR) (((DIVIDEND) + (DIVISOR)/2)/(DIVISOR))

#undef SQR
#define SQR(a) ((a)*(a))

/* NOTE: do not use "bool" as a type in an external interface.  It could
   have different definitions on either side of the interface.  Even if both
   sides include this interface header file, the conditional compilation
   here means one side may use the typedef below and the other side may
   use some other definition.  For an external interface, be safe and just
   use "int".
*/

/* We will probably never again see a system that does not have
   <stdbool.h>, but just in case, we have our own alternative here.

   Evidence shows that the compiler actually produces better code with
   <stdbool.h> than with bool simply typedefed to int.
*/

#ifdef __cplusplus
  /* C++ has a bool type and false and true constants built in. */
#else
  /* The test for __STDC__ is paranoid.  It is there just in case some
     nonstandard compiler defines __STDC_VERSION__ in an arbitrary manner.

     We know GCC 2.95.3 has stdbool; not sure about earlier GCC 2.
  */
  #if ( defined(__GNUC__) && (__GNUC__ >= 2) ) || \
      ( defined(__STDC__) && (__STDC__ == 1) && \
        defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) )
    #include <stdbool.h>
  #else
    /* We used to assume that if TRUE was defined, then bool was too.
       However, we had a report on 2001.09.21 of a Tru64 system that had
       TRUE but not bool and on 2002.03.21 of an AIX 4.3 system that was
       likewise.  So now we define bool all the time, unless the macro
       HAVE_BOOL is defined.  If someone is using the Netpbm libraries and
       also another library that defines bool, he can either make the
       other library define/respect HAVE_BOOL or just define HAVE_BOOL in
       the file that includes pm_config.h or with a compiler option.  Note
       that C++ always has bool.
    */
    #ifndef HAVE_BOOL
      #define HAVE_BOOL 1
      typedef int bool;
    #endif
    #ifndef true
      enum boolvalue {false=0, true=1};
    #endif
  #endif
#endif

#ifndef TRUE
  #define TRUE true
  #endif
#ifndef FALSE
  #define FALSE false
  #endif

#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))

#endif