[mlir][docs] Update MLIR's PatternRewriter documentation

[jle-quel]

Description

This PR adds the missing const override to the rewrite and matchAndRewrite declaration in the Pattern Rewriter documentation as described here:

llvm-project/mlir/include/mlir/IR/PatternMatch.h

Lines 237 to 265 in 5cfa8ba

	/// RewritePattern is the common base class for all DAG to DAG replacements.
	/// There are two possible usages of this class:
	/// * Multi-step RewritePattern with "match" and "rewrite"
	/// - By overloading the "match" and "rewrite" functions, the user can
	/// separate the concerns of matching and rewriting.
	/// * Single-step RewritePattern with "matchAndRewrite"
	/// - By overloading the "matchAndRewrite" function, the user can perform
	/// the rewrite in the same call as the match.
	///
	class RewritePattern : public Pattern {
	public:
	virtual ~RewritePattern() = default;
	/// Rewrite the IR rooted at the specified operation with the result of
	/// this pattern, generating any new operations with the specified
	/// builder. If an unexpected error is encountered (an internal
	/// compiler error), it is emitted through the normal MLIR diagnostic
	/// hooks and the IR is left in a valid state.
	virtual void rewrite(Operation *op, PatternRewriter &rewriter) const;
	/// Attempt to match against code rooted at the specified operation,
	/// which is the same operation code as getRootKind().
	virtual LogicalResult match(Operation *op) const;
	/// Attempt to match against code rooted at the specified operation,
	/// which is the same operation code as getRootKind(). If successful, this
	/// function will automatically perform the rewrite.
	virtual LogicalResult matchAndRewrite(Operation *op,
	PatternRewriter &rewriter) const {

[llvmbot]

@llvm/pr-subscribers-mlir

Author: Jefferson Le Quellec (jle-quel)

Changes

Description

This PR adds the missing const override to the rewrite and matchAndRewrite declaration in the Pattern Rewriter documentation as described here:

llvm-project/mlir/include/mlir/IR/PatternMatch.h

Lines 237 to 265 in 5cfa8ba

	/// RewritePattern is the common base class for all DAG to DAG replacements.
	/// There are two possible usages of this class:
	/// * Multi-step RewritePattern with "match" and "rewrite"
	/// - By overloading the "match" and "rewrite" functions, the user can
	/// separate the concerns of matching and rewriting.
	/// * Single-step RewritePattern with "matchAndRewrite"
	/// - By overloading the "matchAndRewrite" function, the user can perform
	/// the rewrite in the same call as the match.
	///
	class RewritePattern : public Pattern {
	public:
	virtual ~RewritePattern() = default;
	/// Rewrite the IR rooted at the specified operation with the result of
	/// this pattern, generating any new operations with the specified
	/// builder. If an unexpected error is encountered (an internal
	/// compiler error), it is emitted through the normal MLIR diagnostic
	/// hooks and the IR is left in a valid state.
	virtual void rewrite(Operation *op, PatternRewriter &rewriter) const;
	/// Attempt to match against code rooted at the specified operation,
	/// which is the same operation code as getRootKind().
	virtual LogicalResult match(Operation *op) const;
	/// Attempt to match against code rooted at the specified operation,
	/// which is the same operation code as getRootKind(). If successful, this
	/// function will automatically perform the rewrite.
	virtual LogicalResult matchAndRewrite(Operation *op,
	PatternRewriter &rewriter) const {

---

Full diff: https://github.com/llvm/llvm-project/pull/116183.diff

1 Files Affected:

• (modified) mlir/docs/PatternRewriter.md (+2-2)

diff --git a/mlir/docs/PatternRewriter.md b/mlir/docs/PatternRewriter.md
index c61ceaf81681e2..2f1483db8190a7 100644
--- a/mlir/docs/PatternRewriter.md
+++ b/mlir/docs/PatternRewriter.md
@@ -73,7 +73,7 @@ public:
     // otherwise.
     // ...
   }
-  void rewrite(Operation *op, PatternRewriter &rewriter) {
+  void rewrite(Operation *op, PatternRewriter &rewriter) const override {
     // The `rewrite` method performs mutations on the IR rooted at `op` using
     // the provided rewriter. All mutations must go through the provided
     // rewriter.
@@ -81,7 +81,7 @@ public:
 
   /// In this section, the `match` and `rewrite` implementation is specified
   /// using a single hook.
-  LogicalResult matchAndRewrite(Operation *op, PatternRewriter &rewriter) {
+  LogicalResult matchAndRewrite(Operation *op, PatternRewriter &rewriter) const override {
     // The `matchAndRewrite` method performs both the matching and the mutation.
     // Note that the match must reach a successful point before IR mutation may
     // take place.