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 // CountLeadingZeros_32 - this function performs the platform optimal form
  87 // of counting the number of zeros from the most significant bit to the first
  88 // one bit.  Ex. CountLeadingZeros_32(0x00F000FF) == 8.
  89 // Returns 32 if the word is zero.
  90 inline unsigned CountLeadingZeros_32(unsigned Value) {
  91   unsigned Count; // result
  92 #if __GNUC__ >= 4
  93   // PowerPC is defined for __builtin_clz(0)
  94 #if !defined(__ppc__) && !defined(__ppc64__)
  95   if (!Value) return 32;
  96 #endif
  97   Count = __builtin_clz(Value);
  98 #else
  99   if (!Value) return 32;
 100   Count = 0;
 101   // bisecton method for count leading zeros
 102   for (unsigned Shift = 32 >> 1; Shift; Shift >>= 1) {
 103     unsigned Tmp = Value >> Shift;
 104     if (Tmp) {
 105       Value = Tmp;
 106     } else {
 107       Count |= Shift;
 108     }
 109   }
 110 #endif
 111   return Count;
 112 }
 113
 114 // CountLeadingZeros_64 - This function performs the platform optimal form
 115 // of counting the number of zeros from the most significant bit to the first
 116 // one bit (64 bit edition.)
 117 // Returns 64 if the word is zero.
 118 inline unsigned CountLeadingZeros_64(uint64_t Value) {
 119   unsigned Count; // result
 120 #if __GNUC__ >= 4
 121   // PowerPC is defined for __builtin_clzll(0)
 122 #if !defined(__ppc__) && !defined(__ppc64__)
 123   if (!Value) return 64;
 124 #endif
 125   Count = __builtin_clzll(Value);
 126 #else
 127   if (sizeof(long) == sizeof(int64_t)) {
 128     if (!Value) return 64;
 129     Count = 0;
 130     // bisecton method for count leading zeros
 131     for (uint64_t Shift = 64 >> 1; Shift; Shift >>= 1) {
 132       uint64_t Tmp = Value >> Shift;
 133       if (Tmp) {
 134         Value = Tmp;
 135       } else {
 136         Count |= Shift;
 137       }
 138     }
 139   } else {
 140     // get hi portion
 141     unsigned Hi = Hi_32(Value);
 142
 143     // if some bits in hi portion
 144     if (Hi) {
 145         // leading zeros in hi portion plus all bits in lo portion
 146         Count = CountLeadingZeros_32(Hi);
 147     } else {
 148         // get lo portion
 149         unsigned Lo = Lo_32(Value);
 150         // same as 32 bit value
 151         Count = CountLeadingZeros_32(Lo)+32;
 152     }
 153   }
 154 #endif
 155   return Count;
 156 }
 157
 158 // Log2_32 - This function returns the floor log base 2 of the specified value,
 159 // -1 if the value is zero. (32 bit edition.)
 160 // Ex. Log2_32(32) == 5, Log2_32(1) == 0, Log2_32(0) == -1
 161 inline unsigned Log2_32(unsigned Value) {
 162     return 31 - CountLeadingZeros_32(Value);
 163   }
 164
 165 // Log2_64 - This function returns the floor log base 2 of the specified value,
 166 // -1 if the value is zero. (64 bit edition.)
 167 inline unsigned Log2_64(uint64_t Value) {
 168     return 63 - CountLeadingZeros_64(Value);
 169 }
 170
 171 // Platform-independent wrappers for the C99 isnan() function.
 172 int IsNAN (float f);
 173 int IsNAN (double d);
 174
 175 // Platform-independent wrappers for the C99 isinf() function.
 176 int IsInf (float f);
 177 int IsInf (double d);
 178
 179 } // End llvm namespace
 180
 181 #endif