[llvm] 45cc743 - [SandboxVec][DAG][NFC] Add comment about duplicate notes in deps() (#111915)

[via llvm-commits]

Author: vporpo
Date: 2024-10-10T16:22:13-07:00
New Revision: 45cc74357130190b9aef9fab77646c17f2cf2a5e

URL: https://github.com/llvm/llvm-project/commit/45cc74357130190b9aef9fab77646c17f2cf2a5e
DIFF: https://github.com/llvm/llvm-project/commit/45cc74357130190b9aef9fab77646c17f2cf2a5e.diff

LOG: [SandboxVec][DAG][NFC] Add comment about duplicate notes in deps() (#111915)

Added: 
    

Modified: 
    llvm/include/llvm/Transforms/Vectorize/SandboxVectorizer/DependencyGraph.h

Removed: 
    


################################################################################
diff  --git a/llvm/include/llvm/Transforms/Vectorize/SandboxVectorizer/DependencyGraph.h b/llvm/include/llvm/Transforms/Vectorize/SandboxVectorizer/DependencyGraph.h
index 7d300ea2b60d2d..5fa57efc1462e8 100644
--- a/llvm/include/llvm/Transforms/Vectorize/SandboxVectorizer/DependencyGraph.h
+++ b/llvm/include/llvm/Transforms/Vectorize/SandboxVectorizer/DependencyGraph.h
@@ -122,6 +122,10 @@ class DGNode {
   iterator preds_end(DependencyGraph &DAG) const {
     return const_cast<DGNode *>(this)->preds_end(DAG);
   }
+  /// \Returns a range of DAG predecessors nodes. If this is a MemDGNode then
+  /// this will also include the memory dependency predecessors.
+  /// Please note that this can include the same node more than once, if for
+  /// example it's both a use-def predecessor and a mem dep predecessor.
   iterator_range<iterator> preds(DependencyGraph &DAG) const {
     return make_range(preds_begin(DAG), preds_end(DAG));
   }