Computes Y = min(max(X, min), max) elementwise, where either bound may be omitted. More...

#include <sdfg/data_flow/library_nodes/math/tensor/clamp_node.h>

Inheritance diagram for sdfg::math::tensor::ClampNode:

Public Member Functions
	ClampNode (size_t element_id, const DebugInfo &debug_info, const graph::Vertex vertex, data_flow::DataFlowGraph &parent, const std::vector< symbolic::Expression > &shape, bool has_min, bool has_max, const data_flow::ImplementationType &impl_type=data_flow::ImplementationType_NONE)
const std::vector< symbolic::Expression > &	shape () const
bool	has_min () const
bool	has_max () const
int	min_input_idx () const
int	max_input_idx () const
void	validate (const Function &function) const override
	Validates the element.
bool	supports_integer_types () const override
	Check if this operation supports integer types.
passes::LibNodeExpander::ExpandOutcome	expand (passes::LibNodeExpander::ExpandContext &context, structured_control_flow::Block &block) override
	Expand this node into its internal operations.
data_flow::PointerAccessType	pointer_access_type (int input_idx) const override
	Describes what a pointer is used for.
std::string	toStr () const override
	Convert node to string representation.
symbolic::SymbolSet	symbols () const override
	Get all symbols used in this node.
std::unique_ptr< data_flow::DataFlowNode >	clone (size_t element_id, const graph::Vertex vertex, data_flow::DataFlowGraph &parent) const override
	Clone this node for graph transformations.
void	replace (const symbolic::Expression old_expression, const symbolic::Expression new_expression) override
void	replace (const symbolic::ExpressionMapping &replacements) override
Public Member Functions inherited from sdfg::math::tensor::TensorNode
	TensorNode (size_t element_id, const DebugInfo &debug_info, const graph::Vertex vertex, data_flow::DataFlowGraph &parent, const data_flow::LibraryNodeCode &code, const std::vector< std::string > &outputs, const std::vector< std::string > &inputs, const data_flow::ImplementationType &impl_type)
	Construct a tensor node.
virtual void	verify_data_types (const data_flow::DataFlowGraph &graph) const
	Called as part of validate.
void	validate (const Function &function) const override
	Validate tensor node constraints.
types::PrimitiveType	primitive_type (const data_flow::DataFlowGraph &graph) const
	Get the primitive type of this tensor operation.
Public Member Functions inherited from sdfg::math::MathNode
	MathNode (size_t element_id, const DebugInfo &debug_info, const graph::Vertex vertex, data_flow::DataFlowGraph &parent, const data_flow::LibraryNodeCode &code, const std::vector< std::string > &outputs, const std::vector< std::string > &inputs, const data_flow::ImplementationType &implementation_type, bool side_effects=false)
	Construct a mathematical library node.
Public Member Functions inherited from sdfg::data_flow::LibraryNode
	LibraryNode (const LibraryNode &data_node)=delete
LibraryNode &	operator= (const LibraryNode &)=delete
virtual	~LibraryNode ()=default
ElementType	type_id () const override
	Returns the type of the element.
const LibraryNodeCode &	code () const
	Get the operation code.
const ImplementationType &	implementation_type () const
	Get the implementation type (const).
ImplementationType &	implementation_type ()
	Get the implementation type (mutable).
void	set_implementation_type (const ImplementationType &impl_type)
bool	side_effect () const override
	Check if this node has side effects.
virtual symbolic::Expression	flop () const
	Calculate floating point operations for this node.
PointerAccessType	pointer_access_type (const Memlet &edge) const
virtual bool	relocalize_operand (int input_idx, const math::tensor::TensorLayout &packed)
	Repoint the operand at `input_idx` to a locally staged buffer.
virtual bool	can_relocalize_operand (int input_idx, const math::tensor::TensorLayout &packed) const
	Side-effect-free predicate mirroring relocalize_operand: whether the operand at `input_idx` can be repointed at the buffer view `packed`.
virtual std::optional< SubgroupAccess >	operand_access (int input_idx, unsigned subgroup_size) const
	The elements one subgroup of `subgroup_size` lanes reads from the operand at `input_idx`, if the node declares them.
EdgeRemoveOption	can_remove_out_edge (const data_flow::DataFlowGraph &graph, const Memlet *memlet) const override
	Is the edge in question removable, or will this make the node its an output on invalid?
EdgeRemoveOption	can_remove_in_edge (const data_flow::DataFlowGraph &graph, const Memlet *memlet) const override
bool	pointer_use_creates_side_effects (const DataFlowGraph &dataflow, const Function &func)
Public Member Functions inherited from sdfg::data_flow::CodeNode
	CodeNode (const CodeNode &data_node)=delete
CodeNode &	operator= (const CodeNode &)=delete
const std::vector< std::string > &	outputs () const
	Get output connector names (const).
const std::vector< std::string > &	inputs () const
	Get input connector names (const).
std::vector< std::string > &	outputs ()
	Get output connector names (mutable).
std::vector< std::string > &	inputs ()
	Get input connector names (mutable).
const std::string &	output (size_t index) const
	Get output connector name by index.
const std::string &	input (size_t index) const
	Get input connector name by index.
bool	has_constant_input (size_t index) const
	Check if an input is connected to a constant node.
Public Member Functions inherited from sdfg::data_flow::DataFlowNode
	DataFlowNode (const DataFlowNode &data_node)=delete
DataFlowNode &	operator= (const DataFlowNode &)=delete
graph::Vertex	vertex () const
	Get the graph vertex for this node.
const DataFlowGraph &	get_parent () const
	Get the parent dataflow graph (const).
DataFlowGraph &	get_parent ()
	Get the parent dataflow graph (mutable).
virtual bool	update_edge_removed (const std::string &out_conn)
Public Member Functions inherited from sdfg::Element
	Element (size_t element_id, const DebugInfo &debug_info)
virtual	~Element ()=default
size_t	element_id () const
const DebugInfo &	debug_info () const
void	set_debug_info (const DebugInfo &debug_info)
void	add_metadata (const std::string &key, const std::string &value)
void	remove_metadata (const std::string &key)
const std::string &	metadata (const std::string &key) const
const std::string *	metadata_if_exists (const std::string &key) const
const std::unordered_map< std::string, std::string > &	metadata () const
std::string_view	element_type () const
	Returns the type of the element as a human-readable string.

Static Public Attributes
static constexpr int	Y_INPUT_IDX = 0
static constexpr int	X_INPUT_IDX = 1
Static Public Attributes inherited from sdfg::data_flow::CodeNode
static constexpr ElementType	TypeGroup = ElementType::Tasklet \| ElementType::LibraryNode
	Bitmask of all concrete ElementTypes that are CodeNodes.
Static Public Attributes inherited from sdfg::data_flow::DataFlowNode
static constexpr ElementType	TypeGroup
	Bitmask of all concrete ElementTypes that are DataFlowNodes.

Additional Inherited Members
Static Public Member Functions inherited from sdfg::data_flow::LibraryNode
static bool	classof (const Element &element)
Static Public Member Functions inherited from sdfg::data_flow::CodeNode
static bool	classof (const Element &element)
	LLVM-style RTTI predicate: true if `element` is a CodeNode.
Static Public Member Functions inherited from sdfg::data_flow::DataFlowNode
static bool	classof (const Element &element)
	LLVM-style RTTI predicate: true if `element` is a DataFlowNode.
Protected Member Functions inherited from sdfg::math::tensor::TensorNode
void	validate_shape_matches (const std::vector< symbolic::Expression > &required_shape, const TensorLayout &layout, const std::string &name) const
Protected Member Functions inherited from sdfg::data_flow::LibraryNode
	LibraryNode (size_t element_id, const DebugInfo &debug_info, const graph::Vertex vertex, DataFlowGraph &parent, const LibraryNodeCode &code, const std::vector< std::string > &outputs, const std::vector< std::string > &inputs, const bool side_effect, const ImplementationType &implementation_type)
	Protected constructor for library nodes.
Protected Member Functions inherited from sdfg::data_flow::CodeNode
	CodeNode (size_t element_id, const DebugInfo &debug_info, const graph::Vertex vertex, DataFlowGraph &parent, const std::vector< std::string > &outputs, const std::vector< std::string > &inputs)
	Protected constructor for code nodes.
Protected Member Functions inherited from sdfg::data_flow::DataFlowNode
	DataFlowNode (size_t element_id, const DebugInfo &debug_info, const graph::Vertex vertex, DataFlowGraph &parent)
	Protected constructor for dataflow nodes.
Static Protected Member Functions inherited from sdfg::math::tensor::TensorNode
static data_flow::TaskletCode	get_integer_minmax_tasklet (types::PrimitiveType prim_type, bool is_max)
	Get the appropriate tasklet code for min/max operations on integers.
Protected Attributes inherited from sdfg::data_flow::LibraryNode
LibraryNodeCode	code_
	Operation identifier (e.g., "GEMM", "Add").
bool	side_effect_
	Whether this node has side effects.
ImplementationType	implementation_type_
	How to implement this node.
Protected Attributes inherited from sdfg::data_flow::CodeNode
std::vector< std::string >	outputs_
	Names of output connectors.
std::vector< std::string >	inputs_
	Names of input connectors.
Protected Attributes inherited from sdfg::Element
size_t	element_id_
DebugInfo	debug_info_
std::unordered_map< std::string, std::string >	metadata_

Detailed Description

Computes Y = min(max(X, min), max) elementwise, where either bound may be omitted.

Inputs are the written tensor Y, the tensor X and the scalar bounds "min" and/or "max". X and Y must match the node shape. The node is expanded into a map nest with per-element branches, so a NaN in X or in a bound propagates to the result like in PyTorch.

Constructor & Destructor Documentation

◆ ClampNode()

sdfg::math::tensor::ClampNode::ClampNode	(	size_t	element_id,
		const DebugInfo &	debug_info,
		const graph::Vertex	vertex,
		data_flow::DataFlowGraph &	parent,
		const std::vector< symbolic::Expression > &	shape,
		bool	has_min,
		bool	has_max,
		const data_flow::ImplementationType &	impl_type = data_flow::ImplementationType_NONE )

Member Function Documentation

◆ clone()

std::unique_ptr< data_flow::DataFlowNode > sdfg::math::tensor::ClampNode::clone	(	size_t	element_id,
		const graph::Vertex	vertex,
		data_flow::DataFlowGraph &	parent ) const

overridevirtual

Clone this node for graph transformations.

Parameters

element_id	New element identifier for the clone
vertex	New graph vertex for the clone
parent	Parent graph for the clone

Returns: Unique pointer to the cloned node

Pure virtual function that must be implemented by derived classes to support graph transformations and optimizations.

Implements sdfg::data_flow::DataFlowNode.

◆ expand()

passes::LibNodeExpander::ExpandOutcome sdfg::math::tensor::ClampNode::expand	(	passes::LibNodeExpander::ExpandContext &	context,
		structured_control_flow::Block &	block )

overridevirtual

Expand this node into its internal operations.

Note: some nodes need more than one expansion, so these should be separate impls. of LibNodeExpander instead

The expansion process transforms the high-level mathematical operation represented by this node into primitive SDFG constructs (maps, tasklets, etc.). This allows the operation to be further optimized and scheduled.

Parameters

context	way to request isolation of node or add new blocks, loops etc.
block	the block in which the node is contained

Returns: context, which will know of all the changes that were made

Implements sdfg::math::MathNode.

◆ has_max()

bool sdfg::math::tensor::ClampNode::has_max ( ) const

◆ has_min()

bool sdfg::math::tensor::ClampNode::has_min ( ) const

◆ max_input_idx()

int sdfg::math::tensor::ClampNode::max_input_idx ( ) const

◆ min_input_idx()

int sdfg::math::tensor::ClampNode::min_input_idx ( ) const

◆ pointer_access_type()

data_flow::PointerAccessType sdfg::math::tensor::ClampNode::pointer_access_type ( int input_idx ) const

overridevirtual

Describes what a pointer is used for.

Parameters

input_idx index of input that is a pointer.

Returns: Invalid if not asked about a pointer input

Reimplemented from sdfg::data_flow::LibraryNode.

◆ replace() [1/2]

void sdfg::math::tensor::ClampNode::replace	(	const symbolic::Expression	old_expression,
		const symbolic::Expression	new_expression )

overridevirtual

Implements sdfg::Element.

◆ replace() [2/2]

void sdfg::math::tensor::ClampNode::replace ( const symbolic::ExpressionMapping & replacements )

overridevirtual

Reimplemented from sdfg::Element.

◆ shape()

const std::vector< symbolic::Expression > & sdfg::math::tensor::ClampNode::shape ( ) const

◆ supports_integer_types()

bool sdfg::math::tensor::ClampNode::supports_integer_types ( ) const

overridevirtual

Check if this operation supports integer types.

Operations like add, sub, mul, div, min, max support both floating-point and integer types. Operations like exp, log, tanh, sigmoid only support floating-point types.

Returns: true if integer types are supported, false otherwise

Implements sdfg::math::tensor::TensorNode.

◆ symbols()

symbolic::SymbolSet sdfg::math::tensor::ClampNode::symbols ( ) const

overridevirtual

Get all symbols used in this node.

Returns: Set of symbolic expressions used by this node

Implements sdfg::data_flow::LibraryNode.

◆ toStr()

std::string sdfg::math::tensor::ClampNode::toStr ( ) const

overridevirtual

Convert node to string representation.

Returns: String representation of the node

Reimplemented from sdfg::data_flow::LibraryNode.

◆ validate()

void sdfg::math::tensor::ClampNode::validate ( const Function & function ) const

overridevirtual

Validates the element.

Exceptions

InvalidSDFGException if the element is invalid

Implements sdfg::Element.

Member Data Documentation

◆ X_INPUT_IDX

int sdfg::math::tensor::ClampNode::X_INPUT_IDX = 1

staticconstexpr

◆ Y_INPUT_IDX

int sdfg::math::tensor::ClampNode::Y_INPUT_IDX = 0

staticconstexpr

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

sdfg/include/sdfg/data_flow/library_nodes/math/tensor/clamp_node.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ClampNode()

Member Function Documentation

◆ clone()

◆ expand()

◆ has_max()

◆ has_min()

◆ max_input_idx()

◆ min_input_idx()

◆ pointer_access_type()

◆ replace() [1/2]

◆ replace() [2/2]

◆ shape()

◆ supports_integer_types()

◆ symbols()

◆ toStr()

◆ validate()

Member Data Documentation

◆ X_INPUT_IDX

◆ Y_INPUT_IDX