LLVM  3.7.0
Public Member Functions | Static Public Member Functions | List of all members
llvm::bfi_detail::BlockMass Class Reference

Mass of a block. More...

#include <BlockFrequencyInfoImpl.h>

Public Member Functions

 BlockMass ()
 
 BlockMass (uint64_t Mass)
 
uint64_t getMass () const
 
bool isFull () const
 
bool isEmpty () const
 
bool operator! () const
 
BlockMassoperator+= (const BlockMass &X)
 Add another mass. More...
 
BlockMassoperator-= (const BlockMass &X)
 Subtract another mass. More...
 
BlockMassoperator*= (const BranchProbability &P)
 
bool operator== (const BlockMass &X) const
 
bool operator!= (const BlockMass &X) const
 
bool operator<= (const BlockMass &X) const
 
bool operator>= (const BlockMass &X) const
 
bool operator< (const BlockMass &X) const
 
bool operator> (const BlockMass &X) const
 
ScaledNumber< uint64_t > toScaled () const
 Convert to scaled number. More...
 
void dump () const
 
raw_ostreamprint (raw_ostream &OS) const
 

Static Public Member Functions

static BlockMass getEmpty ()
 
static BlockMass getFull ()
 

Detailed Description

Mass of a block.

This class implements a sort of fixed-point fraction always between 0.0 and 1.0. getMass() == UINT64_MAX indicates a value of 1.0.

Masses can be added and subtracted. Simple saturation arithmetic is used, so arithmetic operations never overflow or underflow.

Masses can be multiplied. Multiplication treats full mass as 1.0 and uses an inexpensive floating-point algorithm that's off-by-one (almost, but not quite, maximum precision).

Masses can be scaled by BranchProbability at maximum precision.

Definition at line 67 of file BlockFrequencyInfoImpl.h.

Constructor & Destructor Documentation

llvm::bfi_detail::BlockMass::BlockMass ( )
inline

Definition at line 71 of file BlockFrequencyInfoImpl.h.

Referenced by getEmpty(), and getFull().

llvm::bfi_detail::BlockMass::BlockMass ( uint64_t  Mass)
inlineexplicit

Definition at line 72 of file BlockFrequencyInfoImpl.h.

Member Function Documentation

void BlockMass::dump ( ) const

Definition at line 30 of file BlockFrequencyInfoImpl.cpp.

References llvm::dbgs(), and print().

static BlockMass llvm::bfi_detail::BlockMass::getEmpty ( )
inlinestatic
static BlockMass llvm::bfi_detail::BlockMass::getFull ( )
inlinestatic
uint64_t llvm::bfi_detail::BlockMass::getMass ( ) const
inline
bool llvm::bfi_detail::BlockMass::isEmpty ( ) const
inline
bool llvm::bfi_detail::BlockMass::isFull ( ) const
inline

Definition at line 79 of file BlockFrequencyInfoImpl.h.

Referenced by toScaled().

bool llvm::bfi_detail::BlockMass::operator! ( ) const
inline

Definition at line 82 of file BlockFrequencyInfoImpl.h.

References isEmpty().

Definition at line 109 of file BlockFrequencyInfoImpl.h.

BlockMass& llvm::bfi_detail::BlockMass::operator*= ( const BranchProbability P)
inline

Definition at line 103 of file BlockFrequencyInfoImpl.h.

References llvm::BranchProbability::scale().

BlockMass& llvm::bfi_detail::BlockMass::operator+= ( const BlockMass X)
inline

Add another mass.

Adds another mass, saturating at isFull() rather than overflowing.

Definition at line 87 of file BlockFrequencyInfoImpl.h.

BlockMass& llvm::bfi_detail::BlockMass::operator-= ( const BlockMass X)
inline

Subtract another mass.

Subtracts another mass, saturating at isEmpty() rather than undeflowing.

Definition at line 97 of file BlockFrequencyInfoImpl.h.

bool llvm::bfi_detail::BlockMass::operator< ( const BlockMass X) const
inline

Definition at line 112 of file BlockFrequencyInfoImpl.h.

bool llvm::bfi_detail::BlockMass::operator<= ( const BlockMass X) const
inline

Definition at line 110 of file BlockFrequencyInfoImpl.h.

bool llvm::bfi_detail::BlockMass::operator== ( const BlockMass X) const
inline

Definition at line 108 of file BlockFrequencyInfoImpl.h.

bool llvm::bfi_detail::BlockMass::operator> ( const BlockMass X) const
inline

Definition at line 113 of file BlockFrequencyInfoImpl.h.

bool llvm::bfi_detail::BlockMass::operator>= ( const BlockMass X) const
inline

Definition at line 111 of file BlockFrequencyInfoImpl.h.

raw_ostream & BlockMass::print ( raw_ostream OS) const

Definition at line 38 of file BlockFrequencyInfoImpl.cpp.

References getHexDigit().

Referenced by dump(), and llvm::bfi_detail::operator<<().

ScaledNumber< uint64_t > BlockMass::toScaled ( ) const

Convert to scaled number.

Convert to ScaledNumber. isFull() gives 1.0, while isEmpty() gives slightly above 0.0.

Definition at line 24 of file BlockFrequencyInfoImpl.cpp.

References getMass(), and isFull().

Referenced by llvm::BlockFrequencyInfoImplBase::computeLoopScale(), and llvm::BlockFrequencyInfoImplBase::unwrapLoops().


The documentation for this class was generated from the following files: