 |
docc 0.8.3 (0d44999b)
C++ API Reference
|
|
docc 0.8.3 (0d44999b)
C++ API Reference
|
Base class for mathematical library nodes with expansion support. More...
#include <sdfg/data_flow/library_nodes/math/math_node.h>
Public Member Functions | |
| 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. | |
| virtual passes::LibNodeExpander::ExpandOutcome | expand (passes::LibNodeExpander::ExpandContext &context, structured_control_flow::Block &block)=0 |
| Expand this node into its internal operations. | |
| 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 std::string | toStr () const |
| Convert node to string representation. | |
| virtual symbolic::SymbolSet | symbols () const =0 |
| Get all symbols used in this node. | |
| virtual symbolic::Expression | flop () const |
| Calculate floating point operations for this node. | |
| virtual PointerAccessType | pointer_access_type (int input_idx) const |
| Describes what a pointer is used for. | |
| 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 |
| void | validate (const Function &function) const override |
| Validate the code node's configuration. | |
| 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 std::unique_ptr< DataFlowNode > | clone (size_t element_id, const graph::Vertex vertex, DataFlowGraph &parent) const =0 |
| Clone this node for graph transformations. | |
| 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. | |
| virtual void | replace (const symbolic::Expression old_expression, const symbolic::Expression new_expression)=0 |
| virtual void | replace (const symbolic::ExpressionMapping &replacements) |
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. | |
| 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. | |
| 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. | |
| 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_ |
Base class for mathematical library nodes with expansion support.
MathNode extends LibraryNode with the ability to expand high-level mathematical operations into primitive SDFG operations. Subclasses implement specific mathematical operations (tensor operations, BLAS operations, etc.) and provide expansion methods when appropriate.
All math nodes can optionally be expanded during the expansion pass if their implementation_type is set to ImplementationType_NONE.
| 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.
| element_id | Unique element identifier |
| debug_info | Debug information for this node |
| vertex | Graph vertex for this node |
| parent | Parent dataflow graph |
| code | Operation code/identifier |
| outputs | Output connector names |
| inputs | Input connector names |
| implementation_type | Implementation strategy |
|
pure virtual |
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.
| context | way to request isolation of node or add new blocks, loops etc. |
| block | the block in which the node is contained |
Implemented in sdfg::einsum::EinsumNode, sdfg::math::blas::BatchedGEMMNode, sdfg::math::blas::DotNode, sdfg::math::blas::GEMMNode, sdfg::math::tensor::ArangeNode, sdfg::math::tensor::BatchNormNode, sdfg::math::tensor::BroadcastNode, sdfg::math::tensor::ClampNode, sdfg::math::tensor::ConcatNode, sdfg::math::tensor::ConditionalTensorCopyNode, sdfg::math::tensor::ConstPaddingNode, sdfg::math::tensor::ConvNode, sdfg::math::tensor::ElementWiseDataflowTensorNode, sdfg::math::tensor::EluNode, sdfg::math::tensor::EmbeddingNode, sdfg::math::tensor::EmbeddingRenormNode, sdfg::math::tensor::IndexNode, sdfg::math::tensor::LayerNormNode, sdfg::math::tensor::LeakyReLUNode, sdfg::math::tensor::MatMulNode, sdfg::math::tensor::PoolingNode, sdfg::math::tensor::ReduceNode, sdfg::math::tensor::SoftmaxNode, sdfg::math::tensor::TensorCopyNode, and sdfg::math::tensor::UpsampleBilinear2DNode.
1.15.0