CIRCT  19.0.0git
Public Member Functions | List of all members
circt::OpReduction< OpTy > Struct Template Referenceabstract

#include <Reduction.h>

Inheritance diagram for circt::OpReduction< OpTy >:
Inheritance graph
[legend]
Collaboration diagram for circt::OpReduction< OpTy >:
Collaboration graph
[legend]

Public Member Functions

uint64_t match (Operation *op) override
 Check if the reduction can apply to a specific operation. More...
 
LogicalResult rewrite (Operation *op) override
 Apply the reduction to a specific operation. More...
 
virtual uint64_t match (OpTy op)
 
virtual LogicalResult rewrite (OpTy op)=0
 
- Public Member Functions inherited from circt::Reduction
virtual ~Reduction ()
 
virtual void beforeReduction (mlir::ModuleOp)
 Called before the reduction is applied to a new subset of operations. More...
 
virtual void afterReduction (mlir::ModuleOp)
 Called after the reduction has been applied to a subset of operations. More...
 
virtual std::string getName () const =0
 Return a human-readable name for this reduction pattern. More...
 
virtual bool acceptSizeIncrease () const
 Return true if the tool should accept the transformation this reduction performs on the module even if the overall size of the output increases. More...
 
virtual bool isOneShot () const
 Return true if the tool should not try to reapply this reduction after it has been successful. More...
 
void notifyOpErased (Operation *op)
 

Additional Inherited Members

- Public Attributes inherited from circt::Reduction
std::function< void(Operation *)> notifyOpErasedCallback = nullptr
 An optional callback for reductions to communicate removal of operations. More...
 

Detailed Description

template<typename OpTy>
struct circt::OpReduction< OpTy >

Definition at line 84 of file Reduction.h.

Member Function Documentation

◆ match() [1/2]

template<typename OpTy >
uint64_t circt::OpReduction< OpTy >::match ( Operation *  op)
inlineoverridevirtual

Check if the reduction can apply to a specific operation.

Returns a benefit measure where a higher number means that applying the pattern leads to a bigger reduction and zero means that the patten does not match and thus cannot be applied at all.

Implements circt::Reduction.

Definition at line 85 of file Reduction.h.

◆ match() [2/2]

template<typename OpTy >
virtual uint64_t circt::OpReduction< OpTy >::match ( OpTy  op)
inlinevirtual

◆ rewrite() [1/2]

template<typename OpTy >
LogicalResult circt::OpReduction< OpTy >::rewrite ( Operation *  op)
inlineoverridevirtual

Apply the reduction to a specific operation.

If the returned result indicates that the application failed, the resulting module is treated the same as if the tester marked it as uninteresting.

Implements circt::Reduction.

Definition at line 90 of file Reduction.h.

◆ rewrite() [2/2]

template<typename OpTy >
virtual LogicalResult circt::OpReduction< OpTy >::rewrite ( OpTy  op)
pure virtual

The documentation for this struct was generated from the following file: