Numeric.AD.Classes

Documentation

class Lifted t => Mode t where

Methods

isKnownConstant :: t a -> Bool

allowed to return False for items with a zero derivative, but we'll give more NaNs than strictly necessary

isKnownZero :: Num a => t a -> Bool

allowed to return False for zero, but we give more NaN's than strictly necessary then

lift :: Num a => a -> t a

Embed a constant

(<+>) :: Num a => t a -> t a -> t a

Vector sum

(*^) :: Num a => a -> t a -> t a

Scalar-vector multiplication

(^*) :: Num a => t a -> a -> t a

Vector-scalar multiplication

(^/) :: Fractional a => t a -> a -> t a

Scalar division

(<**>) :: Floating a => t a -> t a -> t a

Exponentiation, this should be overloaded if you can figure out anything about what is constant!

zero :: Num a => t a

 'zero' = 'lift' 0

Instances

Mode Id

Lifted Forward => Mode Forward

Lifted Tower => Mode Tower

Lifted Reverse => Mode Reverse

Lifted Sparse => Mode Sparse

Mode f => Mode (AD f)

(Traversable f, Lifted (Dense f)) => Mode (Dense f)

(Mode f, Mode g) => Mode (ComposeMode f g)