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

[APInt] Fix documentation of *OrSelf methods 

Document that truncOrSelf, zextOrSelf and sextOrSelf only enforce
an upper or lower bound on the bitwidth of the result.
This commit is contained in:
Jay Foad 2022-05-13 14:17:23 +01:00
parent d364307542
commit fcbf617dcc
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
llvm/include/llvm/ADT/APInt.h
View File

@ -1261,22 +1261,16 @@ public:
/// extended, truncated, or left alone to make it that width.
APInt zextOrTrunc(unsigned width) const;
/// Truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is
/// truncated or left alone to make it that width.
/// Truncate this APInt if necessary to ensure that its bit width is <= \p
/// width.
APInt truncOrSelf(unsigned width) const;
/// Sign extend or truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is sign
/// extended, or left alone to make it that width.
/// Sign-extend this APInt if necessary to ensure that its bit width is >= \p
/// width.
APInt sextOrSelf(unsigned width) const;
/// Zero extend or truncate to width
///
/// Make this APInt have the bit width given by \p width. The value is zero
/// extended, or left alone to make it that width.
/// Zero-extend this APInt if necessary to ensure that its bit width is >= \p
/// width.
APInt zextOrSelf(unsigned width) const;
/// @}