Author: meinersbur
Date: Wed Feb 24 16:07:57 2016
New Revision: 261785
URL: http://llvm.org/viewvc/llvm-project?rev=261785&view=rev
Log:
Proofreading comments in DependenceInfo.h. NFC.
Typos, commas and other minor changes
(e.g. "dependences struct" -> "Dependences struct", because it is the
struct's name)
Modified:
polly/trunk/include/polly/DependenceInfo.h
Modified: polly/trunk/include/polly/DependenceInfo.h
URL: http://llvm.org/viewvc/llvm-project/polly/trunk/include/polly/DependenceInfo.h?rev=261785&r1=261784&r2=261785&view=diff
==============================================================================
--- polly/trunk/include/polly/DependenceInfo.h (original)
+++ polly/trunk/include/polly/DependenceInfo.h Wed Feb 24 16:07:57 2016
@@ -9,13 +9,13 @@
//
// Calculate the data dependency relations for a Scop using ISL.
//
-// The integer set library (ISL) from Sven, has a integrated dependency analysis
+// The integer set library (ISL) from Sven has an integrated dependency analysis
// to calculate data dependences. This pass takes advantage of this and
-// calculate those dependences a Scop.
+// calculates those dependences of a Scop.
//
// The dependences in this pass are exact in terms that for a specific read
// statement instance only the last write statement instance is returned. In
-// case of may writes a set of possible write instances is returned. This
+// case of may-writes, a set of possible write instances is returned. This
// analysis will never produce redundant dependences.
//
//===----------------------------------------------------------------------===//
@@ -43,7 +43,7 @@ class MemoryAccess;
/// @brief The accumulated dependence information for a SCoP.
///
-/// The dependences struct holds all dependence information we collect and
+/// The Dependences struct holds all dependence information we collect and
/// compute for one SCoP. It also offers an interface that allows users to
/// query only specific parts.
struct Dependences {
@@ -57,13 +57,13 @@ struct Dependences {
/// @brief The type of the dependences.
///
/// Reduction dependences are separated from RAW/WAW/WAR dependences because
- /// we can ignore them during the scheduling. This is the case since the order
+ /// we can ignore them during the scheduling. That's because the order
/// in which the reduction statements are executed does not matter. However,
/// if they are executed in parallel we need to take additional measures
/// (e.g, privatization) to ensure a correct result. The (reverse) transitive
/// closure of the reduction dependences are used to check for parallel
/// executed reduction statements during code generation. These dependences
- /// connect all instances of a reduction with each other, they are therefor
+ /// connect all instances of a reduction with each other, they are therefore
/// cyclic and possibly "reversed".
enum Type {
// Write after read
@@ -121,11 +121,11 @@ struct Dependences {
/// @param S The current SCoP.
/// @param NewSchedules The new schedules
///
- /// @return bool True if the new schedule is valid, false it it reverses
- /// dependences.
+ /// @return True if the new schedule is valid, false it it reverses
+ /// dependences.
bool isValidSchedule(Scop &S, StatementToIslMapTy *NewSchedules) const;
- /// @brief Print the dependence information stored.
+ /// @brief Print the stored dependence information.
void print(llvm::raw_ostream &OS) const;
/// @brief Dump the dependence information stored to the dbgs stream.
@@ -133,15 +133,15 @@ struct Dependences {
/// @brief Allow the DependenceInfo access to private members and methods.
///
- /// To restict access to the internal state only the DependenceInfo class
- /// is able to call or modify a dependences struct.
+ /// To restrict access to the internal state, only the DependenceInfo class
+ /// is able to call or modify a Dependences struct.
friend class DependenceInfo;
/// @brief Destructor that will free internal objects.
~Dependences() { releaseMemory(); }
private:
- /// @brief Create an empty dependences struct.
+ /// @brief Create an empty Dependences struct.
explicit Dependences(const std::shared_ptr<isl_ctx> &IslCtx)
: RAW(nullptr), WAR(nullptr), WAW(nullptr), RED(nullptr), TC_RED(nullptr),
IslCtx(IslCtx) {}
@@ -155,9 +155,9 @@ private:
/// @brief Set the reduction dependences for @p MA to @p Deps.
void setReductionDependences(MemoryAccess *MA, __isl_take isl_map *Deps);
- /// @brief Free the objects associated with this dependences struct.
+ /// @brief Free the objects associated with this Dependences struct.
///
- /// The dependences struct will again be "empty" afterwards.
+ /// The Dependences struct will again be "empty" afterwards.
void releaseMemory();
/// @brief The different basic kinds of dependences we calculate.
@@ -174,7 +174,7 @@ private:
/// @brief Mapping from memory accesses to their reduction dependences.
ReductionDependencesMapTy ReductionDependences;
- /// Isl context from the SCoP.
+ /// @brief Isl context from the SCoP.
std::shared_ptr<isl_ctx> IslCtx;
};