[llvm] 6fa07a8 - [LV] Document selectEpilogueVectorizationFactor (NFC).

[Florian Hahn via llvm-commits]

Author: Florian Hahn
Date: 2023-04-30T21:09:24+01:00
New Revision: 6fa07a87abc96c3b924be07ce446e79691a7f186

URL: https://github.com/llvm/llvm-project/commit/6fa07a87abc96c3b924be07ce446e79691a7f186
DIFF: https://github.com/llvm/llvm-project/commit/6fa07a87abc96c3b924be07ce446e79691a7f186.diff

LOG: [LV] Document selectEpilogueVectorizationFactor (NFC).

Add missing documentation for selectEpilogueVectorizationFactor.

Suggested as independent improvement in D143938.

Added: 
    

Modified: 
    llvm/lib/Transforms/Vectorize/LoopVectorize.cpp

Removed: 
    


################################################################################
diff  --git a/llvm/lib/Transforms/Vectorize/LoopVectorize.cpp b/llvm/lib/Transforms/Vectorize/LoopVectorize.cpp
index 54fee331ca39..6418bba94a22 100644
--- a/llvm/lib/Transforms/Vectorize/LoopVectorize.cpp
+++ b/llvm/lib/Transforms/Vectorize/LoopVectorize.cpp
@@ -1199,6 +1199,9 @@ class LoopVectorizationCostModel {
   VectorizationFactor
   selectVectorizationFactor(const ElementCountSet &CandidateVFs);
 
+  /// \return The most profitable vectorization factor and the cost of that VF
+  /// for vectorizing the epilogue. Returns VectorizationFactor::Disabled if
+  /// epilogue vectorization is not supported for the loop.
   VectorizationFactor
   selectEpilogueVectorizationFactor(const ElementCount MaxVF,
                                     const LoopVectorizationPlanner &LVP);