BranchProbability.h [plain text]
#ifndef LLVM_SUPPORT_BRANCHPROBABILITY_H
#define LLVM_SUPPORT_BRANCHPROBABILITY_H
#include "llvm/Support/DataTypes.h"
#include <cassert>
namespace llvm {
class raw_ostream;
class BranchProbability {
uint32_t N;
static const uint32_t D = 1u << 31;
static const uint32_t UnknownN = UINT32_MAX;
explicit BranchProbability(uint32_t n) : N(n) {}
public:
BranchProbability() : N(0) {}
BranchProbability(uint32_t Numerator, uint32_t Denominator);
bool isZero() const { return N == 0; }
bool isUnknown() const { return N == UnknownN; }
static BranchProbability getZero() { return BranchProbability(0); }
static BranchProbability getOne() { return BranchProbability(D); }
static BranchProbability getUnknown() { return BranchProbability(UnknownN); }
static BranchProbability getRaw(uint32_t N) { return BranchProbability(N); }
template <class ProbabilityList>
static void normalizeProbabilities(ProbabilityList &Probs);
uint32_t getNumerator() const { return N; }
static uint32_t getDenominator() { return D; }
BranchProbability getCompl() const { return BranchProbability(D - N); }
raw_ostream &print(raw_ostream &OS) const;
void dump() const;
uint64_t scale(uint64_t Num) const;
uint64_t scaleByInverse(uint64_t Num) const;
BranchProbability &operator+=(BranchProbability RHS) {
assert(N <= D - RHS.N &&
"The sum of branch probabilities should not exceed one!");
N += RHS.N;
return *this;
}
BranchProbability &operator-=(BranchProbability RHS) {
assert(N >= RHS.N &&
"Can only subtract a smaller probability from a larger one!");
N -= RHS.N;
return *this;
}
BranchProbability &operator*=(BranchProbability RHS) {
N = (static_cast<uint64_t>(N) * RHS.N + D / 2) / D;
return *this;
}
BranchProbability operator+(BranchProbability RHS) const {
BranchProbability Prob(*this);
return Prob += RHS;
}
BranchProbability operator-(BranchProbability RHS) const {
BranchProbability Prob(*this);
return Prob -= RHS;
}
BranchProbability operator*(BranchProbability RHS) const {
BranchProbability Prob(*this);
return Prob *= RHS;
}
bool operator==(BranchProbability RHS) const { return N == RHS.N; }
bool operator!=(BranchProbability RHS) const { return !(*this == RHS); }
bool operator<(BranchProbability RHS) const { return N < RHS.N; }
bool operator>(BranchProbability RHS) const { return RHS < *this; }
bool operator<=(BranchProbability RHS) const { return !(RHS < *this); }
bool operator>=(BranchProbability RHS) const { return !(*this < RHS); }
};
inline raw_ostream &operator<<(raw_ostream &OS, BranchProbability Prob) {
return Prob.print(OS);
}
inline BranchProbability operator/(BranchProbability LHS, uint32_t RHS) {
return BranchProbability::getRaw(LHS.getNumerator() / RHS);
}
template <class ProbabilityList>
void BranchProbability::normalizeProbabilities(ProbabilityList &Probs) {
uint64_t Sum = 0;
for (auto Prob : Probs)
Sum += Prob.N;
assert(Sum > 0);
for (auto &Prob : Probs)
Prob.N = (Prob.N * uint64_t(D) + Sum / 2) / Sum;
}
}
#endif