Numeric.AD.Rank1.Kahn

This module provides reverse-mode Automatic Differentiation using post-hoc linear time topological sorting.

For reverse mode AD we use StableName to recover sharing information from the tape to avoid combinatorial explosion, and thus run asymptotically faster than it could without such sharing information, but the use of side-effects contained herein is benign.

Documentation

data Kahn a

Kahn is a Mode using reverse-mode automatic differentiation that provides fast diffFU, diff2FU, grad, grad2 and a fast jacobian when you have a significantly smaller number of outputs than inputs.

Instances

(Num a, Bounded a) => Bounded (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

minBound :: Kahn a

maxBound :: Kahn a

(Num a, Enum a) => Enum (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

succ :: Kahn a -> Kahn a

pred :: Kahn a -> Kahn a

toEnum :: Int -> Kahn a

fromEnum :: Kahn a -> Int

enumFrom :: Kahn a -> [Kahn a]

enumFromThen :: Kahn a -> Kahn a -> [Kahn a]

enumFromTo :: Kahn a -> Kahn a -> [Kahn a]

enumFromThenTo :: Kahn a -> Kahn a -> Kahn a -> [Kahn a]

(Num a, Eq a) => Eq (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

(==) :: Kahn a -> Kahn a -> Bool

(/=) :: Kahn a -> Kahn a -> Bool

Floating a => Floating (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

pi :: Kahn a

exp :: Kahn a -> Kahn a

log :: Kahn a -> Kahn a

sqrt :: Kahn a -> Kahn a

(**) :: Kahn a -> Kahn a -> Kahn a

logBase :: Kahn a -> Kahn a -> Kahn a

sin :: Kahn a -> Kahn a

cos :: Kahn a -> Kahn a

tan :: Kahn a -> Kahn a

asin :: Kahn a -> Kahn a

acos :: Kahn a -> Kahn a

atan :: Kahn a -> Kahn a

sinh :: Kahn a -> Kahn a

cosh :: Kahn a -> Kahn a

tanh :: Kahn a -> Kahn a

asinh :: Kahn a -> Kahn a

acosh :: Kahn a -> Kahn a

atanh :: Kahn a -> Kahn a

log1p :: Kahn a -> Kahn a

expm1 :: Kahn a -> Kahn a

log1pexp :: Kahn a -> Kahn a

log1mexp :: Kahn a -> Kahn a

Fractional a => Fractional (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

(/) :: Kahn a -> Kahn a -> Kahn a

recip :: Kahn a -> Kahn a

fromRational :: Rational -> Kahn a

Num a => Num (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

(+) :: Kahn a -> Kahn a -> Kahn a

(-) :: Kahn a -> Kahn a -> Kahn a

(*) :: Kahn a -> Kahn a -> Kahn a

negate :: Kahn a -> Kahn a

abs :: Kahn a -> Kahn a

signum :: Kahn a -> Kahn a

fromInteger :: Integer -> Kahn a

(Num a, Ord a) => Ord (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

compare :: Kahn a -> Kahn a -> Ordering

(<) :: Kahn a -> Kahn a -> Bool

(<=) :: Kahn a -> Kahn a -> Bool

(>) :: Kahn a -> Kahn a -> Bool

(>=) :: Kahn a -> Kahn a -> Bool

max :: Kahn a -> Kahn a -> Kahn a

min :: Kahn a -> Kahn a -> Kahn a

Real a => Real (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

toRational :: Kahn a -> Rational

RealFloat a => RealFloat (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

floatRadix :: Kahn a -> Integer

floatDigits :: Kahn a -> Int

floatRange :: Kahn a -> (Int, Int)

decodeFloat :: Kahn a -> (Integer, Int)

encodeFloat :: Integer -> Int -> Kahn a

exponent :: Kahn a -> Int

significand :: Kahn a -> Kahn a

scaleFloat :: Int -> Kahn a -> Kahn a

isNaN :: Kahn a -> Bool

isInfinite :: Kahn a -> Bool

isDenormalized :: Kahn a -> Bool

isNegativeZero :: Kahn a -> Bool

isIEEE :: Kahn a -> Bool

atan2 :: Kahn a -> Kahn a -> Kahn a

RealFrac a => RealFrac (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

properFraction :: Integral b => Kahn a -> (b, Kahn a)

truncate :: Integral b => Kahn a -> b

round :: Integral b => Kahn a -> b

ceiling :: Integral b => Kahn a -> b

floor :: Integral b => Kahn a -> b

Show a => Show (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

showsPrec :: Int -> Kahn a -> ShowS

show :: Kahn a -> String

showList :: [Kahn a] -> ShowS

MuRef (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Associated Types

type DeRef (Kahn a) :: Type -> Type

Methods

mapDeRef :: Applicative f => (forall b. (MuRef b, DeRef (Kahn a) ~ DeRef b) => b -> f u) -> Kahn a -> f (DeRef (Kahn a) u)

Erf a => Erf (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

erf :: Kahn a -> Kahn a

erfc :: Kahn a -> Kahn a

erfcx :: Kahn a -> Kahn a

normcdf :: Kahn a -> Kahn a

InvErf a => InvErf (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Methods

inverf :: Kahn a -> Kahn a

inverfc :: Kahn a -> Kahn a

invnormcdf :: Kahn a -> Kahn a

Num a => Mode (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Associated Types

type Scalar (Kahn a)

Methods

isKnownConstant :: Kahn a -> Bool

asKnownConstant :: Kahn a -> Maybe (Scalar (Kahn a))

isKnownZero :: Kahn a -> Bool

auto :: Scalar (Kahn a) -> Kahn a

(*^) :: Scalar (Kahn a) -> Kahn a -> Kahn a

(^*) :: Kahn a -> Scalar (Kahn a) -> Kahn a

(^/) :: Kahn a -> Scalar (Kahn a) -> Kahn a

zero :: Kahn a

Num a => Jacobian (Kahn a)

Defined in Numeric.AD.Internal.Kahn

Associated Types

type D (Kahn a)

Methods

unary :: (Scalar (Kahn a) -> Scalar (Kahn a)) -> D (Kahn a) -> Kahn a -> Kahn a

lift1 :: (Scalar (Kahn a) -> Scalar (Kahn a)) -> (D (Kahn a) -> D (Kahn a)) -> Kahn a -> Kahn a

lift1_ :: (Scalar (Kahn a) -> Scalar (Kahn a)) -> (D (Kahn a) -> D (Kahn a) -> D (Kahn a)) -> Kahn a -> Kahn a

binary :: (Scalar (Kahn a) -> Scalar (Kahn a) -> Scalar (Kahn a)) -> D (Kahn a) -> D (Kahn a) -> Kahn a -> Kahn a -> Kahn a

lift2 :: (Scalar (Kahn a) -> Scalar (Kahn a) -> Scalar (Kahn a)) -> (D (Kahn a) -> D (Kahn a) -> (D (Kahn a), D (Kahn a))) -> Kahn a -> Kahn a -> Kahn a

lift2_ :: (Scalar (Kahn a) -> Scalar (Kahn a) -> Scalar (Kahn a)) -> (D (Kahn a) -> D (Kahn a) -> D (Kahn a) -> (D (Kahn a), D (Kahn a))) -> Kahn a -> Kahn a -> Kahn a

Num a => Grad (Kahn a) [a] (a, [a]) a

Defined in Numeric.AD.Internal.Kahn

Methods

pack :: Kahn a -> [Kahn a] -> Kahn a

unpack :: ([a] -> [a]) -> [a]

unpack' :: ([a] -> (a, [a])) -> (a, [a])

Grad i o o' a => Grad (Kahn a -> i) (a -> o) (a -> o') a

Defined in Numeric.AD.Internal.Kahn

Methods

pack :: (Kahn a -> i) -> [Kahn a] -> Kahn a

unpack :: ([a] -> [a]) -> a -> o

unpack' :: ([a] -> (a, [a])) -> a -> o'

type DeRef (Kahn a)

Defined in Numeric.AD.Internal.Kahn

type DeRef (Kahn a) = Tape a

type Scalar (Kahn a)

Defined in Numeric.AD.Internal.Kahn

type Scalar (Kahn a) = a

type D (Kahn a)

Defined in Numeric.AD.Internal.Kahn

type D (Kahn a) = Id a

auto :: Mode t => Scalar t -> t

Embed a constant

Gradient

grad :: (Traversable f, Num a) => (f (Kahn a) -> Kahn a) -> f a -> f a

The grad function calculates the gradient of a non-scalar-to-scalar function with kahn-mode AD in a single pass.

>>> grad (\[x,y,z] -> x*y+z) [1.0,2.0,3.0]
[2.0,1.0,1.0]

grad' :: (Traversable f, Num a) => (f (Kahn a) -> Kahn a) -> f a -> (a, f a)

The grad' function calculates the result and gradient of a non-scalar-to-scalar function with kahn-mode AD in a single pass.

>>> grad' (\[x,y,z] -> x*y+z) [1.0,2.0,3.0]
(5.0,[2.0,1.0,1.0])

gradWith :: (Traversable f, Num a) => (a -> a -> b) -> (f (Kahn a) -> Kahn a) -> f a -> f b

grad g f function calculates the gradient of a non-scalar-to-scalar function f with kahn-mode AD in a single pass. The gradient is combined element-wise with the argument using the function g.

grad = gradWith (_ dx -> dx)
id = gradWith const

gradWith' :: (Traversable f, Num a) => (a -> a -> b) -> (f (Kahn a) -> Kahn a) -> f a -> (a, f b)

grad' g f calculates the result and gradient of a non-scalar-to-scalar function f with kahn-mode AD in a single pass the gradient is combined element-wise with the argument using the function g.

grad' == gradWith' (_ dx -> dx)

Jacobian

jacobian :: (Traversable f, Functor g, Num a) => (f (Kahn a) -> g (Kahn a)) -> f a -> g (f a)

The jacobian function calculates the jacobian of a non-scalar-to-non-scalar function with kahn AD lazily in m passes for m outputs.

>>> jacobian (\[x,y] -> [y,x,x*y]) [2.0,1.0]
[[0.0,1.0],[1.0,0.0],[1.0,2.0]]

jacobian' :: (Traversable f, Functor g, Num a) => (f (Kahn a) -> g (Kahn a)) -> f a -> g (a, f a)

The jacobian' function calculates both the result and the Jacobian of a nonscalar-to-nonscalar function, using m invocations of kahn AD, where m is the output dimensionality. Applying fmap snd to the result will recover the result of jacobian | An alias for gradF'

ghci> jacobian' ([x,y] -> [y,x,x*y]) [2.0,1.0] [(1.0,[0.0,1.0]),(2.0,[1.0,0.0]),(2.0,[1.0,2.0])]

jacobianWith :: (Traversable f, Functor g, Num a) => (a -> a -> b) -> (f (Kahn a) -> g (Kahn a)) -> f a -> g (f b)

'jacobianWith g f' calculates the Jacobian of a non-scalar-to-non-scalar function f with kahn AD lazily in m passes for m outputs.

Instead of returning the Jacobian matrix, the elements of the matrix are combined with the input using the g.

jacobian = jacobianWith (_ dx -> dx)
jacobianWith const = (f x -> const x <$> f x)

jacobianWith' :: (Traversable f, Functor g, Num a) => (a -> a -> b) -> (f (Kahn a) -> g (Kahn a)) -> f a -> g (a, f b)

jacobianWith g f' calculates both the result and the Jacobian of a nonscalar-to-nonscalar function f, using m invocations of kahn AD, where m is the output dimensionality. Applying fmap snd to the result will recover the result of jacobianWith

Instead of returning the Jacobian matrix, the elements of the matrix are combined with the input using the g.

jacobian' == jacobianWith' (_ dx -> dx)

Hessian

hessian :: (Traversable f, Num a) => (f (On (Kahn (Kahn a))) -> On (Kahn (Kahn a))) -> f a -> f (f a)

Compute the hessian via the jacobian of the gradient. gradient is computed in Kahn mode and then the jacobian is computed in Kahn mode.

However, since the grad f :: f a -> f a is square this is not as fast as using the forward-mode jacobian of a reverse mode gradient provided by hessian.

>>> hessian (\[x,y] -> x*y) [1.0,2.0]
[[0.0,1.0],[1.0,0.0]]

hessianF :: (Traversable f, Functor g, Num a) => (f (On (Kahn (Kahn a))) -> g (On (Kahn (Kahn a)))) -> f a -> g (f (f a))

Compute the order 3 Hessian tensor on a non-scalar-to-non-scalar function via the Kahn-mode Jacobian of the Kahn-mode Jacobian of the function.

Less efficient than hessianF.

Derivatives

diff :: Num a => (Kahn a -> Kahn a) -> a -> a

Compute the derivative of a function.

>>> diff sin 0
1.0

>>> cos 0
1.0

diff' :: Num a => (Kahn a -> Kahn a) -> a -> (a, a)

The diff' function calculates the value and derivative, as a pair, of a scalar-to-scalar function.

>>> diff' sin 0
(0.0,1.0)

diffF :: (Functor f, Num a) => (Kahn a -> f (Kahn a)) -> a -> f a

Compute the derivatives of a function that returns a vector with regards to its single input.

>>> diffF (\a -> [sin a, cos a]) 0
[1.0,0.0]

diffF' :: (Functor f, Num a) => (Kahn a -> f (Kahn a)) -> a -> f (a, a)

Compute the derivatives of a function that returns a vector with regards to its single input as well as the primal answer.

>>> diffF' (\a -> [sin a, cos a]) 0
[(0.0,1.0),(1.0,0.0)]

Unsafe Variadic Gradient

Variadic combinators for variadic mixed-mode automatic differentiation.

Unfortunately, variadicity comes at the expense of being able to use quantification to avoid sensitivity confusion, so be careful when counting the number of auto calls you use when taking the gradient of a function that takes gradients!

vgrad :: Grad i o o' a => i -> o

vgrad' :: Grad i o o' a => i -> o'

class Num a => Grad i o o' a | i -> a o o', o -> a i o', o' -> a i o

Minimal complete definition

pack, unpack, unpack'

Instances

Num a => Grad (Kahn a) [a] (a, [a]) a

Defined in Numeric.AD.Internal.Kahn

Methods

pack :: Kahn a -> [Kahn a] -> Kahn a

unpack :: ([a] -> [a]) -> [a]

unpack' :: ([a] -> (a, [a])) -> (a, [a])

Grad i o o' a => Grad (Kahn a -> i) (a -> o) (a -> o') a

Defined in Numeric.AD.Internal.Kahn

Methods

pack :: (Kahn a -> i) -> [Kahn a] -> Kahn a

unpack :: ([a] -> [a]) -> a -> o

unpack' :: ([a] -> (a, [a])) -> a -> o'