Make this clearer for the mathematically inclined. Thanks to Duncan Sands for

[oota-llvm.git] / include / llvm / Support / ConstantRange.h

diff --git a/include/llvm/Support/ConstantRange.h b/include/llvm/Support/ConstantRange.h
index 27585491b38f2c7bd3f0037d3a44ccc3dd14b815..cbf3f87a3543cd95f95c0d7cf9f5eb991114e7ba 100644 (file)
--- a/include/llvm/Support/ConstantRange.h
+++ b/include/llvm/Support/ConstantRange.h
@@ -58,9 +58,13 @@ public:
   /// assert out if the two APInt's are not the same bit width.
   ConstantRange(const APInt& Lower, const APInt& Upper);
 
-  /// makeICmpRegion - Return the range of values that a value must be within
-  /// in order for the comparison specified by the predicate against range
-  /// Other to be true.
+  /// makeICmpRegion - Produce the smallest range that contains all values that
+  /// might satisfy the comparison specified by Pred when compared to any value
+  /// contained within Other.
+  ///
+  /// Solves for range X in 'for all x in X, there exists a y in Y such that
+  /// icmp op x, y is true'. Every value that might make the comparison true
+  /// is included in the resulting range.
   static ConstantRange makeICmpRegion(unsigned Pred,
                                       const ConstantRange &Other);