Base class for all Defs. More...

#include <thorin/def.h>

Inheritance diagram for thorin::Def:

Public Member Functions
Getters
World &	world () const

flags_t	flags () const

u32	gid () const

hash_t	hash () const

node_t	node () const

std::string_view	node_name () const

type
const Def *	type () const
	Yields the raw type of this Def, i.e. maybe `nullptr`.

const Def *	unfold_type () const
	Yields the type of this Def and builds a new `.Type (UInc n)` if necessary.

bool	is_term () const
	Yields `true` if `this:T` and `T:(.Type 0)`.

arity
Ref	arity () const

std::optional< nat_t >	isa_lit_arity () const

nat_t	as_lit_arity () const

ops
template<size_t N = std::dynamic_extent>
auto	ops () const

const Def *	op (size_t i) const

size_t	num_ops () const

Setting Ops (Mutables Only)
You can set and change the Def::ops of a mutable after construction. However, you have to obey the following rules: If Def::is_set() is ... ... `false`, set the operands from left (`i == 0`) to right (`i == num_ops() - 1`). ... `true`, reset the operands from left to right as in 1a. In addition, you can invoke Def::unset() at any time to start over with 1a: mut->unset()->set({a, b, c}); // This will always work, but should be your last resort. Thorin assumes that a mutable is final, when its last operand is set. Then, Def::check() will be invoked.
Def *	set (size_t i, const Def *def)
	Successively set from left to right.

Def *	reset (size_t i, const Def *def)
	Successively reset from left to right.

Def *	set (Defs ops)
	Def::set `ops` all at once.

Def *	reset (Defs ops)
	Def::reset `ops` all at once.

Def *	unset ()
	Unsets all Def::ops; works even, if not set at all or partially.

Def *	set_type (const Def *)

void	unset_type ()

void	update ()
	Resolves Infers of this Def's type.

bool	is_set () const
	Yields `true` if empty or the last op is set.

extended_ops
Includes Def::type() (if not `nullptr`) and then the other Def::ops() in this order. Def::ops() is only included, if Def::is_set.
Defs	extended_ops () const

const Def *	extended_op (size_t i) const

size_t	num_extended_ops () const

partial_ops
Includes Def::type() and then the other Def::ops() in this order. Also works with partially set Defs and doesn't assert. Unset operands are `nullptr`.
Defs	partial_ops () const

const Def *	partial_op (size_t i) const

size_t	num_partial_ops () const

uses
const Uses &	uses () const

size_t	num_uses () const

dep
See also Dep.
unsigned	dep () const

bool	has_dep (Dep d) const

bool	has_dep (unsigned u) const

bool	dep_const () const

proj
Splits this Def via Extracts or directly accessing the Def::ops in the case of Sigmas or Arrays. std::array<const Def, 2> ab = def->projs<2>(); std::array<u64, 2> xy = def->projs<2>([](auto def) { return Lit::as(def); }); auto [a, b] = def->projs<2>(); auto [x, y] = def->projs<2>([](auto def) { return Lit::as(def); }); Array<const Def> projs1 = def->projs(); // "projs1" has def->num_projs() many elements Array<const Def> projs2 = def->projs(n);// "projs2" has n elements - asserts if incorrect // same as above but applies Lit::as<nat_t>(def) to each element Array<const Lit> lits1 = def->projs( [](auto def) { return Lit::as(def); }); Array<const Lit> lits2 = def->projs(n, [](auto def) { return Lit::as(def); }); thorin::Lit::as static T as(Ref def) Definition* def.h:731
nat_t	num_projs () const
	Yields Def::as_lit_arity(), if it is in fact a Lit, or `1` otherwise.

nat_t	num_tprojs () const
	As above but yields 1, if Flags::scalerize_threshold is exceeded.

const Def *	proj (nat_t a, nat_t i) const
	Similar to World::extract while assuming an arity of `a`, but also works on Sigmas and Arrays.

const Def *	proj (nat_t i) const
	As above but takes Def::num_projs as arity.

const Def *	tproj (nat_t i) const
	As above but takes Def::num_tprojs.

template<nat_t A = -1_n, class F >
auto	projs (F f) const
	Splits this Def via Def::projections into an Array (if `A == -1_n`) or `std::array` (otherwise).

template<class F >
auto	tprojs (F f) const

template<class F >
auto	projs (nat_t a, F f) const

template<nat_t A = -1_n>
auto	projs () const

auto	tprojs () const

auto	projs (nat_t a) const

var
Retrieve Var for mutables. See also proj
nat_t	num_vars ()

nat_t	num_tvars ()

Ref	var (nat_t a, nat_t i)

Ref	var (nat_t i)

Ref	tvar (nat_t i)

template<nat_t A = std::dynamic_extent, class F >
auto	vars (F f)

template<class F >
auto	tvars (F f)

template<nat_t A = std::dynamic_extent>
auto	vars ()

auto	tvars ()

template<class F >
auto	vars (nat_t a, F f)

auto	vars (nat_t a)

Ref	var ()
	Not necessarily a Var: E.g., if the return type is `[]`, this will yield `()`.

const Var *	has_var ()
	Only returns not `nullptr`, if Var of this mutable has ever been created.

const Var *	has_var () const
	As above if `this` is a mutable.

Free Vars and Muts
local_muts()/local_vars() are Vars/mutables reachable by following immutable extended_ops(). local_muts()/local_vars() are cached and hash-consed. free_vars() compute a global solution, i.e., by transitively following mutables as well. free_vars() are computed on demand and cached. They will be transitively invalidated by following fv_consumers(), if a mutable is mutated.
Muts	local_muts () const

Vars	local_vars () const

Vars	free_vars () const

Vars	free_vars ()

bool	is_open () const
	Has free_vars()?

bool	is_closed () const
	Has no free_vars()?

Muts	fv_consumers ()

external
bool	is_external () const

void	make_external ()

void	make_internal ()

void	transfer_external (Def *to)

Casts
See also Upcast for Built-ins
template<class T = Def>
const T *	isa_imm () const

template<class T = Def>
const T *	as_imm () const

template<class T = Def, class R >
const T *	isa_imm (R(T::*f)() const) const

template<class T = Def, bool invert = false>
T *	isa_mut () const
	If `this` is mutable, it will cast `const`ness away and perform a `dynamic_cast` to `T`.

template<class T = Def, bool invert = false>
T *	as_mut () const
	Asserts that `this` is a mutable, casts `const`ness away and performs a `static_cast` to `T`.

Dbg Getters
Dbg	dbg () const

Loc	loc () const

Sym	sym () const

std::string	unique_name () const
	name + "_" + Def::gid

Dbg Setters
Every subclass `S` of Def has the same setters that return `S`/`const S` but will not show up in Doxygen.
template<bool Ow = false>
const Def *	set (Loc l) const

template<bool Ow = false>
Def *	set (Loc l)

template<bool Ow = false>
const Def *	set (Sym s) const

template<bool Ow = false>
Def *	set (Sym s)

template<bool Ow = false>
const Def *	set (std::string s) const

template<bool Ow = false>
Def *	set (std::string s)

template<bool Ow = false>
const Def *	set (Loc l, Sym s) const

template<bool Ow = false>
Def *	set (Loc l, Sym s)

template<bool Ow = false>
const Def *	set (Loc l, std::string s) const

template<bool Ow = false>
Def *	set (Loc l, std::string s)

template<bool Ow = false>
const Def *	set (Dbg d) const

template<bool Ow = false>
Def *	set (Dbg d)

debug_prefix/suffix
Prepends/Appends a prefix/suffix to Def::name - but only in `Debug` build.
const Def *	debug_prefix (std::string) const

const Def *	debug_suffix (std::string) const

Rebuild
Def *	stub (World &w, Ref type)

Def *	stub (Ref type)

Ref	rebuild (World &w, Ref type, Defs ops) const
	Def::rebuilds this Def while using `new_op` as substitute for its `i'th` Def::op.

Ref	rebuild (Ref type, Defs ops) const

virtual const Def *	immutabilize ()
	Tries to make an immutable from a mutable.

const Def *	refine (size_t i, const Def *new_op) const

DefVec	reduce (const Def *arg) const
	Rewrites Def::ops by substituting `this` mutable's Var with `arg`.

DefVec	reduce (const Def *arg)

Type Checking
virtual void	check ()

dump
void	dump () const

void	dump (int max) const

void	write (int max) const

void	write (int max, const char *file) const

std::ostream &	stream (std::ostream &, int max) const

dot
Dumps DOT to `os` while obeying maximum recursion depth of `max`. If `types` is `true`, Def::type() dependencies will be followed as well.
void	dot (std::ostream &os, uint32_t max=0xFFFFFF, bool types=false) const

void	dot (const char *file=nullptr, uint32_t max=0xFFFFFF, bool types=false) const
	Same as above but write to `file` or `std::cout` if `file` is `nullptr`.

void	dot (const std::string &file, uint32_t max=0xFFFFFF, bool types=false) const

Protected Member Functions
	Def (World , node_t, const Def type, Defs ops, flags_t flags)
	Constructor for an immutable Def.

	Def (node_t n, const Def *type, Defs ops, flags_t flags)
	As above but World retrieved from `type`.

	Def (node_t, const Def *type, size_t num_ops, flags_t flags)
	Constructor for a mutable Def.

virtual	~Def ()=default

Wrappers for World::sym
These are here to have Def::setters inline without including `thorin/world.h`.
Sym	sym (const char *) const

Sym	sym (std::string_view) const

Sym	sym (std::string) const

Protected Attributes
Dbg	dbg_

union {

NormalizeFn	normalizer_
	Axiom only: Axioms use this member to store their normalizer.

const Axiom *	axiom_
	App only: Curried Apps of Axioms use this member to propagate the Axiom.

const Var *	var_
	Mutable only: Var of a mutable.

World *	world_

};

flags_t	flags_

u8	curry_

u8	trip_

Private Member Functions
virtual Def *	stub_ (World &, Ref)

virtual Ref	rebuild_ (World &w, Ref type, Defs ops) const =0

Detailed Description

Base class for all Defs.

The data layout (see World::alloc and Def::partial_ops) looks like this:

Def| type | op(0) ... op(num_ops-1) |
          |-----------ops-----------|
   |----------partial_ops-----------|
 
             extended_ops
   |--------------------------------| if type() != nullptr &&  is_set()
          |-------------------------| if type() == nullptr &&  is_set()
   |------|                           if type() != nullptr && !is_set()
   ||                                 if type() == nullptr && !is_set()

Attention: This means that any subclass of Def must not introduce additional members.

See also: Immutables vs. Mutables

Definition at line 222 of file def.h.

Constructor & Destructor Documentation

◆ Def() [1/3]

thorin::Def::Def	(	World *	w,
		node_t	node,
		const Def *	type,
		Defs	ops,
		flags_t	flags
	)

protected

Constructor for an immutable Def.

Definition at line 23 of file def.cpp.

References extended_ops(), flags_, gid(), local_muts(), local_vars(), thorin::World::merge(), thorin::murmur3(), thorin::murmur3_finalize(), thorin::murmur3_rest(), thorin::World::next_gid(), node(), num_ops(), op(), ops(), type(), thorin::Node::Univ, var(), thorin::World::vars(), and world().

◆ Def() [2/3]

thorin::Def::Def	(	node_t	n,
		const Def *	type,
		Defs	ops,
		flags_t	flags
	)

protected

As above but World retrieved from type.

Definition at line 63 of file def.cpp.

◆ Def() [3/3]

thorin::Def::Def	(	node_t	node,
		const Def *	type,
		size_t	num_ops,
		flags_t	flags
	)

protected

Constructor for a mutable Def.

Definition at line 66 of file def.cpp.

References dep_const(), gid(), thorin::murmur3(), thorin::World::next_gid(), num_ops(), thorin::Use::Type, type(), and world().

◆ ~Def()

virtual thorin::Def::~Def ( )

protectedvirtualdefault

Member Function Documentation

◆ arity()

Ref thorin::Def::arity ( ) const

Definition at line 494 of file def.cpp.

References thorin::World::lit_nat(), thorin::World::lit_nat_1(), type(), and world().

Referenced by thorin::plug::autodiff::AutoDiffEval::augment_pack(), thorin::World::extract(), thorin::World::insert(), thorin::tuple2str(), and thorin::unflatten().

◆ as_imm()

template<class T = Def>

const T * thorin::Def::as_imm ( ) const

inline

Definition at line 444 of file def.h.

◆ as_lit_arity()

nat_t thorin::Def::as_lit_arity ( ) const

inline

Definition at line 259 of file def.h.

References isa_lit_arity().

Referenced by thorin::World::extract(), thorin::plug::regex::normalize_conj(), thorin::plug::regex::normalize_disj(), and projs().

◆ as_mut()

template<class T = Def, bool invert = false>

T * thorin::Def::as_mut ( ) const

inline

Asserts that this is a mutable, casts constness away and performs a static_cast to T.

Definition at line 457 of file def.h.

Referenced by thorin::BetaRed::analyze(), thorin::EtaExp::analyze(), thorin::plug::mem::CopyProp::analyze(), thorin::plug::mem::SSAConstr::analyze(), thorin::plug::clos::clos_type(), thorin::plug::autodiff::AutoDiffEval::derive_(), thorin::ll::Emitter::emit_epilogue(), thorin::Var::mut(), thorin::ll::Emitter::prepare(), thorin::RWPhase::start(), thorin::Cleanup::start(), and thorin::Emitter< Value, Type, BB, Child >::visit().

◆ check()

virtual void thorin::Def::check ( )

inlinevirtual

Reimplemented in thorin::Pi, thorin::Lam, thorin::Sigma, and thorin::Arr.

Definition at line 517 of file def.h.

Referenced by set().

◆ dbg()

Dbg thorin::Def::dbg ( ) const

inline

Definition at line 468 of file def.h.

Referenced by thorin::Infer::stub(), thorin::Pi::stub(), thorin::Lam::stub(), thorin::TBound< Up >::stub(), thorin::TExt< Up >::stub(), thorin::Sigma::stub(), thorin::Arr::stub(), and thorin::Pack::stub().

◆ debug_prefix()

const Def * thorin::Def::debug_prefix ( std::string prefix ) const

Definition at line 454 of file def.cpp.

References dbg_, sym(), thorin::Dbg::sym, thorin::World::sym(), and world().

◆ debug_suffix()

const Def * thorin::Def::debug_suffix ( std::string suffix ) const

Definition at line 459 of file def.cpp.

References dbg_, sym(), thorin::Dbg::sym, thorin::World::sym(), and world().

◆ dep()

unsigned thorin::Def::dep ( ) const

inline

Definition at line 335 of file def.h.

Referenced by has_dep().

◆ dep_const()

bool thorin::Def::dep_const ( ) const

inline

Definition at line 338 of file def.h.

References has_dep(), thorin::Mut, and thorin::Var.

Referenced by Def(), thorin::Scheduler::early(), thorin::Scheduler::late(), and thorin::plug::core::normalize_pe().

◆ dot() [1/3]

void thorin::Def::dot	(	const char *	file = `nullptr`,
		uint32_t	max = `0xFFFFFF`,
		bool	types = `false`
	)		const

Same as above but write to file or std::cout if file is nullptr.

Definition at line 126 of file dot.cpp.

References dot().

◆ dot() [2/3]

void thorin::Def::dot	(	const std::string &	file,
		uint32_t	max = `0xFFFFFF`,
		bool	types = `false`
	)		const

inline

Definition at line 536 of file def.h.

◆ dot() [3/3]

void thorin::Def::dot	(	std::ostream &	os,
		uint32_t	max = `0xFFFFFF`,
		bool	types = `false`
	)		const

Definition at line 124 of file dot.cpp.

Referenced by dot().

◆ dump() [1/2]

void thorin::Def::dump ( ) const

Definition at line 419 of file dump.cpp.

◆ dump() [2/2]

void thorin::Def::dump ( int max ) const

Definition at line 420 of file dump.cpp.

References stream().

◆ extended_op()

const Def * thorin::Def::extended_op ( size_t i ) const

inline

Definition at line 312 of file def.h.

References extended_ops().

◆ extended_ops()

Defs thorin::Def::extended_ops ( ) const

Definition at line 447 of file def.cpp.

References is_set(), and type().

Referenced by Def(), thorin::Scheduler::early(), extended_op(), num_extended_ops(), and thorin::PassMan::run().

◆ flags()

flags_t thorin::Def::flags ( ) const

inline

Definition at line 237 of file def.h.

References flags_.

Referenced by thorin::Axiom::base(), thorin::Pi::is_implicit(), thorin::optimize(), thorin::Axiom::plugin(), thorin::Axiom::sub(), and thorin::Axiom::tag().

◆ free_vars() [1/2]

Vars thorin::Def::free_vars ( )

Definition at line 340 of file def.cpp.

References free_vars(), is_set(), and isa_mut().

◆ free_vars() [2/2]

Vars thorin::Def::free_vars ( ) const

Definition at line 332 of file def.cpp.

References isa_mut(), local_muts(), local_vars(), thorin::World::merge(), vars(), and world().

Referenced by free_vars(), thorin::Pi::immutabilize(), thorin::Sigma::immutabilize(), thorin::Arr::immutabilize(), thorin::Pack::immutabilize(), is_closed(), is_open(), and thorin::VarRewriter::rewrite_mut().

◆ fv_consumers()

Muts thorin::Def::fv_consumers ( )

inline

Definition at line 428 of file def.h.

◆ gid()

u32 thorin::Def::gid ( ) const

inline

Definition at line 238 of file def.h.

Referenced by thorin::commute(), Def(), Def(), thorin::PipelineBuilder::def2pass(), thorin::plug::refly::normalize_gid(), thorin::UseHash::operator()(), thorin::register_pass_with_arg(), and unique_name().

◆ has_dep() [1/2]

bool thorin::Def::has_dep ( Dep d ) const

inline

Definition at line 336 of file def.h.

References has_dep().

Referenced by dep_const(), has_dep(), and thorin::Infer::should_eliminate().

◆ has_dep() [2/2]

bool thorin::Def::has_dep ( unsigned u ) const

inline

Definition at line 337 of file def.h.

References dep().

◆ has_var() [1/2]

const Var * thorin::Def::has_var ( )

inline

Only returns not nullptr, if Var of this mutable has ever been created.

Definition at line 407 of file def.h.

Referenced by has_var(), thorin::Pi::immutabilize(), thorin::Sigma::immutabilize(), thorin::Arr::immutabilize(), thorin::Pack::immutabilize(), and thorin::VarRewriter::rewrite_mut().

◆ has_var() [2/2]

const Var * thorin::Def::has_var ( ) const

inline

As above if this is a mutable.

Definition at line 409 of file def.h.

References has_var(), and isa_mut().

◆ hash()

hash_t thorin::Def::hash ( ) const

inline

Definition at line 239 of file def.h.

◆ immutabilize()

virtual const Def * thorin::Def::immutabilize ( )

inlinevirtual

Tries to make an immutable from a mutable.

This usually works if the mutable isn't recursive and its var isn't used.

Reimplemented in thorin::Pi, thorin::Sigma, thorin::Arr, and thorin::Pack.

Definition at line 506 of file def.h.

◆ is_closed()

bool thorin::Def::is_closed ( ) const

Has no free_vars()?

Definition at line 401 of file def.cpp.

References thorin::PooledSet< T >::empty(), free_vars(), is_external(), local_muts(), and local_vars().

Referenced by thorin::World::make_external(), and thorin::World::verify().

◆ is_external()

bool thorin::Def::is_external ( ) const

inline

Definition at line 433 of file def.h.

Referenced by is_closed(), thorin::isa_workable(), thorin::World::make_external(), and thorin::World::make_internal().

◆ is_open()

bool thorin::Def::is_open ( ) const

Has free_vars()?

Definition at line 409 of file def.cpp.

References thorin::PooledSet< T >::empty(), free_vars(), local_muts(), and local_vars().

◆ is_set()

bool thorin::Def::is_set ( ) const

Yields true if empty or the last op is set.

Definition at line 315 of file def.cpp.

References num_ops(), op(), and ops().

Referenced by thorin::EtaExp::analyze(), thorin::World::app(), extended_ops(), free_vars(), thorin::isa_workable(), thorin::EtaExp::rewrite(), thorin::EtaRed::rewrite(), thorin::Rewriter::rewrite_mut(), thorin::PassMan::run(), thorin::Scheduler::Scheduler(), and thorin::Emitter< Value, Type, BB, Child >::visit().

◆ is_term()

bool thorin::Def::is_term ( ) const

Yields true if this:T and T:(.Type 0).

Definition at line 483 of file def.cpp.

References thorin::Lit::isa(), and type().

Referenced by thorin::flatten().

◆ isa_imm() [1/2]

template<class T = Def>

const T * thorin::Def::isa_imm ( ) const

inline

Definition at line 443 of file def.h.

Referenced by thorin::World::app(), thorin::merge_sigma(), thorin::merge_tuple(), thorin::plug::core::normalize_trait(), and thorin::Infer::should_eliminate().

◆ isa_imm() [2/2]

template<class T = Def, class R >

const T * thorin::Def::isa_imm ( R(T::*)() const f ) const

inline

Definition at line 445 of file def.h.

◆ isa_lit_arity()

std::optional< nat_t > thorin::Def::isa_lit_arity ( ) const

Definition at line 501 of file def.cpp.

References thorin::Lit::isa(), num_ops(), and type().

Referenced by as_lit_arity(), thorin::flatten(), thorin::World::insert(), num_projs(), and num_tprojs().

◆ isa_mut()

template<class T = Def, bool invert = false>

T * thorin::Def::isa_mut ( ) const

inline

If this is *mut*able, it will cast constness away and perform a dynamic_cast to T.

Definition at line 449 of file def.h.

Referenced by thorin::EtaRed::analyze(), thorin::BetaRed::analyze(), thorin::EtaExp::analyze(), thorin::plug::mem::SSAConstr::analyze(), thorin::World::app(), thorin::plug::autodiff::AutoDiffEval::augment_(), thorin::Scheduler::early(), thorin::World::extract(), thorin::Infer::find(), thorin::Bound::find(), free_vars(), free_vars(), has_var(), thorin::isa_apped_mut_lam(), thorin::plug::clos::isa_clos_type(), thorin::Scheduler::late(), local_muts(), reduce(), thorin::Rewriter::rewrite(), thorin::EtaExp::rewrite(), thorin::EtaRed::rewrite(), thorin::Scalerize::rewrite(), thorin::plug::affine::LowerFor::rewrite(), thorin::plug::mem::SSAConstr::rewrite(), thorin::plug::clos::ClosConvPrep::rewrite_arg(), thorin::Scheduler::Scheduler(), thorin::World::tuple(), thorin::TuplePtrn::type(), thorin::plug::mem::AddMem::visit(), and thorin::Emitter< Value, Type, BB, Child >::visit().

◆ loc()

Loc thorin::Def::loc ( ) const

inline

Definition at line 469 of file def.h.

Referenced by thorin::error().

◆ local_muts()

Muts thorin::Def::local_muts ( ) const

Definition at line 327 of file def.cpp.

References isa_mut(), thorin::World::muts(), and world().

Referenced by Def(), free_vars(), is_closed(), is_open(), thorin::VarRewriter::rewrite_imm(), and thorin::ClosedMutPhase< M >::start().

◆ local_vars()

Vars thorin::Def::local_vars ( ) const

inline

Definition at line 423 of file def.h.

Referenced by Def(), free_vars(), is_closed(), is_open(), and thorin::VarRewriter::rewrite_imm().

◆ make_external()

void thorin::Def::make_external ( )

Definition at line 521 of file def.cpp.

References thorin::World::make_external(), and world().

Referenced by transfer_external().

◆ make_internal()

void thorin::Def::make_internal ( )

Definition at line 522 of file def.cpp.

References thorin::World::make_internal(), and world().

Referenced by thorin::plug::compile::InternalCleanup::enter(), thorin::optimize(), and transfer_external().

◆ node()

node_t thorin::Def::node ( ) const

inline

Definition at line 240 of file def.h.

Referenced by Def(), thorin::Pi::isa_cn(), and node_name().

◆ node_name()

std::string_view thorin::Def::node_name ( ) const

Definition at line 437 of file def.cpp.

References CODE, node(), and THORIN_NODE.

Referenced by thorin::plug::autodiff::AutoDiffEval::augment_(), thorin::plug::autodiff::autodiff_type_fun(), and thorin::plug::autodiff::zero_def().

◆ num_extended_ops()

size_t thorin::Def::num_extended_ops ( ) const

inline

Definition at line 313 of file def.h.

References extended_ops().

◆ num_ops()

size_t thorin::Def::num_ops ( ) const

inline

◆ num_partial_ops()

size_t thorin::Def::num_partial_ops ( ) const

inline

Definition at line 323 of file def.h.

References partial_ops().

◆ num_projs()

nat_t thorin::Def::num_projs ( ) const

inline

Yields Def::as_lit_arity(), if it is in fact a Lit, or 1 otherwise.

Definition at line 358 of file def.h.

References isa_lit_arity().

Referenced by thorin::plug::clos::clos_insert_env(), thorin::plug::clos::clos_remove_env(), thorin::plug::mem::mem_def(), proj(), projs(), and thorin::plug::mem::replace_mem().

◆ num_tprojs()

nat_t thorin::Def::num_tprojs ( ) const

As above but yields 1, if Flags::scalerize_threshold is exceeded.

Definition at line 526 of file def.cpp.

References thorin::World::flags(), isa_lit_arity(), thorin::Flags::scalerize_threshold, and world().

Referenced by tproj(), and tprojs().

◆ num_tvars()

nat_t thorin::Def::num_tvars ( )

inline

Definition at line 403 of file def.h.

Referenced by thorin::ll::Emitter::emit_epilogue().

◆ num_uses()

size_t thorin::Def::num_uses ( ) const

inline

Definition at line 329 of file def.h.

References uses().

◆ num_vars()

nat_t thorin::Def::num_vars ( )

inline

Definition at line 403 of file def.h.

Referenced by thorin::ll::Emitter::emit_epilogue(), and thorin::Lam::ret_var().

◆ op()

const Def * thorin::Def::op ( size_t i ) const

inline

Definition at line 269 of file def.h.

References ops().

Referenced by thorin::BetaRed::analyze(), thorin::EtaExp::analyze(), thorin::plug::mem::CopyProp::analyze(), thorin::plug::mem::SSAConstr::analyze(), thorin::EtaExp::analyze(), thorin::plug::mem::SSAConstr::analyze(), thorin::App::arg(), thorin::Lam::body(), thorin::Arr::body(), thorin::Pack::body(), thorin::App::callee(), thorin::Test::clash(), thorin::plug::clos::clos_type_to_pi(), thorin::Pi::codom(), Def(), thorin::Pi::dom(), thorin::World::extract(), thorin::Lam::filter(), thorin::Infer::find(), thorin::Bound::get(), thorin::Sigma::immutabilize(), thorin::Extract::index(), thorin::Insert::index(), thorin::Singleton::inhabitant(), is_set(), thorin::plug::clos::isa_clos_type(), thorin::Test::match(), thorin::plug::mem::normalize_load(), thorin::Infer::op(), thorin::Test::probe(), proj(), thorin::plug::mem::SSAConstr::rewrite(), thorin::rewrite(), thorin::EtaExp::rewrite(), thorin::EtaRed::rewrite(), thorin::plug::mem::SSAConstr::rewrite(), thorin::rewrite(), thorin::Rewriter::rewrite_imm(), thorin::Rewriter::rewrite_mut(), thorin::PassMan::run(), thorin::Scheduler::Scheduler(), set(), thorin::Arr::shape(), thorin::Extract::tuple(), thorin::Insert::tuple(), unset(), thorin::Vel::value(), thorin::Pick::value(), thorin::Test::value(), and thorin::Insert::value().

◆ ops()

template<size_t N = std::dynamic_extent>

auto thorin::Def::ops ( ) const

inline

◆ partial_op()

const Def * thorin::Def::partial_op ( size_t i ) const

inline

Definition at line 322 of file def.h.

References partial_ops().

◆ partial_ops()

Defs thorin::Def::partial_ops ( ) const

inline

Definition at line 321 of file def.h.

Referenced by num_partial_ops(), and partial_op().

◆ proj() [1/2]

const Def * thorin::Def::proj	(	nat_t	a,
		nat_t	i
	)		const

Similar to World::extract while assuming an arity of a, but also works on Sigmas and Arrays.

Definition at line 531 of file def.cpp.

References thorin::Lit::isa(), op(), thorin::Extract::tuple(), type(), uses(), and world().

Referenced by thorin::TuplePtrn::bind(), thorin::plug::clos::clos_remove_env(), thorin::ll::Emitter::emit_bb(), thorin::flatten(), thorin::World::insert(), projs(), projs(), thorin::plug::clos::ClosConvPrep::rewrite_arg(), and tproj().

◆ proj() [2/2]

const Def * thorin::Def::proj ( nat_t i ) const

inline

As above but takes Def::num_projs as arity.

Definition at line 364 of file def.h.

References num_projs(), and proj().

Referenced by proj().

◆ projs() [1/4]

template<nat_t A = -1_n>

auto thorin::Def::projs ( ) const

inline

Definition at line 387 of file def.h.

Referenced by projs(), projs(), and tprojs().

◆ projs() [2/4]

template<nat_t A = -1_n, class F >

auto thorin::Def::projs ( F f ) const

inline

Splits this Def via Def::projections into an Array (if A == -1_n) or std::array (otherwise).

Applies f to each element.

Definition at line 369 of file def.h.

References as_lit_arity(), num_projs(), proj(), and projs().

◆ projs() [3/4]

auto thorin::Def::projs ( nat_t a ) const

inline

Definition at line 393 of file def.h.

References projs().

◆ projs() [4/4]

template<class F >

auto thorin::Def::projs	(	nat_t	a,
		F	f
	)		const

inline

Definition at line 383 of file def.h.

References proj().

◆ rebuild() [1/2]

Ref thorin::Def::rebuild	(	Ref	type,
		Defs	ops
	)		const

inline

Definition at line 502 of file def.h.

References rebuild().

Referenced by rebuild().

◆ rebuild() [2/2]

Ref thorin::Def::rebuild	(	World &	w,
		Ref	type,
		Defs	ops
	)		const

inline

Def::rebuilds this Def while using new_op as substitute for its i'th Def::op.

Definition at line 498 of file def.h.

Referenced by refine(), thorin::EtaExp::rewrite(), and thorin::Rewriter::rewrite_imm().

◆ rebuild_()

virtual Ref thorin::Def::rebuild_	(	World &	w,
		Ref	type,
		Defs	ops
	)		const

privatepure virtual

Implemented in thorin::Var, thorin::Univ, thorin::UMax, thorin::UInc, thorin::Type, thorin::Lit, thorin::Nat, thorin::Idx, thorin::Proxy, thorin::Global, thorin::TBound< Up >, and thorin::TExt< Up >.

◆ reduce() [1/2]

DefVec thorin::Def::reduce ( const Def * arg )

Definition at line 219 of file def.cpp.

References thorin::rewrite(), and world().

◆ reduce() [2/2]

DefVec thorin::Def::reduce ( const Def * arg ) const

Rewrites Def::ops by substituting this mutable's Var with arg.

Definition at line 214 of file def.cpp.

References isa_mut(), and ops().

Referenced by thorin::World::app(), thorin::World::extract(), and thorin::plug::compile::handle_optimization_part().

◆ refine()

const Def * thorin::Def::refine	(	size_t	i,
		const Def *	new_op
	)		const

Definition at line 226 of file def.cpp.

References ops(), rebuild(), and type().

Referenced by thorin::plug::clos::clos_sub_env(), thorin::EtaRed::rewrite(), thorin::plug::mem::SSAConstr::rewrite(), thorin::plug::clos::ClosConvPrep::rewrite_arg(), and thorin::plug::clos::ClosConvPrep::rewrite_callee().

◆ reset() [1/2]

Def * thorin::Def::reset ( Defs ops )

Def::reset ops all at once.

Definition at line 251 of file def.cpp.

References num_ops(), ops(), and reset().

◆ reset() [2/2]

Def * thorin::Def::reset	(	size_t	i,
		const Def *	def
	)

inline

Successively reset from left to right.

Definition at line 291 of file def.h.

References set(), and unset().

Referenced by thorin::RetWrap::enter(), thorin::Infer::find(), thorin::Infer::reset(), reset(), and thorin::PassMan::run().

◆ set() [1/14]

template<bool Ow = false>

Def * thorin::Def::set ( Dbg d )

inline

Definition at line 477 of file def.h.

◆ set() [2/14]

template<bool Ow = false>

const Def * thorin::Def::set ( Dbg d ) const

inline

Definition at line 477 of file def.h.

◆ set() [3/14]

Def * thorin::Def::set ( Defs ops )

Def::set ops all at once.

Definition at line 250 of file def.cpp.

References num_ops(), ops(), and set().

◆ set() [4/14]

template<bool Ow = false>

Def * thorin::Def::set ( Loc l )

inline

Definition at line 477 of file def.h.

◆ set() [5/14]

template<bool Ow = false>

const Def * thorin::Def::set ( Loc l ) const

inline

Definition at line 477 of file def.h.

◆ set() [6/14]

template<bool Ow = false>

Def * thorin::Def::set	(	Loc	l,
		std::string	s
	)

inline

Definition at line 477 of file def.h.

◆ set() [7/14]

template<bool Ow = false>

const Def * thorin::Def::set	(	Loc	l,
		std::string	s
	)		const

inline

Definition at line 477 of file def.h.

◆ set() [8/14]

template<bool Ow = false>

Def * thorin::Def::set	(	Loc	l,
		Sym	s
	)

inline

Definition at line 477 of file def.h.

◆ set() [9/14]

template<bool Ow = false>

const Def * thorin::Def::set	(	Loc	l,
		Sym	s
	)		const

inline

Definition at line 477 of file def.h.

◆ set() [10/14]

Def * thorin::Def::set	(	size_t	i,
		const Def *	def
	)

Successively set from left to right.

Definition at line 254 of file def.cpp.

References check(), num_ops(), op(), and update().

Referenced by thorin::plug::autodiff::AutoDiffEval::augment_extract(), thorin::plug::autodiff::AutoDiffEval::augment_tuple(), thorin::TuplePtrn::bind(), thorin::plug::autodiff::AutoDiffEval::derive_(), thorin::plug::direct::op_cps2ds_dep(), reset(), thorin::plug::affine::LowerFor::rewrite(), thorin::plug::mem::SSAConstr::rewrite(), thorin::plug::clos::ClosConvPrep::rewrite_arg(), thorin::plug::clos::ClosConvPrep::rewrite_callee(), thorin::Pack::set(), thorin::Infer::set(), set(), thorin::Lam::set(), thorin::Sigma::set(), thorin::Sigma::set(), thorin::Lam::set_body(), thorin::Arr::set_body(), thorin::Pi::set_codom(), thorin::Pi::set_dom(), thorin::Pi::set_dom(), thorin::Lam::set_filter(), thorin::Arr::set_shape(), thorin::TBound< Up >::stub(), thorin::TExt< Up >::stub(), thorin::Arr::stub(), stub(), and thorin::TuplePtrn::type().

◆ set() [11/14]

template<bool Ow = false>

Def * thorin::Def::set ( std::string s )

inline

Definition at line 477 of file def.h.

◆ set() [12/14]

template<bool Ow = false>

const Def * thorin::Def::set ( std::string s ) const

inline

Definition at line 477 of file def.h.

◆ set() [13/14]

template<bool Ow = false>

Def * thorin::Def::set ( Sym s )

inline

Definition at line 477 of file def.h.

◆ set() [14/14]

template<bool Ow = false>

const Def * thorin::Def::set ( Sym s ) const

inline

Definition at line 477 of file def.h.

◆ set_type()

Def * thorin::Def::set_type ( const Def * type )

Definition at line 296 of file def.cpp.

References thorin::Use::Type, type(), and unset_type().

Referenced by update().

◆ stream()

std::ostream & thorin::Def::stream	(	std::ostream &	os,
		int	max
	)		const

Definition at line 400 of file dump.cpp.

References world().

Referenced by dump(), and write().

◆ stub() [1/2]

Def * thorin::Def::stub ( Ref type )

inline

Definition at line 495 of file def.h.

References stub().

Referenced by stub().

◆ stub() [2/2]

Def * thorin::Def::stub	(	World &	w,
		Ref	type
	)

inline

Definition at line 494 of file def.h.

References set().

Referenced by thorin::TailRecElim::analyze(), thorin::LamSpec::rewrite(), and thorin::Rewriter::rewrite_mut().

◆ stub_()

virtual Def * thorin::Def::stub_	(	World &	,
		Ref
	)

inlineprivatevirtual

Reimplemented in thorin::Infer, thorin::Global, thorin::Pi, thorin::Lam, thorin::TBound< Up >, thorin::TExt< Up >, thorin::Sigma, thorin::Arr, and thorin::Pack.

Definition at line 551 of file def.h.

◆ sym() [1/4]

Sym thorin::Def::sym ( ) const

inline

Definition at line 470 of file def.h.

Referenced by thorin::plug::autodiff::AutoDiffEval::augment_lam(), debug_prefix(), debug_suffix(), thorin::plug::compile::InternalCleanup::enter(), thorin::World::make_external(), thorin::World::make_internal(), thorin::Scope::sym(), thorin_get_plugin(), and unique_name().

◆ sym() [2/4]

Sym thorin::Def::sym ( const char * s ) const

protected

Definition at line 417 of file def.cpp.

References thorin::World::sym(), and world().

◆ sym() [3/4]

Sym thorin::Def::sym ( std::string s ) const

protected

Definition at line 419 of file def.cpp.

References thorin::World::sym(), and world().

◆ sym() [4/4]

Sym thorin::Def::sym ( std::string_view s ) const

protected

Definition at line 418 of file def.cpp.

References thorin::World::sym(), and world().

◆ tproj()

const Def * thorin::Def::tproj ( nat_t i ) const

inline

As above but takes Def::num_tprojs.

Definition at line 365 of file def.h.

References num_tprojs(), and proj().

◆ tprojs() [1/2]

auto thorin::Def::tprojs ( ) const

inline

Definition at line 390 of file def.h.

References tprojs().

Referenced by tprojs().

◆ tprojs() [2/2]

template<class F >

auto thorin::Def::tprojs ( F f ) const

inline

Definition at line 381 of file def.h.

References num_tprojs(), and projs().

◆ transfer_external()

void thorin::Def::transfer_external ( Def * to )

inline

Definition at line 436 of file def.h.

References make_external(), and make_internal().

◆ tvar()

Ref thorin::Def::tvar ( nat_t i )

inline

Definition at line 403 of file def.h.

◆ tvars() [1/2]

auto thorin::Def::tvars ( )

inline

Definition at line 403 of file def.h.

◆ tvars() [2/2]

template<class F >

auto thorin::Def::tvars ( F f )

inline

Definition at line 403 of file def.h.

◆ type()

const Def * thorin::Def::type ( ) const

inline

Yields the raw type of this Def, i.e. maybe nullptr.

See also: Def::unfold_type.

Definition at line 248 of file def.h.

Referenced by thorin::World::app(), arity(), thorin::Check::assignable(), thorin::plug::autodiff::AutoDiffEval::augment_(), thorin::plug::autodiff::AutoDiffEval::augment_app(), thorin::plug::autodiff::AutoDiffEval::augment_extract(), thorin::plug::autodiff::AutoDiffEval::augment_pack(), thorin::plug::autodiff::AutoDiffEval::augment_tuple(), thorin::App::callee_type(), thorin::Pi::check(), thorin::Arr::check(), thorin::plug::clos::clos_pack(), thorin::plug::matrix::counting_for(), Def(), Def(), thorin::plug::autodiff::AutoDiffEval::derive_(), thorin::ll::Emitter::emit_bb(), thorin::plug::clos::ClosLit::env_type(), thorin::plug::clos::ClosConvPrep::eta_wrap(), extended_ops(), thorin::World::extract(), thorin::Bound::find(), thorin::flatten(), thorin::plug::clos::ClosLit::fnc_type(), thorin::Bound::get(), thorin::plug::compile::handle_optimization_part(), thorin::World::iapp(), thorin::World::iinfer(), thorin::World::insert(), is_term(), thorin::is_unit(), isa_lit_arity(), thorin::plug::mem::mem_def(), thorin::merge_tuple(), thorin::plug::core::normalize_bitcast(), thorin::plug::core::normalize_conv(), thorin::plug::math::normalize_conv(), thorin::plug::core::normalize_shr(), thorin::plug::core::op(), thorin::plug::direct::op_cps2ds_dep(), thorin::plug::mem::op_lea(), thorin::plug::mem::op_lea_unsafe(), thorin::plug::matrix::op_read(), thorin::optimize(), thorin::World::pack(), proj(), refine(), thorin::plug::mem::replace_mem(), thorin::EtaExp::rewrite(), thorin::plug::matrix::LowerMatrixHighLevelMapRed::rewrite_(), thorin::plug::clos::ClosConvPrep::rewrite_callee(), thorin::Rewriter::rewrite_imm(), thorin::plug::matrix::LowerMatrixLowLevel::rewrite_imm(), thorin::Rewriter::rewrite_mut(), thorin::PassMan::run(), thorin::Scheduler::Scheduler(), set_type(), thorin::Pack::shape(), thorin::plug::mem::strip_mem(), thorin::Infer::stub(), thorin::Pi::stub(), thorin::TBound< Up >::stub(), thorin::TExt< Up >::stub(), thorin::Sigma::stub(), thorin::Arr::stub(), thorin::Pack::stub(), thorin::World::test(), thorin::World::tuple(), thorin::plug::clos::ClosLit::type(), thorin::Global::type(), thorin::Lam::type(), thorin::World::type(), thorin::World::uinc(), update(), and world().

◆ unfold_type()

const Def * thorin::Def::unfold_type ( ) const

Yields the type of this Def and builds a new .Type (UInc n) if necessary.

Definition at line 427 of file def.cpp.

References thorin::World::type(), and world().

Referenced by thorin::World::arr(), thorin::Arr::check(), and thorin::Pi::infer().

◆ unique_name()

std::string thorin::Def::unique_name ( ) const

name + "_" + Def::gid

Definition at line 524 of file def.cpp.

References gid(), and sym().

Referenced by thorin::ll::Emitter::emit_epilogue().

◆ unset()

Def * thorin::Def::unset ( )

Unsets all Def::ops; works even, if not set at all or partially.

Definition at line 272 of file def.cpp.

References num_ops(), op(), and unset().

Referenced by reset(), thorin::Infer::unset(), unset(), thorin::Pi::unset(), thorin::Lam::unset(), thorin::Sigma::unset(), thorin::Arr::unset(), and thorin::Pack::unset().

◆ unset_type()

void thorin::Def::unset_type ( )

Definition at line 306 of file def.cpp.

References thorin::Use::Type.

Referenced by set_type().

◆ update()

void thorin::Def::update ( )

inline

Resolves Infers of this Def's type.

Definition at line 299 of file def.h.

References thorin::Ref::refer(), set_type(), and type().

Referenced by thorin::Infer::find(), and set().

◆ uses()

const Uses & thorin::Def::uses ( ) const

inline

Definition at line 328 of file def.h.

Referenced by num_uses(), and proj().

◆ var() [1/3]

Ref thorin::Def::var ( )

Not necessarily a Var: E.g., if the return type is [], this will yield ().

Definition at line 467 of file def.cpp.

References world().

Referenced by Def(), thorin::Pi::immutabilize(), thorin::Arr::immutabilize(), thorin::Pack::immutabilize(), and thorin::Lam::ret_var().

◆ var() [2/3]

Ref thorin::Def::var	(	nat_t	a,
		nat_t	i
	)

inline

Definition at line 403 of file def.h.

Referenced by thorin::World::app(), thorin::plug::autodiff::AutoDiffEval::augment_app(), thorin::plug::autodiff::AutoDiffEval::augment_lam(), thorin::plug::autodiff::AutoDiffEval::derive_(), thorin::ll::Emitter::emit_epilogue(), thorin::plug::clos::ClosLit::env_var(), thorin::plug::clos::ClosConvPrep::eta_wrap(), thorin::World::extract(), thorin::Scope::is_free(), thorin::plug::clos::isa_clos_type(), thorin::plug::mem::mem_var(), thorin::plug::direct::op_cps2ds_dep(), thorin::rewrite(), thorin::rewrite(), and thorin::rewrite().

◆ var() [3/3]

Ref thorin::Def::var ( nat_t i )

inline

Definition at line 403 of file def.h.

◆ vars() [1/4]

template<nat_t A = std::dynamic_extent>

auto thorin::Def::vars ( )

inline

Definition at line 403 of file def.h.

Referenced by free_vars().

◆ vars() [2/4]

template<nat_t A = std::dynamic_extent, class F >

auto thorin::Def::vars ( F f )

inline

Definition at line 403 of file def.h.

Referenced by thorin::RetWrap::enter(), and thorin::plug::affine::LowerFor::rewrite().

◆ vars() [3/4]

auto thorin::Def::vars ( nat_t a )

inline

Definition at line 403 of file def.h.

◆ vars() [4/4]

template<class F >

auto thorin::Def::vars	(	nat_t	a,
		F	f
	)

inline

Definition at line 403 of file def.h.

◆ world()

World & thorin::Def::world ( ) const

Definition at line 421 of file def.cpp.

References type(), and world().

◆ write() [1/2]

void thorin::Def::write ( int max ) const

Definition at line 427 of file dump.cpp.

References write().

Referenced by write().

◆ write() [2/2]

void thorin::Def::write	(	int	max,
		const char *	file
	)		const

Definition at line 422 of file dump.cpp.

References stream().

Member Data Documentation

◆ [union]

union { ... } thorin::Def

◆ curry_

u8 thorin::Def::curry_

protected

Definition at line 578 of file def.h.

Referenced by thorin::Axiom::curry(), and thorin::App::curry().

◆ dbg_

Dbg thorin::Def::dbg_

mutableprotected

Definition at line 570 of file def.h.

Referenced by debug_prefix(), and debug_suffix().

◆ flags_

flags_t thorin::Def::flags_

protected

Definition at line 577 of file def.h.

Referenced by Def(), flags(), thorin::Pi::make_explicit(), and thorin::Pi::make_implicit().

◆ trip_

u8 thorin::Def::trip_

protected

Definition at line 579 of file def.h.

Referenced by thorin::Axiom::trip(), and thorin::App::trip().

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

include/thorin/def.h
src/thorin/def.cpp
src/thorin/dot.cpp
src/thorin/dump.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Def() [1/3]

◆ Def() [2/3]

◆ Def() [3/3]

◆ ~Def()

Member Function Documentation

◆ arity()

◆ as_imm()

◆ as_lit_arity()

◆ as_mut()

◆ check()

◆ dbg()

◆ debug_prefix()

◆ debug_suffix()

◆ dep()

◆ dep_const()

◆ dot() [1/3]

◆ dot() [2/3]

◆ dot() [3/3]

◆ dump() [1/2]

◆ dump() [2/2]

◆ extended_op()

◆ extended_ops()

◆ flags()

◆ free_vars() [1/2]

◆ free_vars() [2/2]

◆ fv_consumers()

◆ gid()

◆ has_dep() [1/2]

◆ has_dep() [2/2]

◆ has_var() [1/2]

◆ has_var() [2/2]

◆ hash()

◆ immutabilize()

◆ is_closed()

◆ is_external()

◆ is_open()

◆ is_set()

◆ is_term()

◆ isa_imm() [1/2]

◆ isa_imm() [2/2]

◆ isa_lit_arity()

◆ isa_mut()

◆ loc()

◆ local_muts()

◆ local_vars()

◆ make_external()

◆ make_internal()

◆ node()

◆ node_name()

◆ num_extended_ops()

◆ num_ops()

◆ num_partial_ops()

◆ num_projs()

◆ num_tprojs()

◆ num_tvars()

◆ num_uses()

◆ num_vars()

◆ op()

◆ ops()

◆ partial_op()

◆ partial_ops()

◆ proj() [1/2]

◆ proj() [2/2]

◆ projs() [1/4]

◆ projs() [2/4]

◆ projs() [3/4]

◆ projs() [4/4]

◆ rebuild() [1/2]

◆ rebuild() [2/2]

◆ rebuild_()

◆ reduce() [1/2]

◆ reduce() [2/2]

◆ refine()

◆ reset() [1/2]