mirror of
https://github.com/RPCS3/llvm.git
synced 2026-01-31 01:25:19 +01:00
26b584c691
We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all. Patch produced by for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done Differential Revision: https://reviews.llvm.org/D46290 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@331272 91177308-0d34-0410-b5e6-96231b3b80d8
83 lines
2.4 KiB
C++
83 lines
2.4 KiB
C++
//===-------- BlockFrequency.h - Block Frequency Wrapper --------*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file implements Block Frequency class.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_SUPPORT_BLOCKFREQUENCY_H
|
|
#define LLVM_SUPPORT_BLOCKFREQUENCY_H
|
|
|
|
#include "llvm/Support/BranchProbability.h"
|
|
#include "llvm/Support/DataTypes.h"
|
|
|
|
namespace llvm {
|
|
|
|
class raw_ostream;
|
|
|
|
// This class represents Block Frequency as a 64-bit value.
|
|
class BlockFrequency {
|
|
uint64_t Frequency;
|
|
|
|
public:
|
|
BlockFrequency(uint64_t Freq = 0) : Frequency(Freq) { }
|
|
|
|
/// Returns the maximum possible frequency, the saturation value.
|
|
static uint64_t getMaxFrequency() { return -1ULL; }
|
|
|
|
/// Returns the frequency as a fixpoint number scaled by the entry
|
|
/// frequency.
|
|
uint64_t getFrequency() const { return Frequency; }
|
|
|
|
/// Multiplies with a branch probability. The computation will never
|
|
/// overflow.
|
|
BlockFrequency &operator*=(BranchProbability Prob);
|
|
BlockFrequency operator*(BranchProbability Prob) const;
|
|
|
|
/// Divide by a non-zero branch probability using saturating
|
|
/// arithmetic.
|
|
BlockFrequency &operator/=(BranchProbability Prob);
|
|
BlockFrequency operator/(BranchProbability Prob) const;
|
|
|
|
/// Adds another block frequency using saturating arithmetic.
|
|
BlockFrequency &operator+=(BlockFrequency Freq);
|
|
BlockFrequency operator+(BlockFrequency Freq) const;
|
|
|
|
/// Subtracts another block frequency using saturating arithmetic.
|
|
BlockFrequency &operator-=(BlockFrequency Freq);
|
|
BlockFrequency operator-(BlockFrequency Freq) const;
|
|
|
|
/// Shift block frequency to the right by count digits saturating to 1.
|
|
BlockFrequency &operator>>=(const unsigned count);
|
|
|
|
bool operator<(BlockFrequency RHS) const {
|
|
return Frequency < RHS.Frequency;
|
|
}
|
|
|
|
bool operator<=(BlockFrequency RHS) const {
|
|
return Frequency <= RHS.Frequency;
|
|
}
|
|
|
|
bool operator>(BlockFrequency RHS) const {
|
|
return Frequency > RHS.Frequency;
|
|
}
|
|
|
|
bool operator>=(BlockFrequency RHS) const {
|
|
return Frequency >= RHS.Frequency;
|
|
}
|
|
|
|
bool operator==(BlockFrequency RHS) const {
|
|
return Frequency == RHS.Frequency;
|
|
}
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|