From: Dan Gohman <gohman@apple.com>
Date: Tue, 19 May 2009 01:52:46 +0000 (+0000)
Subject: Add some comments noting how IndVarSimplify facilitates
X-Git-Url: http://plrg.eecs.uci.edu/git/?a=commitdiff_plain;h=6c3534c5aa6b1d34b277dfaca3af86ac41e53f0e;p=oota-llvm.git

Add some comments noting how IndVarSimplify facilitates
LoopInfo functionality.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@72091 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/llvm/Analysis/LoopInfo.h b/include/llvm/Analysis/LoopInfo.h
index 69773a66ec1..fb0b584d41c 100644
--- a/include/llvm/Analysis/LoopInfo.h
+++ b/include/llvm/Analysis/LoopInfo.h
@@ -351,6 +351,9 @@ public:
   /// by one each time through the loop.  If so, return the phi node that
   /// corresponds to it.
   ///
+  /// The IndVarSimplify pass transforms loops to have a canonical induction
+  /// variable.
+  ///
   inline PHINode *getCanonicalInductionVariable() const {
     BlockT *H = getHeader();
 
@@ -406,6 +409,9 @@ public:
   /// of the loop executes N-1 times.  If the trip-count cannot be determined,
   /// this returns null.
   ///
+  /// The IndVarSimplify pass transforms loops to have a form that this
+  /// function easily understands.
+  ///
   inline Value *getTripCount() const {
     // Canonical loops will end with a 'cmp ne I, V', where I is the incremented
     // canonical induction variable and V is the trip count of the loop.