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 /// Hi_32 - This function returns the high 32 bits of a 64 bit value.
  26 inline unsigned Hi_32(uint64_t Value) {
  27   return static_cast<unsigned>(Value >> 32);
  28 }
  29
  30 /// Lo_32 - This function returns the low 32 bits of a 64 bit value.
  31 inline unsigned Lo_32(uint64_t Value) {
  32   return static_cast<unsigned>(Value);
  33 }
  34
  35 /// is?Type - these functions produce optimal testing for integer data types.
  36 inline bool isInt8  (int64_t Value) {
  37   return static_cast<signed char>(Value) == Value;
  38 }
  39 inline bool isUInt8 (int64_t Value) {
  40   return static_cast<unsigned char>(Value) == Value;
  41 }
  42 inline bool isInt16 (int64_t Value) {
  43   return static_cast<signed short>(Value) == Value;
  44 }
  45 inline bool isUInt16(int64_t Value) {
  46   return static_cast<unsigned short>(Value) == Value;
  47 }
  48 inline bool isInt32 (int64_t Value) {
  49   return static_cast<signed int>(Value) == Value;
  50 }
  51 inline bool isUInt32(int64_t Value) {
  52   return static_cast<unsigned int>(Value) == Value;
  53 }
  54
  55 /// isMask_32 - This function returns true if the argument is a sequence of ones
  56 /// starting at the least significant bit with the remainder zero (32 bit
  57 /// version).   Ex. isMask_32(0x0000FFFFU) == true.
  58 inline const bool isMask_32(unsigned Value) {
  59   return Value && ((Value + 1) & Value) == 0;
  60 }
  61
  62 /// isMask_64 - This function returns true if the argument is a sequence of ones
  63 /// starting at the least significant bit with the remainder zero (64 bit
  64 /// version).
  65 inline const bool isMask_64(uint64_t Value) {
  66   return Value && ((Value + 1) & Value) == 0;
  67 }
  68
  69 /// isShiftedMask_32 - This function returns true if the argument contains a
  70 /// sequence of ones with the remainder zero (32 bit version.)
  71 /// Ex. isShiftedMask_32(0x0000FF00U) == true.
  72 inline const bool isShiftedMask_32(unsigned Value) {
  73   return isMask_32((Value - 1) | Value);
  74 }
  75
  76 /// isShiftedMask_64 - This function returns true if the argument contains a
  77 /// sequence of ones with the remainder zero (64 bit version.)
  78 inline const bool isShiftedMask_64(uint64_t Value) {
  79   return isMask_64((Value - 1) | Value);
  80 }
  81
  82 /// isPowerOf2_32 - This function returns true if the argument is a power of
  83 /// two > 0. Ex. isPowerOf2_32(0x00100000U) == true (32 bit edition.)
  84 inline bool isPowerOf2_32(unsigned Value) {
  85   return Value && !(Value & (Value - 1));
  86 }
  87
  88 /// isPowerOf2_64 - This function returns true if the argument is a power of two
  89 /// > 0 (64 bit edition.)
  90 inline bool isPowerOf2_64(uint64_t Value) {
  91   return Value && !(Value & (Value - int64_t(1L)));
  92 }
  93
  94 /// ByteSwap_16 - This function returns a byte-swapped representation of the
  95 /// 16-bit argument, Value.
  96 inline unsigned short ByteSwap_16(unsigned short Value) {
  97   unsigned short Hi = Value << 8;
  98   unsigned short Lo = Value >> 8;
  99   return Hi | Lo;
 100 }
 101
 102 /// ByteSwap_32 - This function returns a byte-swapped representation of the
 103 /// 32-bit argument, Value.
 104 inline unsigned ByteSwap_32(unsigned Value) {
 105   unsigned Byte0 = Value & 0x000000FF;
 106   unsigned Byte1 = Value & 0x0000FF00;
 107   unsigned Byte2 = Value & 0x00FF0000;
 108   unsigned Byte3 = Value & 0xFF000000;
 109   return (Byte0 << 24) | (Byte1 << 8) | (Byte2 >> 8) | (Byte3 >> 24);
 110 }
 111
 112 /// ByteSwap_64 - This function returns a byte-swapped representation of the
 113 /// 64-bit argument, Value.
 114 inline uint64_t ByteSwap_64(uint64_t Value) {
 115   uint64_t Hi = ByteSwap_32(unsigned(Value));
 116   uint64_t Lo = ByteSwap_32(unsigned(Value >> 32));
 117   return (Hi << 32) | Lo;
 118 }
 119
 120 /// CountLeadingZeros_32 - this function performs the platform optimal form of
 121 /// counting the number of zeros from the most significant bit to the first one
 122 /// bit.  Ex. CountLeadingZeros_32(0x00F000FF) == 8.
 123 /// Returns 32 if the word is zero.
 124 inline unsigned CountLeadingZeros_32(unsigned Value) {
 125   unsigned Count; // result
 126 #if __GNUC__ >= 4
 127   // PowerPC is defined for __builtin_clz(0)
 128 #if !defined(__ppc__) && !defined(__ppc64__)
 129   if (!Value) return 32;
 130 #endif
 131   Count = __builtin_clz(Value);
 132 #else
 133   if (!Value) return 32;
 134   Count = 0;
 135   // bisecton method for count leading zeros
 136   for (unsigned Shift = 32 >> 1; Shift; Shift >>= 1) {
 137     unsigned Tmp = Value >> Shift;
 138     if (Tmp) {
 139       Value = Tmp;
 140     } else {
 141       Count |= Shift;
 142     }
 143   }
 144 #endif
 145   return Count;
 146 }
 147
 148 /// CountLeadingZeros_64 - This function performs the platform optimal form
 149 /// of counting the number of zeros from the most significant bit to the first
 150 /// one bit (64 bit edition.)
 151 /// Returns 64 if the word is zero.
 152 inline unsigned CountLeadingZeros_64(uint64_t Value) {
 153   unsigned Count; // result
 154 #if __GNUC__ >= 4
 155   // PowerPC is defined for __builtin_clzll(0)
 156 #if !defined(__ppc__) && !defined(__ppc64__)
 157   if (!Value) return 64;
 158 #endif
 159   Count = __builtin_clzll(Value);
 160 #else
 161   if (sizeof(long) == sizeof(int64_t)) {
 162     if (!Value) return 64;
 163     Count = 0;
 164     // bisecton method for count leading zeros
 165     for (uint64_t Shift = 64 >> 1; Shift; Shift >>= 1) {
 166       uint64_t Tmp = Value >> Shift;
 167       if (Tmp) {
 168         Value = Tmp;
 169       } else {
 170         Count |= Shift;
 171       }
 172     }
 173   } else {
 174     // get hi portion
 175     unsigned Hi = Hi_32(Value);
 176
 177     // if some bits in hi portion
 178     if (Hi) {
 179         // leading zeros in hi portion plus all bits in lo portion
 180         Count = CountLeadingZeros_32(Hi);
 181     } else {
 182         // get lo portion
 183         unsigned Lo = Lo_32(Value);
 184         // same as 32 bit value
 185         Count = CountLeadingZeros_32(Lo)+32;
 186     }
 187   }
 188 #endif
 189   return Count;
 190 }
 191
 192 /// CountTrailingZeros_32 - this function performs the platform optimal form of
 193 /// counting the number of zeros from the least significant bit to the first one
 194 /// bit.  Ex. CountTrailingZeros_32(0xFF00FF00) == 8.
 195 /// Returns 32 if the word is zero.
 196 inline unsigned CountTrailingZeros_32(unsigned Value) {
 197   return 32 - CountLeadingZeros_32(~Value & (Value - 1));
 198 }
 199
 200 /// CountTrailingZeros_64 - This function performs the platform optimal form
 201 /// of counting the number of zeros from the least significant bit to the first
 202 /// one bit (64 bit edition.)
 203 /// Returns 64 if the word is zero.
 204 inline unsigned CountTrailingZeros_64(uint64_t Value) {
 205   return 64 - CountLeadingZeros_64(~Value & (Value - 1));
 206 }
 207
 208 /// CountPopulation_32 - this function counts the number of set bits in a value.
 209 /// Ex. CountPopulation(0xF000F000) = 8
 210 /// Returns 0 if the word is zero.
 211 inline unsigned CountPopulation_32(uint32_t Value) {
 212 #if __GNUC__ >= 4
 213   return __builtin_popcount(Value);
 214 #else
 215         uint32_t v = v - ((v >> 1) & 0x55555555);
 216         v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
 217         return ((v + (v >> 4) & 0xF0F0F0F) * 0x1010101) >> 24;
 218 #endif
 219 }
 220
 221 /// CountPopulation_64 - this function counts the number of set bits in a value,
 222 /// (64 bit edition.)
 223 inline unsigned CountPopulation_64(uint64_t Value) {
 224 #if __GNUC__ >= 4
 225   return __builtin_popcountll(Value);
 226 #else
 227         uint64_t v = Value - ((Value >> 1) & 0x5555555555555555ULL);
 228         v = (v & 0x3333333333333333ULL) + ((v >> 2) & 0x3333333333333333ULL);
 229         v = (v + (v >> 4)) & 0x0F0F0F0F0F0F0F0FULL;
 230         return (uint64_t)(v * 0x0101010101010101ULL) >> 56;
 231 #endif
 232 }
 233
 234 /// Log2_32 - This function returns the floor log base 2 of the specified value,
 235 /// -1 if the value is zero. (32 bit edition.)
 236 /// Ex. Log2_32(32) == 5, Log2_32(1) == 0, Log2_32(0) == -1, Log2_32(6) == 2
 237 inline unsigned Log2_32(unsigned Value) {
 238     return 31 - CountLeadingZeros_32(Value);
 239 }
 240
 241 /// Log2_64 - This function returns the floor log base 2 of the specified value,
 242 /// -1 if the value is zero. (64 bit edition.)
 243 inline unsigned Log2_64(uint64_t Value) {
 244     return 63 - CountLeadingZeros_64(Value);
 245 }
 246
 247 /// Log2_32_Ceil - This function returns the ceil log base 2 of the specified
 248 /// value, 32 if the value is zero. (32 bit edition).
 249 /// Ex. Log2_32_Ceil(32) == 5, Log2_32_Ceil(1) == 0, Log2_32_Ceil(6) == 3
 250 inline unsigned Log2_32_Ceil(unsigned Value) {
 251   return 32-CountLeadingZeros_32(Value-1);
 252 }
 253
 254 /// Log2_64 - This function returns the ceil log base 2 of the specified value,
 255 /// 64 if the value is zero. (64 bit edition.)
 256 inline unsigned Log2_64_Ceil(uint64_t Value) {
 257   return 64-CountLeadingZeros_64(Value-1);
 258 }
 259
 260 /// GreatestCommonDivisor64 - Return the greatest common divisor of the two
 261 /// values using Euclid's algorithm.
 262 inline uint64_t GreatestCommonDivisor64(uint64_t A, uint64_t B) {
 263   while (B) {
 264     uint64_t T = B;
 265     B = A % B;
 266     A = T;
 267   }
 268   return A;
 269 }
 270
 271 /// BitsToDouble - This function takes a 64-bit integer and returns the bit
 272 /// equivalent double.
 273 inline double BitsToDouble(uint64_t Bits) {
 274   union {
 275     uint64_t L;
 276     double D;
 277   } T;
 278   T.L = Bits;
 279   return T.D;
 280 }
 281
 282 /// BitsToFloat - This function takes a 32-bit integer and returns the bit
 283 /// equivalent float.
 284 inline float BitsToFloat(uint32_t Bits) {
 285   union {
 286     uint32_t I;
 287     float F;
 288   } T;
 289   T.I = Bits;
 290   return T.F;
 291 }
 292
 293 /// DoubleToBits - This function takes a double and returns the bit
 294 /// equivalent 64-bit integer.
 295 inline uint64_t DoubleToBits(double Double) {
 296   union {
 297     uint64_t L;
 298     double D;
 299   } T;
 300   T.D = Double;
 301   return T.L;
 302 }
 303
 304 /// FloatToBits - This function takes a float and returns the bit
 305 /// equivalent 32-bit integer.
 306 inline uint32_t FloatToBits(float Float) {
 307   union {
 308     uint32_t I;
 309     float F;
 310   } T;
 311   T.F = Float;
 312   return T.I;
 313 }
 314
 315 /// Platform-independent wrappers for the C99 isnan() function.
 316 int IsNAN(float f);
 317 int IsNAN(double d);
 318
 319 /// Platform-independent wrappers for the C99 isinf() function.
 320 int IsInf(float f);
 321 int IsInf(double d);
 322
 323 } // End llvm namespace
 324
 325 #endif