class BranchProbability

Declaration

class BranchProbability { /* full declaration omitted */ };

Declared at: llvm/include/llvm/Support/BranchProbability.h:30

Method Overview

• public BranchProbability(uint32_t Numerator, uint32_t Denominator)
• public BranchProbability()
• public void dump() const
• public static llvm::BranchProbability getBranchProbability(uint64_t Numerator, uint64_t Denominator)
• public llvm::BranchProbability getCompl() const
• public static uint32_t getDenominator()
• public uint32_t getNumerator() const
• public static llvm::BranchProbability getOne()
• public static llvm::BranchProbability getRaw(uint32_t N)
• public static llvm::BranchProbability getUnknown()
• public static llvm::BranchProbability getZero()
• public bool isUnknown() const
• public bool isZero() const
• public template <class ProbabilityIter>static void normalizeProbabilities(ProbabilityIter Begin, ProbabilityIter End)
• public llvm::raw_ostream & print(llvm::raw_ostream & OS) const
• public uint64_t scale(uint64_t Num) const
• public uint64_t scaleByInverse(uint64_t Num) const

Methods

¶BranchProbability(uint32_t Numerator,
                  uint32_t Denominator)

Declared at: llvm/include/llvm/Support/BranchProbability.h:44

Parameters

uint32_t Numerator

uint32_t Denominator

¶BranchProbability()

Declared at: llvm/include/llvm/Support/BranchProbability.h:43

¶void dump() const

Declared at: llvm/include/llvm/Support/BranchProbability.h:73

¶static llvm::BranchProbability
getBranchProbability(uint64_t Numerator,
                     uint64_t Denominator)

Declared at: llvm/include/llvm/Support/BranchProbability.h:56

Parameters

uint64_t Numerator

uint64_t Denominator

¶llvm::BranchProbability getCompl() const

Declared at: llvm/include/llvm/Support/BranchProbability.h:69

¶static uint32_t getDenominator()

Declared at: llvm/include/llvm/Support/BranchProbability.h:66

¶uint32_t getNumerator() const

Declared at: llvm/include/llvm/Support/BranchProbability.h:65

¶static llvm::BranchProbability getOne()

Declared at: llvm/include/llvm/Support/BranchProbability.h:50

¶static llvm::BranchProbability getRaw(uint32_t N)

Declared at: llvm/include/llvm/Support/BranchProbability.h:54

Parameters

uint32_t N

¶static llvm::BranchProbability getUnknown()

Declared at: llvm/include/llvm/Support/BranchProbability.h:51

¶static llvm::BranchProbability getZero()

Declared at: llvm/include/llvm/Support/BranchProbability.h:49

¶bool isUnknown() const

Declared at: llvm/include/llvm/Support/BranchProbability.h:47

¶bool isZero() const

Declared at: llvm/include/llvm/Support/BranchProbability.h:46

¶template <class ProbabilityIter>
static void normalizeProbabilities(
    ProbabilityIter Begin,
    ProbabilityIter End)

Declared at: llvm/include/llvm/Support/BranchProbability.h:62

Templates

ProbabilityIter

Parameters

ProbabilityIter Begin

ProbabilityIter End

¶llvm::raw_ostream& print(
    llvm::raw_ostream& OS) const

Declared at: llvm/include/llvm/Support/BranchProbability.h:71

Parameters

llvm::raw_ostream& OS

¶uint64_t scale(uint64_t Num) const

Description

Scale a large integer. Scales \c Num. Guarantees full precision. Returns the floor of the result.

Declared at: llvm/include/llvm/Support/BranchProbability.h:81

Parameters

uint64_t Num

Returns

\c Num times \c this.

¶uint64_t scaleByInverse(uint64_t Num) const

Description

Scale a large integer by the inverse. Scales \c Num by the inverse of \c this. Guarantees full precision. Returns the floor of the result.

Declared at: llvm/include/llvm/Support/BranchProbability.h:89

Parameters

uint64_t Num

Returns

\c Num divided by \c this.