[MLIR][NFC] Improve doc comment and delete stale comment
authorUday Bondhugula <uday@polymagelabs.com>
Fri, 16 Jul 2021 09:29:16 +0000 (14:59 +0530)
committerUday Bondhugula <uday@polymagelabs.com>
Fri, 16 Jul 2021 09:30:15 +0000 (15:00 +0530)
Remove duplicate and stale doc comment on affineParallelize. NFC.

mlir/include/mlir/Dialect/Affine/Utils.h
mlir/lib/Dialect/Affine/Utils/Utils.cpp

index ee849c9..a7aa88d 100644 (file)
@@ -30,11 +30,12 @@ class Operation;
 
 using ReductionLoopMap = DenseMap<Operation *, SmallVector<LoopReduction, 2>>;
 
-/// Replaces parallel affine.for op with 1-d affine.parallel op.
-/// mlir::isLoopParallel detects the parallel affine.for ops.
-/// Parallelizes the specified reductions. Parallelization will fail in presence
-/// of loop iteration arguments that are not listed in `parallelReductions`.
-/// There is no cost model currently used to drive this parallelization.
+/// Replaces a parallel affine.for op with a 1-d affine.parallel op. `forOp`'s
+/// body is taken by the affine.parallel op and the former is erased.
+/// (mlir::isLoopParallel can be used to detect a parallel affine.for op.) The
+/// reductions specified in `parallelReductions` are also parallelized.
+/// Parallelization will fail in the presence of loop iteration arguments that
+/// are not listed in `parallelReductions`.
 LogicalResult
 affineParallelize(AffineForOp forOp,
                   ArrayRef<LoopReduction> parallelReductions = {});
index 26c3cf1..cbbc0c6 100644 (file)
@@ -129,10 +129,6 @@ static AffineIfOp hoistAffineIfOp(AffineIfOp ifOp, Operation *hoistOverOp) {
   return hoistedIfOp;
 }
 
-/// Replace affine.for with a 1-d affine.parallel and clone the former's body
-/// into the latter while remapping values. Parallelizes the specified
-/// reductions. Parallelization will fail in presence of loop iteration
-/// arguments that are not listed in `parallelReductions`.
 LogicalResult
 mlir::affineParallelize(AffineForOp forOp,
                         ArrayRef<LoopReduction> parallelReductions) {