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

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

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

Public Member Functions
	Eval (World &world, flags_t annex)

const Def *	rewrite (const Def *) override
	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)

Public Member Functions inherited from mim::RWPass< Eval, Lam >
	RWPass (World &world, std::string name)

	RWPass (World &world, flags_t annex)

bool	inspect () const override
	Should the PassMan even consider this pass?

Lam *	curr_mut () const

Public Member Functions inherited from mim::Pass
	Pass (World &world, std::string name)

	Pass (World &world, flags_t annex)

virtual void	init (PassMan *)

PassMan &	man ()

const PassMan &	man () const

size_t	index () const

virtual const Def *	rewrite (const Var *var)

virtual const Def *	rewrite (const Proxy *proxy)

virtual undo_t	analyze (const Def *)

virtual undo_t	analyze (const Var *)

virtual undo_t	analyze (const Proxy *)

virtual bool	fixed_point () const

virtual void	enter ()
	Invoked just before Pass::rewriteing PassMan::curr_mut's body.

virtual void	prepare ()
	Invoked once before entering the main rewrite loop.

const Proxy *	proxy (const Def *type, Defs ops, u32 tag=0)

const Proxy *	isa_proxy (const Def *def, u32 tag=0)
	Check whether given `def` is a Proxy whose Proxy::pass matches this Pass's `IPass::index`.

const Proxy *	as_proxy (const Def *def, u32 tag=0)

Public Member Functions inherited from mim::Stage
World &	world ()

Driver &	driver ()

Log &	log () const

std::string_view	name () const

flags_t	annex () const

	Stage (World &world, std::string name)

	Stage (World &world, flags_t annex)

virtual	~Stage ()=default

virtual std::unique_ptr< Stage >	recreate ()
	Creates a new instance; needed by a fixed-point PhaseMan.

virtual void	apply (const App *)
	Invoked if your Stage has additional args.

virtual void	apply (Stage &)
	Dito, but invoked by Stage::recreate.

Additional Inherited Members
static auto	create (const Flags2Stages &stages, const Def *def)

template<class A, class P>
static void	hook (Flags2Stages &stages)

Protected Attributes inherited from mim::Stage
std::string	name_

Detailed Description

This pass is the heart of AD.

We replace an autodiff fun call with the differentiated function.

Definition at line 10 of file eval.h.

Constructor & Destructor Documentation

◆ Eval()

mim::plug::autodiff::Eval::Eval	(	World &	world,
		flags_t	annex )

inline

Definition at line 12 of file eval.h.

References mim::Stage::annex(), mim::RWPass< Eval, Lam >::RWPass(), and mim::Stage::world().

Member Function Documentation

◆ augment()

const Def * mim::plug::autodiff::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 10 of file eval.cpp.

References augment_().

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