[llvm-commits] CVS: llvm/docs/ProgrammersManual.html

[Reid Spencer]

Changes in directory llvm/docs:

ProgrammersManual.html updated: 1.127 -> 1.128
---
Log message:

Clarify the use of getValue/getSExtValue/getZExtValue and add the new
APInt constructor.


---
Diffs of the changes:  (+15 -5)

 ProgrammersManual.html |   20 +++++++++++++++-----
 1 files changed, 15 insertions(+), 5 deletions(-)


Index: llvm/docs/ProgrammersManual.html
diff -u llvm/docs/ProgrammersManual.html:1.127 llvm/docs/ProgrammersManual.html:1.128
--- llvm/docs/ProgrammersManual.html:1.127	Thu Feb 15 22:37:31 2007
+++ llvm/docs/ProgrammersManual.html	Thu Mar  1 15:05:33 2007
@@ -2621,10 +2621,20 @@
   <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>
@@ -3050,7 +3060,7 @@
   <a href="mailto:dhurjati at cs.uiuc.edu">Dinakar Dhurjati</a> and
   <a href="mailto:sabre at nondot.org">Chris Lattner</a><br>
   <a href="http://llvm.org">The LLVM Compiler Infrastructure</a><br>
-  Last modified: $Date: 2007/02/16 04:37:31 $
+  Last modified: $Date: 2007/03/01 21:05:33 $
 </address>
 
 </body>