diff options
| author | Reid Spencer <rspencer@reidspencer.com> | 2007-03-01 21:05:33 +0000 |
|---|---|---|
| committer | Reid Spencer <rspencer@reidspencer.com> | 2007-03-01 21:05:33 +0000 |
| commit | bbd97b1edb488d13f60baf1be59877ad912725a5 (patch) | |
| tree | 3a9060e15ff063d826885e88796392be07bd206a /llvm/docs/ProgrammersManual.html | |
| parent | 5b0548de77af8ca9fe22e87ce937b0cafb5152eb (diff) | |
| download | bcm5719-llvm-bbd97b1edb488d13f60baf1be59877ad912725a5.tar.gz bcm5719-llvm-bbd97b1edb488d13f60baf1be59877ad912725a5.zip | |
Clarify the use of getValue/getSExtValue/getZExtValue and add the new
APInt constructor.
llvm-svn: 34811
Diffstat (limited to 'llvm/docs/ProgrammersManual.html')
| -rw-r--r-- | llvm/docs/ProgrammersManual.html | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/llvm/docs/ProgrammersManual.html b/llvm/docs/ProgrammersManual.html index df8f4abf470..031c86b9111 100644 --- a/llvm/docs/ProgrammersManual.html +++ b/llvm/docs/ProgrammersManual.html @@ -2621,10 +2621,20 @@ a subclass, which represents the address of a global variable or function. <li>ConstantInt : This subclass of Constant represents an integer constant of any width. <ul> - <li><tt>int64_t getSExtValue() const</tt>: Returns the underlying value of - this constant as a sign extended signed integer value.</li> - <li><tt>uint64_t getZExtValue() const</tt>: Returns the underlying value - of this constant as a zero extended unsigned integer value.</li> + <li><tt>const APInt& getValue() const</tt>: Returns the underlying + value of this constant, an APInt value.</li> + <li><tt>int64_t getSExtValue() const</tt>: Converts the underlying APInt + value to an int64_t via sign extension. If the value (not the bit width) + of the APInt is too large to fit in an int64_t, an assertion will result. + For this reason, use of this method is discouraged.</li> + <li><tt>uint64_t getZExtValue() const</tt>: Converts the underlying APInt + value to a uint64_t via zero extension. IF the value (not the bit width) + of the APInt is too large to fit in a uint64_t, an assertion will result. + For this reason, use of this method is discourage.</li> + <li><tt>static ConstantInt* get(const APInt& Val)</tt>: Returns the + ConstantInt object that represents the value provided by <tt>Val</tt>. + The type is implied as the IntegerType that corresponds to the bit width + of <tt>Val</tt>.</li> <li><tt>static ConstantInt* get(const Type *Ty, uint64_t Val)</tt>: Returns the ConstantInt object that represents the value provided by <tt>Val</tt> for integer type <tt>Ty</tt>.</li> |
