tvm::SEqualReducer::Handler Class Reference

Internal handler that defines custom behaviors.. More...

#include <structural_equal.h>

Inheritance diagram for tvm::SEqualReducer::Handler:

Collaboration diagram for tvm::SEqualReducer::Handler:

Public Member Functions
virtual bool	SEqualReduce (const ObjectRef &lhs, const ObjectRef &rhs, bool map_free_vars, const Optional< ObjectPathPair > &current_paths)=0
	Reduce condition to equality of lhs and rhs. More...
virtual void	DeferFail (const ObjectPathPair &mismatch_paths)=0
	Mark the comparison as failed, but don't fail immediately. More...
virtual bool	IsFailDeferralEnabled ()=0
	Check if fail defferal is enabled. More...
virtual ObjectRef	MapLhsToRhs (const ObjectRef &lhs)=0
	Lookup the graph node equal map for vars that are already mapped. More...
virtual void	MarkGraphNode ()=0
	Mark current comparison as graph node equal comparison. More...

Protected Types
using	PathTracingData = SEqualReducer::PathTracingData

Detailed Description

Internal handler that defines custom behaviors..

Member Typedef Documentation

PathTracingData

using tvm::SEqualReducer::Handler::PathTracingData = SEqualReducer::PathTracingData

protected

Member Function Documentation

DeferFail()

virtual void tvm::SEqualReducer::Handler::DeferFail ( const ObjectPathPair &  mismatch_paths )

pure virtual

Mark the comparison as failed, but don't fail immediately.

This is useful for producing better error messages when comparing containers. For example, if two array sizes mismatch, it's better to mark the comparison as failed but compare array elements anyway, so that we could find the true first mismatch.

Implemented in tvm::SEqualHandlerDefault.

IsFailDeferralEnabled()

virtual bool tvm::SEqualReducer::Handler::IsFailDeferralEnabled ( )

pure virtual

Check if fail defferal is enabled.

Returns

false if the fail deferral is not enabled, true otherwise.

Implemented in tvm::SEqualHandlerDefault.

MapLhsToRhs()

virtual ObjectRef tvm::SEqualReducer::Handler::MapLhsToRhs ( const ObjectRef &  lhs )

pure virtual

Lookup the graph node equal map for vars that are already mapped.

This is an auxiliary method to check the Map<Var, Value> equality.

Parameters

lhs	an lhs value.

Returns

The corresponding rhs value if any, nullptr if not available.

Implemented in tvm::SEqualHandlerDefault.

MarkGraphNode()

virtual void tvm::SEqualReducer::Handler::MarkGraphNode ( )

pure virtual

Mark current comparison as graph node equal comparison.

Implemented in tvm::SEqualHandlerDefault.

SEqualReduce()

virtual bool tvm::SEqualReducer::Handler::SEqualReduce ( const ObjectRef &  lhs, const ObjectRef &  rhs, bool  map_free_vars, const Optional< ObjectPathPair > &  current_paths  )

pure virtual

Reduce condition to equality of lhs and rhs.

Parameters

lhs	The left operand.
rhs	The right operand.
map_free_vars	Whether do we allow remap variables if possible.
current_paths	Optional paths to lhs and rhs objects, for error traceability.

Returns

false if there is an immediate failure, true otherwise.

Note

This function may save the equality condition of (lhs == rhs) in an internal stack and try to resolve later.

Implemented in tvm::SEqualHandlerDefault.

---

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

• include/tvm/node/structural_equal.h