tvm
Public Member Functions | Static Public Attributes | List of all members
tvm::relax::DFConstraintNode Class Referenceabstract

Additional constraints on the graph. More...

#include <dataflow_pattern.h>

Inheritance diagram for tvm::relax::DFConstraintNode:
Collaboration diagram for tvm::relax::DFConstraintNode:

Public Member Functions

virtual Array< DFPatternGetDependentPatterns () const =0
 Return the patterns on which the constraint depends. More...
 
virtual std::tuple< PrimExpr, bool > AsPrimExpr (std::function< Optional< Var >(const DFPatternNode *)> match_state) const =0
 Convert the constraint to a PrimExpr. More...
 
 TVM_DECLARE_BASE_OBJECT_INFO (DFConstraintNode, Object)
 
- Public Member Functions inherited from tvm::runtime::Object
uint32_t type_index () const
 
std::string GetTypeKey () const
 
size_t GetTypeKeyHash () const
 
template<typename TargetType >
bool IsInstance () const
 
bool unique () const
 
 Object ()
 
 Object (const Object &other)
 
 Object (Object &&other)
 
Objectoperator= (const Object &other)
 
Objectoperator= (Object &&other)
 

Static Public Attributes

static constexpr const char * _type_key = "DFConstraintNode"
 
static constexpr const uint32_t _type_child_slots = 1
 
- Static Public Attributes inherited from tvm::runtime::Object
static constexpr const char * _type_key = "runtime.Object"
 
static constexpr bool _type_final = false
 
static constexpr uint32_t _type_child_slots = 0
 
static constexpr bool _type_child_slots_can_overflow = true
 
static constexpr bool _type_has_method_visit_attrs = true
 
static constexpr bool _type_has_method_sequal_reduce = false
 
static constexpr bool _type_has_method_shash_reduce = false
 
static constexpr uint32_t _type_index = TypeIndex::kDynamic
 

Additional Inherited Members

- Public Types inherited from tvm::runtime::Object
typedef void(* FDeleter) (Object *self)
 Object deleter. More...
 
using RefCounterType = std::atomic< int32_t >
 
- Static Public Member Functions inherited from tvm::runtime::Object
static std::string TypeIndex2Key (uint32_t tindex)
 Get the type key of the corresponding index from runtime. More...
 
static size_t TypeIndex2KeyHash (uint32_t tindex)
 Get the type key hash of the corresponding index from runtime. More...
 
static uint32_t TypeKey2Index (const std::string &key)
 Get the type index of the corresponding key from runtime. More...
 
static uint32_t _GetOrAllocRuntimeTypeIndex ()
 
static uint32_t RuntimeTypeIndex ()
 
- Protected Member Functions inherited from tvm::runtime::Object
void IncRef ()
 developer function, increases reference counter. More...
 
void DecRef ()
 developer function, decrease reference counter. More...
 
- Static Protected Member Functions inherited from tvm::runtime::Object
static uint32_t GetOrAllocRuntimeTypeIndex (const std::string &key, uint32_t static_tindex, uint32_t parent_tindex, uint32_t type_child_slots, bool type_child_slots_can_overflow)
 Get the type index using type key. More...
 
- Protected Attributes inherited from tvm::runtime::Object
uint32_t type_index_ {0}
 Type index(tag) that indicates the type of the object. More...
 
RefCounterType ref_counter_ {0}
 The internal reference counter. More...
 
FDeleter deleter_ = nullptr
 deleter of this object to enable customized allocation. If the deleter is nullptr, no deletion will be performed. The creator of the object must always set the deleter field properly. More...
 

Detailed Description

Additional constraints on the graph.

Unlike PairCons, these may relate nodes that are not directly connected by a DFPattern edge from producer to consumer. For example, constraining the two branches of an elementwise operation to have the same shape.

Member Function Documentation

◆ AsPrimExpr()

virtual std::tuple<PrimExpr, bool> tvm::relax::DFConstraintNode::AsPrimExpr ( std::function< Optional< Var >(const DFPatternNode *)>  match_state) const
pure virtual

Convert the constraint to a PrimExpr.

If the returned boolean parameter is true, then the returned expression is a necessary-and-sufficient condition for evaluating the constraint. In this case, the matcher may either mark the constraint as satisfied (no need to re-check later), or as failed (need to back-track).

If the returned boolean parameter is false, then the returned expression is a necessary-but-not-sufficient condition for evaluating the constraint. In this case, the matcher may start backtracking as a result of a failed condition, but may not mark the constraint as satisfied. This typically occurs when the constraint involves a parameter that the matcher has not yet filled.

Parameters
match_stateA function that can be called to check the current state of the match. The function takes as argument a pattern on which the constraint depends, and returns the relax variable matched by that pattern, or NullOpt if the pattern has not yet been matched.
Returns
A tuple of PrimExpr and bool. The first element is a necessary condition for the constraint to be satisfied. The second tuple element indicates whether the condition is also sufficient for the constraint to be satisfied.

Implemented in tvm::relax::SameShapeConstraintNode.

◆ GetDependentPatterns()

virtual Array<DFPattern> tvm::relax::DFConstraintNode::GetDependentPatterns ( ) const
pure virtual

Return the patterns on which the constraint depends.

Implemented in tvm::relax::SameShapeConstraintNode.

◆ TVM_DECLARE_BASE_OBJECT_INFO()

tvm::relax::DFConstraintNode::TVM_DECLARE_BASE_OBJECT_INFO ( DFConstraintNode  ,
Object   
)

Member Data Documentation

◆ _type_child_slots

constexpr const uint32_t tvm::relax::DFConstraintNode::_type_child_slots = 1
staticconstexpr

◆ _type_key

constexpr const char* tvm::relax::DFConstraintNode::_type_key = "DFConstraintNode"
staticconstexpr

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