include/llvm/Support/MathExtras.h

   1 //===-- llvm/Support/MathExtras.h - Useful math functions -------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains some functions that are useful for math stuff.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_SUPPORT_MATHEXTRAS_H
  15 #define LLVM_SUPPORT_MATHEXTRAS_H
  16
  17 #include "llvm/Support/DataTypes.h"
  18
  19 namespace llvm {
  20
  21 // NOTE: The following support functions use the _32/_64 extensions instead of
  22 // type overloading so that signed and unsigned integers can be used without
  23 // ambiguity.
  24
  25
  26 // Hi_32 - This function returns the high 32 bits of a 64 bit value.
  27 inline unsigned Hi_32(uint64_t Value) {
  28   return (unsigned)(Value >> 32);
  29 }
  30
  31 // Lo_32 - This function returns the low 32 bits of a 64 bit value.
  32 inline unsigned Lo_32(uint64_t Value) {
  33   return (unsigned)Value;
  34 }
  35
  36 // is?Type - these functions produce optimal testing for integer data types.
  37 inline bool isInt8  (int Value)     { return (  signed char )Value == Value; }
  38 inline bool isUInt8 (int Value)     { return (unsigned char )Value == Value; }
  39 inline bool isInt16 (int Value)     { return (  signed short)Value == Value; }
  40 inline bool isUInt16(int Value)     { return (unsigned short)Value == Value; }
  41 inline bool isInt32 (int64_t Value) { return (  signed int  )Value == Value; }
  42 inline bool isUInt32(int64_t Value) { return (unsigned int  )Value == Value; }
  43
  44 // isMask_32 - This function returns true if the argument is a sequence of ones
  45 // starting at the least significant bit with the remainder zero (32 bit version.)
  46 // Ex. isMask_32(0x0000FFFFU) == true.
  47 inline const bool isMask_32(unsigned Value) {
  48   return Value && ((Value + 1) & Value) == 0;
  49 }
  50
  51 // isMask_64 - This function returns true if the argument is a sequence of ones
  52 // starting at the least significant bit with the remainder zero (64 bit version.)
  53 inline const bool isMask_64(uint64_t Value) {
  54   return Value && ((Value + 1) & Value) == 0;
  55 }
  56
  57 // isShiftedMask_32 - This function returns true if the argument contains a
  58 // sequence of ones with the remainder zero (32 bit version.)
  59 // Ex. isShiftedMask_32(0x0000FF00U) == true.
  60 inline const bool isShiftedMask_32(unsigned Value) {
  61   return isMask_32((Value - 1) | Value);
  62 }
  63
  64 // isShiftedMask_64 - This function returns true if the argument contains a
  65 // sequence of ones with the remainder zero (64 bit version.)
  66 inline const bool isShiftedMask_64(uint64_t Value) {
  67   return isMask_64((Value - 1) | Value);
  68 }
  69
  70 // isPowerOf2_32 - This function returns true if the argument is a power of
  71 // two > 0. Ex. isPowerOf2_32(0x00100000U) == true (32 bit edition.)
  72 inline bool isPowerOf2_32(unsigned Value) {
  73   return Value && !(Value & (Value - 1));
  74 }
  75
  76 // isPowerOf2_64 - This function returns true if the argument is a power of two
  77 // > 0 (64 bit edition.)
  78 inline bool isPowerOf2_64(uint64_t Value) {
  79   return Value && !(Value & (Value - 1LL));
  80 }
  81
  82 // CountLeadingZeros_32 - this function performs the platform optimal form of
  83 // counting the number of zeros from the most significant bit to the first one
  84 // bit.  Ex. CountLeadingZeros_32(0x00F000FF) == 8.
  85 // Returns 32 if the word is zero.
  86 inline unsigned CountLeadingZeros_32(unsigned Value) {
  87   unsigned Count; // result
  88 #if __GNUC__ >= 4
  89   // PowerPC is defined for __builtin_clz(0)
  90 #if !defined(__ppc__) && !defined(__ppc64__)
  91   if (!Value) return 32;
  92 #endif
  93   Count = __builtin_clz(Value);
  94 #else
  95   if (!Value) return 32;
  96   Count = 0;
  97   // bisecton method for count leading zeros
  98   for (unsigned Shift = 32 >> 1; Shift; Shift >>= 1) {
  99     unsigned Tmp = Value >> Shift;
 100     if (Tmp) {
 101       Value = Tmp;
 102     } else {
 103       Count |= Shift;
 104     }
 105   }
 106 #endif
 107   return Count;
 108 }
 109
 110 // CountLeadingZeros_64 - This function performs the platform optimal form
 111 // of counting the number of zeros from the most significant bit to the first
 112 // one bit (64 bit edition.)
 113 // Returns 64 if the word is zero.
 114 inline unsigned CountLeadingZeros_64(uint64_t Value) {
 115   unsigned Count; // result
 116 #if __GNUC__ >= 4
 117   // PowerPC is defined for __builtin_clzll(0)
 118 #if !defined(__ppc__) && !defined(__ppc64__)
 119   if (!Value) return 64;
 120 #endif
 121   Count = __builtin_clzll(Value);
 122 #else
 123   if (sizeof(long) == sizeof(int64_t)) {
 124     if (!Value) return 64;
 125     Count = 0;
 126     // bisecton method for count leading zeros
 127     for (uint64_t Shift = 64 >> 1; Shift; Shift >>= 1) {
 128       uint64_t Tmp = Value >> Shift;
 129       if (Tmp) {
 130         Value = Tmp;
 131       } else {
 132         Count |= Shift;
 133       }
 134     }
 135   } else {
 136     // get hi portion
 137     unsigned Hi = Hi_32(Value);
 138
 139     // if some bits in hi portion
 140     if (Hi) {
 141         // leading zeros in hi portion plus all bits in lo portion
 142         Count = CountLeadingZeros_32(Hi);
 143     } else {
 144         // get lo portion
 145         unsigned Lo = Lo_32(Value);
 146         // same as 32 bit value
 147         Count = CountLeadingZeros_32(Lo)+32;
 148     }
 149   }
 150 #endif
 151   return Count;
 152 }
 153
 154 // CountTrailingZeros_32 - this function performs the platform optimal form of
 155 // counting the number of zeros from the least significant bit to the first one
 156 // bit.  Ex. CountTrailingZeros_32(0xFF00FF00) == 8.
 157 // Returns 32 if the word is zero.
 158 inline unsigned CountTrailingZeros_32(unsigned Value) {
 159   return 32 - CountLeadingZeros_32(~Value & (Value - 1));
 160 }
 161
 162 // CountTrailingZeros_64 - This function performs the platform optimal form
 163 // of counting the number of zeros from the least significant bit to the first
 164 // one bit (64 bit edition.)
 165 // Returns 64 if the word is zero.
 166 inline unsigned CountTrailingZeros_64(uint64_t Value) {
 167   return 64 - CountLeadingZeros_64(~Value & (Value - 1));
 168 }
 169
 170 // CountPopulation_32 - this function counts the number of set bits in a value.
 171 // Ex. CountPopulation(0xF000F000) = 8
 172 // Returns 0 if the word is zero.
 173 inline unsigned CountPopulation_32(unsigned Value) {
 174   unsigned x, t;
 175   x = Value - ((Value >> 1) & 0x55555555);
 176   t = ((x >> 2) & 0x33333333);
 177   x = (x & 0x33333333) + t;
 178   x = (x + (x >> 4)) & 0x0F0F0F0F;
 179   x = x + (x << 8);
 180   x = x + (x << 16);
 181   return x >> 24;
 182 }
 183
 184 // CountPopulation_64 - this function counts the number of set bits in a value,
 185 // (64 bit edition.)
 186 inline unsigned CountPopulation_64(uint64_t Value) {
 187   return CountPopulation_32(unsigned(Value >> 32)) +
 188          CountPopulation_32(unsigned(Value));
 189 }
 190
 191 // Log2_32 - This function returns the floor log base 2 of the specified value,
 192 // -1 if the value is zero. (32 bit edition.)
 193 // Ex. Log2_32(32) == 5, Log2_32(1) == 0, Log2_32(0) == -1
 194 inline unsigned Log2_32(unsigned Value) {
 195     return 31 - CountLeadingZeros_32(Value);
 196 }
 197
 198 // Log2_64 - This function returns the floor log base 2 of the specified value,
 199 // -1 if the value is zero. (64 bit edition.)
 200 inline unsigned Log2_64(uint64_t Value) {
 201     return 63 - CountLeadingZeros_64(Value);
 202 }
 203
 204 // BitsToDouble - This function takes a 64-bit integer and returns the bit
 205 // equivalent double.
 206 inline double BitsToDouble(uint64_t Bits) {
 207   union {
 208     uint64_t L;
 209     double D;
 210   } T;
 211   T.L = Bits;
 212   return T.D;
 213 }
 214
 215 // BitsToFloat - This function takes a 32-bit integer and returns the bit
 216 // equivalent float.
 217 inline float BitsToFloat(uint32_t Bits) {
 218   union {
 219     uint32_t I;
 220     float F;
 221   } T;
 222   T.I = Bits;
 223   return T.F;
 224 }
 225
 226 // DoubleToBits - This function takes a double and returns the bit
 227 // equivalent 64-bit integer.
 228 inline uint64_t DoubleToBits(double Double) {
 229   union {
 230     uint64_t L;
 231     double D;
 232   } T;
 233   T.D = Double;
 234   return T.L;
 235 }
 236
 237 // FloatToBits - This function takes a float and returns the bit
 238 // equivalent 32-bit integer.
 239 inline uint32_t FloatToBits(float Float) {
 240   union {
 241     uint32_t I;
 242     float F;
 243   } T;
 244   T.F = Float;
 245   return T.I;
 246 }
 247
 248 // Platform-independent wrappers for the C99 isnan() function.
 249 int IsNAN (float f);
 250 int IsNAN (double d);
 251
 252 // Platform-independent wrappers for the C99 isinf() function.
 253 int IsInf (float f);
 254 int IsInf (double d);
 255
 256 } // End llvm namespace
 257
 258 #endif