maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

Test commit. Improve comments in APInt. NFC. 

llvm-svn: 234158
This commit is contained in:
Pawel Bylica 2015-04-06 13:31:39 +00:00
parent ac17bfd699
commit 6eeeac7b2a
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
llvm/lib/Support/APInt.cpp
View File

@ -162,7 +162,7 @@ APInt& APInt::operator=(uint64_t RHS) {
return clearUnusedBits(); return clearUnusedBits();
} }
/// Profile - This method 'profiles' an APInt for use with FoldingSet. /// This method 'profiles' an APInt for use with FoldingSet.
void APInt::Profile(FoldingSetNodeID& ID) const { void APInt::Profile(FoldingSetNodeID& ID) const {
ID.AddInteger(BitWidth); ID.AddInteger(BitWidth);
@ -176,7 +176,7 @@ void APInt::Profile(FoldingSetNodeID& ID) const {
ID.AddInteger(pVal[i]); ID.AddInteger(pVal[i]);
} }
/// add_1 - This function adds a single "digit" integer, y, to the multiple /// This function adds a single "digit" integer, y, to the multiple
/// "digit" integer array, x[]. x[] is modified to reflect the addition and /// "digit" integer array, x[]. x[] is modified to reflect the addition and
/// 1 is returned if there is a carry out, otherwise 0 is returned. /// 1 is returned if there is a carry out, otherwise 0 is returned.
/// @returns the carry of the addition. /// @returns the carry of the addition.
@ -202,7 +202,7 @@ APInt& APInt::operator++() {
return clearUnusedBits(); return clearUnusedBits();
} }
/// sub_1 - This function subtracts a single "digit" (64-bit word), y, from /// This function subtracts a single "digit" (64-bit word), y, from
/// the multi-digit integer array, x[], propagating the borrowed 1 value until /// the multi-digit integer array, x[], propagating the borrowed 1 value until
/// no further borrowing is neeeded or it runs out of "digits" in x. The result /// no further borrowing is neeeded or it runs out of "digits" in x. The result
/// is 1 if "borrowing" exhausted the digits in x, or 0 if x was not exhausted. /// is 1 if "borrowing" exhausted the digits in x, or 0 if x was not exhausted.
@ -231,7 +231,7 @@ APInt& APInt::operator--() {
return clearUnusedBits(); return clearUnusedBits();
} }
/// add - This function adds the integer array x to the integer array Y and /// This function adds the integer array x to the integer array Y and
/// places the result in dest. /// places the result in dest.
/// @returns the carry out from the addition /// @returns the carry out from the addition
/// @brief General addition of 64-bit integer arrays /// @brief General addition of 64-bit integer arrays
@ -680,12 +680,12 @@ bool APInt::isSplat(unsigned SplatSizeInBits) const {
return *this == rotl(SplatSizeInBits); return *this == rotl(SplatSizeInBits);
} }
/// HiBits - This function returns the high "numBits" bits of this APInt. /// This function returns the high "numBits" bits of this APInt.
APInt APInt::getHiBits(unsigned numBits) const { APInt APInt::getHiBits(unsigned numBits) const {
return APIntOps::lshr(*this, BitWidth - numBits); return APIntOps::lshr(*this, BitWidth - numBits);
} }
/// LoBits - This function returns the low "numBits" bits of this APInt. /// This function returns the low "numBits" bits of this APInt.
APInt APInt::getLoBits(unsigned numBits) const { APInt APInt::getLoBits(unsigned numBits) const {
return APIntOps::lshr(APIntOps::shl(*this, BitWidth - numBits), return APIntOps::lshr(APIntOps::shl(*this, BitWidth - numBits),
BitWidth - numBits); BitWidth - numBits);
@ -861,7 +861,7 @@ APInt llvm::APIntOps::RoundDoubleToAPInt(double Double, unsigned width) {
return isNeg ? -Tmp : Tmp; return isNeg ? -Tmp : Tmp;
} }
/// RoundToDouble - This function converts this APInt to a double. /// This function converts this APInt to a double.
/// The layout for double is as following (IEEE Standard 754): /// The layout for double is as following (IEEE Standard 754):
/// -------------------------------------- /// --------------------------------------
/// | Sign Exponent Fraction Bias | /// | Sign Exponent Fraction Bias |
@ -2269,9 +2269,8 @@ void APInt::toString(SmallVectorImpl<char> &Str, unsigned Radix,
std::reverse(Str.begin()+StartDig, Str.end()); std::reverse(Str.begin()+StartDig, Str.end());
} }
/// toString - This returns the APInt as a std::string. Note that this is an /// Returns the APInt as a std::string. Note that this is an inefficient method.
/// inefficient method. It is better to pass in a SmallVector/SmallString /// It is better to pass in a SmallVector/SmallString to the methods above.
/// to the methods above.
std::string APInt::toString(unsigned Radix = 10, bool Signed = true) const { std::string APInt::toString(unsigned Radix = 10, bool Signed = true) const {
SmallString<40> S; SmallString<40> S;
toString(S, Radix, Signed, /* formatAsCLiteral = */false); toString(S, Radix, Signed, /* formatAsCLiteral = */false);