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 type
  22 // overloading so that signed and unsigned integers can be used without ambiguity.
  23
  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 (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 (unsigned)Value;
  33 }
  34
  35 // is?Type - these functions produce optimal testing for integer data types.
  36 inline bool isInt8  (int Value)     { return (  signed char )Value == Value; }
  37 inline bool isUInt8 (int Value)     { return (unsigned char )Value == Value; }
  38 inline bool isInt16 (int Value)     { return (  signed short)Value == Value; }
  39 inline bool isUInt16(int Value)     { return (unsigned short)Value == Value; }
  40 inline bool isInt32 (int64_t Value) { return (  signed int  )Value == Value; }
  41 inline bool isUInt32(int64_t Value) { return (unsigned int  )Value == Value; }
  42
  43 // isMask_32 - This function returns true if the argument is a sequence of ones starting
  44 // at the least significant bit with the remainder zero (32 bit version.)
  45 // Ex. isMask_32(0x0000FFFFU) == true.
  46 inline const bool isMask_32(unsigned Value) {
  47   return Value && ((Value + 1) & Value) == 0;
  48 }
  49
  50 // isMask_64 - This function returns true if the argument is a sequence of ones starting
  51 // at the least significant bit with the remainder zero (64 bit version.)
  52 inline const bool isMask_64(uint64_t Value) {
  53   return Value && ((Value + 1) & Value) == 0;
  54 }
  55
  56 // isShiftedMask_32 - This function returns true if the argument contains a sequence of ones
  57 // with the remainder zero (32 bit version.)
  58 // Ex. isShiftedMask_32(0x0000FF00U) == true.
  59 inline const bool isShiftedMask_32(unsigned Value) {
  60   return isMask_32((Value - 1) | Value);
  61 }
  62
  63 // isShiftedMask_64 - This function returns true if the argument contains a sequence of ones
  64 // with the remainder zero (64 bit version.)
  65 inline const bool isShiftedMask_64(uint64_t Value) {
  66   return isMask_64((Value - 1) | Value);
  67 }
  68
  69 // isPowerOf2_32 - This function returns true if the argument is a power of two > 0.
  70 // Ex. isPowerOf2_32(0x00100000U) == true (32 bit edition.)
  71 inline bool isPowerOf2_32(unsigned Value) {
  72   return Value && !(Value & (Value - 1));
  73 }
  74
  75 // isPowerOf2_64 - This function returns true if the argument is a power of two > 0
  76 // (64 bit edition.)
  77 inline bool isPowerOf2_64(uint64_t Value) {
  78   return Value && !(Value & (Value - 1LL));
  79 }
  80
  81 // CountLeadingZeros_32 - this function performs the platform optimal form
  82 // of counting the number of zeros from the most significant bit to the first one bit.
  83 // Ex. CountLeadingZeros_32(0x00F000FF) == 8.
  84 // Returns 32 if the word is zero.
  85 inline unsigned CountLeadingZeros_32(unsigned Value) {
  86   unsigned Count; // result
  87   #if __GNUC__ >= 4
  88     // PowerPC is defined for __builtin_clz(0)
  89     #if !defined(__ppc__) && !defined(__ppc64__)
  90       if (!Value) return 32;
  91     #endif
  92     Count = __builtin_clz(Value);
  93   #else
  94     if (!Value) return 32;
  95     Count = 0;
  96     // bisecton method for count leading zeros
  97     for (unsigned Shift = 32 >> 1; Shift; Shift >>= 1) {
  98         unsigned Tmp = Value >> Shift;
  99         if (Tmp) {
 100             Count |= Shift;
 101             Value = Tmp;
 102         }
 103     }
 104   #endif
 105   return Count;
 106 }
 107
 108 // CountLeadingZeros_64 - This function performs the platform optimal form
 109 // of counting the number of zeros from the most significant bit to the first one bit
 110 // (64 bit edition.)
 111 // Returns 64 if the word is zero.
 112 inline unsigned CountLeadingZeros_64(uint64_t Value) {
 113   unsigned Count; // result
 114   #if __GNUC__ >= 4
 115     // PowerPC is defined for __builtin_clzll(0)
 116     #if !defined(__ppc__) && !defined(__ppc64__)
 117       if (!Value) return 64;
 118     #endif
 119     Count = __builtin_clzll(Value);
 120   #else
 121   if (sizeof(long) == sizeof(int64_t)) {
 122     if (!Value) return 64;
 123     Count = 0;
 124     // bisecton method for count leading zeros
 125     for (uint64_t Shift = 64 >> 1; Shift; Shift >>= 1) {
 126       uint64_t Tmp = Value >> Shift;
 127       if (Tmp) {
 128         Count |= Shift;
 129         Value = Tmp;
 130       }
 131     }
 132   } else {
 133     // get hi portion
 134     unsigned Hi = Hi_32(Value);
 135
 136     // if some bits in hi portion
 137     if (Hi) {
 138         // leading zeros in hi portion plus all bits in lo portion
 139         Count = CountLeadingZeros_32(Hi) + 32;
 140     } else {
 141         // get lo portion
 142         unsigned Lo = Lo_32(Value);
 143         // same as 32 bit value
 144         Count = CountLeadingZeros_32(Lo);
 145     }
 146   }
 147 #endif
 148   return Count;
 149 }
 150
 151 // Log2_32 - This function returns the floor log base 2 of the specified value, -1 if the value is zero.
 152 // (32 bit edition.)
 153 // Ex. Log2_32(32) == 5, Log2_32(1) == 0, Log2_32(0) == -1
 154 inline unsigned Log2_32(unsigned Value) {
 155     return 31 - CountLeadingZeros_32(Value);
 156   }
 157
 158 // Log2_64 - This function returns the floor log base 2 of the specified value, -1 if the value is zero.
 159 // (64 bit edition.)
 160 inline unsigned Log2_64(unsigned Value) {
 161     return 63 - CountLeadingZeros_64(Value);
 162 }
 163
 164 // Platform-independent wrappers for the C99 isnan() function.
 165 int IsNAN (float f);
 166 int IsNAN (double d);
 167
 168 // Platform-independent wrappers for the C99 isinf() function.
 169 int IsInf (float f);
 170 int IsInf (double d);
 171
 172 } // End llvm namespace
 173
 174 #endif