This phase is the heart of AD. More...

#include <mim/plug/autodiff/phase/eval.h>

Inheritance diagram for mim::plug::autodiff::phase::Eval:

Public Member Functions
const Def *	rewrite_imm_App (const App *) final
	Detect autodiff calls.
const Def *	derive (const Def *)
	Acts on toplevel autodiff on closed terms:
const Def *	derive_ (const Def *)
	Additionally to the derivation, the pullback is registered and the maps are initialized.
const Def *	augment (const Def , Lam , Lam *)
	Applies to (open) expressions in a functional context.
const Def *	augment_ (const Def , Lam , Lam *)
	Rewrites the given definition in a lambda environment.
const Def *	augment_var (const Var , Lam , Lam *)
	helper functions for augment
const Def *	augment_lam (Lam , Lam , Lam *)
const Def *	augment_extract (const Extract , Lam , Lam *)
const Def *	augment_app (const App , Lam , Lam *)
const Def *	augment_lit (const Lit , Lam , Lam *)
const Def *	augment_tuple (const Tuple , Lam , Lam *)
const Def *	augment_pack (const Pack pack, Lam f, Lam *f_diff)
const Def *	pullback (const Def aug, Lam f)
	The partial pullback of `aug` in the closed function `f`.
	RWPhase (World &world, std::string name, Analysis *analysis=nullptr)
	RWPhase (World &world, flags_t annex, Analysis *analysis=nullptr)
Public Member Functions inherited from mim::RWPhase
	RWPhase (World &world, std::string name, Analysis *analysis=nullptr)
	RWPhase (World &world, flags_t annex, Analysis *analysis=nullptr)
Analysis *	analysis ()
const Analysis *	analysis () const
const Def *	lattice (const Def *old_def) const
	Returns the abstract value computed by the associated Analysis for the given old-world Def, or nullptr if no value is available.
const Def *	abstracted (const Def *old_def) const
	Returns lattice(`old_def`) if it differs from `old_def` (i.e. we learned something), otherwise nullptr.
bool	is_top (const Def *old_def) const
virtual bool	analyze ()
	Runs the optional pre-analysis on old_world(), typically to a fixed point, before rewriting begins.
virtual void	rewrite_external (Def *)
const Def *	lookup (const Def *) override
	Lookup old_def by searching in reverse through the stack of maps.
World &	world ()=delete
	Hides both and forbids direct access.
World &	old_world ()
	Get old Defs from here.
World &	new_world ()
	Create new Defs into this.
Public Member Functions inherited from mim::Phase
	Phase (World &world, std::string name)
	Phase (World &world, flags_t annex)
virtual	~Phase ()=default
virtual std::unique_ptr< Phase >	recreate ()
	Creates a new instance; needed by a fixed-point PhaseMan.
virtual void	apply (const App *)
	Invoked if your Phase has additional args.
virtual void	apply (Phase &)
	Dito, but invoked by Phase::recreate.
virtual bool	redirects () const
	If true, Phase::create uses take_resolved().
virtual std::unique_ptr< Phase >	take_resolved ()
	The Phase to use instead; nullptr means elide.
World &	world ()
Driver &	driver ()
const fe::Log &	log () const
std::string_view	name () const
flags_t	annex () const
const fe::Vector< std::string > &	args ()
	Command-line arguments passed to this Phase's plugin via -X <plugin>:<arg>.
bool	todo () const
void	invalidate (bool todo=true)
	Signals that another round of fixed-point iteration is required, either as part of.
virtual void	run ()
	Entry point and generates some debug output; invokes Phase::start.
void	profile_count (std::string_view key, uint64_t n=1)
	Adds `n` to the custom fe::Profiler counter `key` of the current run; no-op unless profiling is enabled.
Public Member Functions inherited from mim::Rewriter
template<class D = Def>
D *	curr_mut () const
	Rewriter (World &world)
virtual	~Rewriter ()
void	reset ()
World &	world ()
void	push (Vars old_vars={}, Vars new_vars={})
void	pop ()
void	bind_old (const Var *var)
	Adds the old `var` - if any - to the innermost scope.
void	bind_new (const Var *var)
	Adds the new `var` - if any - to the innermost scope.
void	bind (const Var old_var, const Var new_var)
const Def *	map (const Def old_def, const Def new_def)
const Def *	map (const Def *old_def, Defs new_defs)
const Def *	map (Defs old_defs, const Def *new_def)
const Def *	map (Defs old_defs, Defs new_defs)
virtual const Def *	rewrite (const Def *)
virtual const Def *	rewrite_imm (const Def *)
virtual const Def *	rewrite_mut (Def *)
const Def *	rewrite_stub (Def old_mut, Def new_mut, fe::View< size_t > new2old)
	Like above, but `new_mut` may have a different number of ops than `old_mut:` new_mut->op(i) is rewritten from old_mut->op(new2old[i]).
virtual DefVec	rewrite (Defs)
virtual const Def *	rewrite_imm_Lit (const Lit *)
virtual const Def *	rewrite_imm_Axm (const Axm *)
virtual const Def *	rewrite_imm_Var (const Var *)
virtual const Def *	rewrite_imm_Proxy (const Proxy *)
virtual const Def *	rewrite_imm_Type (const Type *)
virtual const Def *	rewrite_imm_Level (const Level *)
virtual const Def *	rewrite_imm_LMax (const LMax *)
virtual const Def *	rewrite_imm_LSucc (const LSucc *)
virtual const Def *	rewrite_imm_Pi (const Pi *)
virtual const Def *	rewrite_imm_Lam (const Lam *)
virtual const Def *	rewrite_imm_Sigma (const Sigma *)
virtual const Def *	rewrite_imm_Extract (const Extract *)
virtual const Def *	rewrite_imm_Insert (const Insert *)
virtual const Def *	rewrite_imm_Arr (const Arr *)
virtual const Def *	rewrite_imm_Pack (const Pack *)
virtual const Def *	rewrite_imm_Join (const Join *)
virtual const Def *	rewrite_imm_Inj (const Inj *)
virtual const Def *	rewrite_imm_Match (const Match *)
virtual const Def *	rewrite_imm_Variant (const Variant *)
virtual const Def *	rewrite_imm_Top (const Top *)
virtual const Def *	rewrite_imm_Bot (const Bot *)
virtual const Def *	rewrite_imm_Reform (const Reform *)
virtual const Def *	rewrite_imm_Rule (const Rule *)
virtual const Def *	rewrite_imm_Single (const Single *)
virtual const Def *	rewrite_imm_Wrap (const Wrap *)
virtual const Def *	rewrite_imm_Nat (const Nat *)
virtual const Def *	rewrite_imm_Idx (const Idx *)
virtual const Def *	rewrite_imm_Nom (const Nom *)
virtual const Def *	rewrite_imm_Name (const Name *)
virtual const Def *	rewrite_imm_Struc (const Struc *)
virtual const Def *	rewrite_mut_Hole (Hole *)
virtual const Def *	rewrite_mut_Pi (Pi *)
virtual const Def *	rewrite_mut_Lam (Lam *)
virtual const Def *	rewrite_mut_Sigma (Sigma *)
virtual const Def *	rewrite_mut_Arr (Arr *)
virtual const Def *	rewrite_mut_Pack (Pack *)
virtual const Def *	rewrite_mut_Variant (Variant *)
virtual const Def *	rewrite_mut_Rule (Rule *)
virtual const Def *	rewrite_imm_Seq (const Seq *seq)
virtual const Def *	rewrite_mut_Seq (Seq *seq)

Additional Inherited Members
Static Public Member Functions inherited from mim::Phase
static std::unique_ptr< Phase >	create (const Flags2Phases &phases, const Def *def)
template<class A, class P>
static void	hook (Flags2Phases &phases)
template<class P, class... Args>
static void	run (Args &&... args)
	Runs a single Phase.
Protected Member Functions inherited from mim::RWPhase
void	start () override
	Actual entry.
virtual void	finalize ()
	Run after all roots have been walked but still before the two worlds are swapped.
const Def *	rewrite_imm_App (const App *) override
const Def *	rewrite_imm_Tuple (const Tuple *) override
const Def *	rewrite_stub (Def , Def ) override
const Def *	coerce (const Def new_type, const Def new_val)
	Converts the new `new_val` into a value of the new `new_type`, where a checking position demands it.
const Def *	rewrite_stub (Def old_mut, Def new_mut, fe::View< size_t > new2old)
	Like above, but `new_mut` may have a different number of ops than `old_mut:` new_mut->op(i) is rewritten from old_mut->op(new2old[i]).
Protected Member Functions inherited from mim::Rewriter
Def2Def &	old2new ()
	The map of the innermost push() scope.
bool	has_intersection (const Def *old_def)
	Does `old_def` depend on the old Vars of any scope?
auto	enter (Def *new_mut)
	Updates curr_mut() to `new_mut` and restores it at the end of the scope.
const Def *	seal (Def old_mut, Def new_mut)
	The tail of rewrite_stub: immutabilizes `new_mut` in hindsight, as rewriting may have made it vacuous.
static bool	splittable (const Def *type)
	Does coerce() explode and reassemble values of `type`?
Protected Attributes inherited from mim::Phase
std::string	name_
Protected Attributes inherited from mim::Rewriter
fe::Vector< Scope >	scopes_

Detailed Description

This phase is the heart of AD.

We replace an autodiff fun call with the differentiated function.

Definition at line 10 of file eval.h.

Member Function Documentation

◆ augment()

const Def * mim::plug::autodiff::phase::Eval::augment	(	const Def *	def,
		Lam *	f,
		Lam *	f_diff )

Applies to (open) expressions in a functional context.

Returns the rewritten expressions and augments the partial and modular pullbacks. The rewrite is identity on the term up to renaming of variables. Otherwise, only pullbacks are added. To do so, some calls (e.g. axms) are replaced by their derivatives. This transformation can be seen as an augmentation with a dual computation that generates the derivatives.

Definition at line 58 of file eval.cpp.

References augment_().

Referenced by augment_app(), augment_extract(), augment_lam(), augment_pack(), augment_tuple(), and derive_().

◆ augment_()

const Def * mim::plug::autodiff::phase::Eval::augment_	(	const Def *	def,
		Lam *	f,
		Lam *	f_diff )

Rewrites the given definition in a lambda environment.

Definition at line 391 of file eval.cpp.

References mim::World::annex(), augment_app(), augment_extract(), augment_lam(), augment_lit(), augment_pack(), augment_tuple(), augment_var(), mim::plug::autodiff::autodiff_type_fun(), mim::Def::isa_mut(), mim::Phase::log(), mim::Def::node_name(), mim::RWPhase::old_world(), mim::Rewriter::rewrite(), and mim::Def::type().

Referenced by augment(), and augment_pack().

◆ augment_app()

const Def * mim::plug::autodiff::phase::Eval::augment_app	(	const App *	app,
		Lam *	f,
		Lam *	f_diff )

Definition at line 314 of file eval.cpp.

References mim::App::arg(), augment(), mim::App::callee(), mim::plug::autodiff::phase::compose_cn(), mim::Pi::isa_basicblock(), mim::Pi::isa_cn(), mim::plug::cps::op_cps2ds_dep(), pullback(), mim::Pi::set(), mim::Def::type(), and mim::Def::var().

Referenced by augment_().

◆ augment_extract()

const Def * mim::plug::autodiff::phase::Eval::augment_extract	(	const Extract *	ext,
		Lam *	f,
		Lam *	f_diff )

Definition at line 216 of file eval.cpp.

References augment(), mim::Extract::index(), pullback(), mim::plug::autodiff::pullback_type(), mim::Extract::tuple(), and mim::Def::type().

Referenced by augment_().

◆ augment_lam()

const Def * mim::plug::autodiff::phase::Eval::augment_lam	(	Lam *	lam,
		Lam *	f,
		Lam *	f_diff )

Definition at line 166 of file eval.cpp.

References augment(), mim::plug::autodiff::autodiff_type_fun(), mim::Lam::body(), derive(), mim::Pi::dom(), mim::Lam::filter(), mim::Lam::isa_basicblock(), mim::plug::autodiff::pullback_type(), mim::Def::sym(), mim::Lam::type(), mim::Def::var(), and mim::plug::autodiff::zero_pullback().

Referenced by augment_().

◆ augment_lit()

const Def * mim::plug::autodiff::phase::Eval::augment_lit	(	const Lit *	lit,
		Lam *	f,
		Lam *	)

Definition at line 148 of file eval.cpp.

References mim::plug::autodiff::zero_pullback().

Referenced by augment_().

◆ augment_pack()

const Def * mim::plug::autodiff::phase::Eval::augment_pack	(	const Pack *	pack,
		Lam *	f,
		Lam *	f_diff )

Definition at line 279 of file eval.cpp.

References mim::Phase::annex(), mim::Def::arity(), augment(), augment_(), mim::Seq::body(), mim::plug::cps::op_cps2ds_dep(), pullback(), mim::plug::autodiff::pullback_type(), mim::plug::autodiff::tangent_type_fun(), and mim::Def::type().

Referenced by augment_().

◆ augment_tuple()

const Def * mim::plug::autodiff::phase::Eval::augment_tuple	(	const Tuple *	tup,
		Lam *	f,
		Lam *	f_diff )

Definition at line 249 of file eval.cpp.

References augment(), mim::plug::autodiff::op_sum(), mim::Def::projs(), pullback(), mim::plug::autodiff::pullback_type(), mim::plug::autodiff::tangent_type_fun(), and mim::Def::type().

Referenced by augment_().

◆ augment_var()

const Def * mim::plug::autodiff::phase::Eval::augment_var	(	const Var *	var,
		Lam *	,
		Lam *	)

helper functions for augment

Definition at line 160 of file eval.cpp.

Referenced by augment_().

◆ derive()

const Def * mim::plug::autodiff::phase::Eval::derive ( const Def * def )

Acts on toplevel autodiff on closed terms:

Replaces lambdas, operators with the appropriate derivatives.
Creates new lambda, calls associate variables, init maps, calls augment.

Definition at line 63 of file eval.cpp.

References derive_().

Referenced by augment_lam(), and rewrite_imm_App().

◆ derive_()

const Def * mim::plug::autodiff::phase::Eval::derive_ ( const Def * def )

Additionally to the derivation, the pullback is registered and the maps are initialized.

Definition at line 92 of file eval.cpp.

References mim::Def::as_mut(), augment(), mim::plug::autodiff::autodiff_type_fun_pi(), mim::plug::autodiff::id_pullback(), mim::Def::set(), mim::Def::var(), and mim::plug::autodiff::zero_pullback().

Referenced by derive().

◆ pullback()

const Def * mim::plug::autodiff::phase::Eval::pullback	(	const Def *	aug,
		Lam *	f )

The partial pullback of aug in the closed function f.

Definition at line 154 of file eval.cpp.

References mim::Def::type(), and mim::plug::autodiff::zero_pullback().

Referenced by augment_app(), augment_extract(), augment_pack(), and augment_tuple().

◆ rewrite_imm_App()

const Def * mim::plug::autodiff::phase::Eval::rewrite_imm_App ( const App * app )

finalvirtual

Detect autodiff calls.

Reimplemented from mim::Rewriter.

Definition at line 68 of file eval.cpp.

References derive(), mim::Axm::isa(), mim::Rewriter::rewrite(), and mim::RWPhase::rewrite_imm_App().

◆ RWPhase() [1/2]

mim::RWPhase::RWPhase	(	World &	world,
		flags_t	annex,
		Analysis *	analysis = nullptr )

inline

Definition at line 336 of file phase.h.

◆ RWPhase() [2/2]

mim::RWPhase::RWPhase	(	World &	world,
		std::string	name,
		Analysis *	analysis = nullptr )

inline

Definition at line 334 of file phase.h.

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

include/mim/plug/autodiff/phase/eval.h
src/mim/plug/autodiff/phase/eval.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ augment()

◆ augment_()

◆ augment_app()

◆ augment_extract()

◆ augment_lam()

◆ augment_lit()

◆ augment_pack()

◆ augment_tuple()

◆ augment_var()

◆ derive()

◆ derive_()

◆ pullback()

◆ rewrite_imm_App()

◆ RWPhase() [1/2]

◆ RWPhase() [2/2]