This class represents a specific instance of an effect. More...

#include "mlir/Interfaces/SideEffectInterfaces.h"

Public Member Functions
	EffectInstance (EffectT effect, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, int stage, bool effectOnFullRegion, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, Value value, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, Value value, int stage, bool effectOnFullRegion, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, SymbolRefAttr symbol, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, SymbolRefAttr symbol, int stage, bool effectOnFullRegion, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, Attribute parameters, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, Attribute parameters, int stage, bool effectOnFullRegion, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, Value value, Attribute parameters, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, Value value, Attribute parameters, int stage, bool effectOnFullRegion, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, SymbolRefAttr symbol, Attribute parameters, Resource resource=DefaultResource::get())

	EffectInstance (EffectT effect, SymbolRefAttr symbol, Attribute parameters, int stage, bool effectOnFullRegion, Resource resource=DefaultResource::get())

EffectT *	getEffect () const
	Return the effect being applied. More...

Value	getValue () const
	Return the value the effect is applied on, or nullptr if there isn't a known value being affected. More...

SymbolRefAttr	getSymbolRef () const
	Return the symbol reference the effect is applied on, or nullptr if there isn't a known smbol being affected. More...

Resource *	getResource () const
	Return the resource that the effect applies to. More...

Attribute	getParameters () const
	Return the parameters of the effect, if any. More...

int	getStage () const
	Return the effect happen stage. More...

bool	getEffectOnFullRegion () const
	Return if this side effect act on every single value of resource. More...

Detailed Description

template<typename EffectT>
class mlir::SideEffects::EffectInstance< EffectT >

This class represents a specific instance of an effect.

It contains the effect being applied, a resource that corresponds to where the effect is applied, and an optional symbol reference or value(either operand, result, or region entry argument) that the effect is applied to, and an optional parameters attribute further specifying the details of the effect.

Definition at line 139 of file SideEffectInterfaces.h.

Constructor & Destructor Documentation

◆ EffectInstance() [1/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 141 of file SideEffectInterfaces.h.

◆ EffectInstance() [2/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		int	stage,
		bool	effectOnFullRegion,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 144 of file SideEffectInterfaces.h.

◆ EffectInstance() [3/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Value	value,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 148 of file SideEffectInterfaces.h.

◆ EffectInstance() [4/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Value	value,
		int	stage,
		bool	effectOnFullRegion,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 152 of file SideEffectInterfaces.h.

◆ EffectInstance() [5/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		SymbolRefAttr	symbol,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 157 of file SideEffectInterfaces.h.

◆ EffectInstance() [6/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		SymbolRefAttr	symbol,
		int	stage,
		bool	effectOnFullRegion,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 161 of file SideEffectInterfaces.h.

◆ EffectInstance() [7/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Attribute	parameters,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 166 of file SideEffectInterfaces.h.

◆ EffectInstance() [8/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Attribute	parameters,
		int	stage,
		bool	effectOnFullRegion,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 170 of file SideEffectInterfaces.h.

◆ EffectInstance() [9/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Value	value,
		Attribute	parameters,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 175 of file SideEffectInterfaces.h.

◆ EffectInstance() [10/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		Value	value,
		Attribute	parameters,
		int	stage,
		bool	effectOnFullRegion,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 179 of file SideEffectInterfaces.h.

◆ EffectInstance() [11/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		SymbolRefAttr	symbol,
		Attribute	parameters,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 185 of file SideEffectInterfaces.h.

◆ EffectInstance() [12/12]

template<typename EffectT >

mlir::SideEffects::EffectInstance< EffectT >::EffectInstance	(	EffectT *	effect,
		SymbolRefAttr	symbol,
		Attribute	parameters,
		int	stage,
		bool	effectOnFullRegion,
		Resource *	resource = `DefaultResource::get()`
	)

inline

Definition at line 189 of file SideEffectInterfaces.h.

Member Function Documentation

◆ getEffect()

template<typename EffectT >

EffectT* mlir::SideEffects::EffectInstance< EffectT >::getEffect ( ) const

inline

Return the effect being applied.

Definition at line 197 of file SideEffectInterfaces.h.

Referenced by hasEffect(), and maybeCaptured().

◆ getEffectOnFullRegion()

template<typename EffectT >

bool mlir::SideEffects::EffectInstance< EffectT >::getEffectOnFullRegion ( ) const

inline

Return if this side effect act on every single value of resource.

Definition at line 222 of file SideEffectInterfaces.h.

◆ getParameters()

template<typename EffectT >

Attribute mlir::SideEffects::EffectInstance< EffectT >::getParameters ( ) const

inline

Return the parameters of the effect, if any.

Definition at line 216 of file SideEffectInterfaces.h.

◆ getResource()

template<typename EffectT >

Resource* mlir::SideEffects::EffectInstance< EffectT >::getResource ( ) const

inline

Return the resource that the effect applies to.

Definition at line 213 of file SideEffectInterfaces.h.

Referenced by hasEffect(), and mayAlias().

◆ getStage()

template<typename EffectT >

int mlir::SideEffects::EffectInstance< EffectT >::getStage ( ) const

inline

Return the effect happen stage.

Definition at line 219 of file SideEffectInterfaces.h.

◆ getSymbolRef()

template<typename EffectT >

SymbolRefAttr mlir::SideEffects::EffectInstance< EffectT >::getSymbolRef ( ) const

inline

Return the symbol reference the effect is applied on, or nullptr if there isn't a known smbol being affected.

Definition at line 207 of file SideEffectInterfaces.h.

◆ getValue()

template<typename EffectT >

Value mlir::SideEffects::EffectInstance< EffectT >::getValue ( ) const

inline

Return the value the effect is applied on, or nullptr if there isn't a known value being affected.

Definition at line 201 of file SideEffectInterfaces.h.

Referenced by mayAlias().

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

include/mlir/Interfaces/SideEffectInterfaces.h

Public Member Functions

Detailed Description

template<typename EffectT> class mlir::SideEffects::EffectInstance< EffectT >

Constructor & Destructor Documentation

◆ EffectInstance() [1/12]

◆ EffectInstance() [2/12]

◆ EffectInstance() [3/12]

◆ EffectInstance() [4/12]

◆ EffectInstance() [5/12]

◆ EffectInstance() [6/12]

◆ EffectInstance() [7/12]

◆ EffectInstance() [8/12]

◆ EffectInstance() [9/12]

◆ EffectInstance() [10/12]

◆ EffectInstance() [11/12]

◆ EffectInstance() [12/12]

Member Function Documentation

◆ getEffect()

◆ getEffectOnFullRegion()

◆ getParameters()

◆ getResource()

◆ getStage()

◆ getSymbolRef()

◆ getValue()

template<typename EffectT>
class mlir::SideEffects::EffectInstance< EffectT >