{-# LANGUAGE DefaultSignatures #-}
{-# LANGUAGE TypeFamilies #-}

-- | Field classes
module NumHask.Algebra.Field
  ( SemiField,
    Field,
    ExpField (..),
    QuotientField (..),
    infinity,
    negInfinity,
    nan,
    TrigField (..),
    half,
  )
where

import Data.Bool (bool)
import Data.Kind
import NumHask.Algebra.Additive (Additive (..), Subtractive (..), (-))
import NumHask.Algebra.Multiplicative
  ( Divisive (..),
    Multiplicative (..),
    (/),
  )
import NumHask.Algebra.Ring (Distributive, Ring, two)
import NumHask.Data.Integral (Integral, even)
import Prelude ((.))
import Prelude qualified as P

-- $setup
--
-- >>> :m -Prelude
-- >>> :set -XRebindableSyntax
-- >>> :set -XScopedTypeVariables
-- >>> import NumHask.Prelude

-- | A <https://en.wikipedia.org/wiki/Semifield Semifield> is a field with no substraction.
--
-- @since 0.12
type SemiField a = (Distributive a, Divisive a)

-- | A <https://en.wikipedia.org/wiki/Field_(mathematics) Field> is a set
--   on which addition, subtraction, multiplication, and division are defined. It is also assumed that multiplication is distributive over addition.
--
-- A summary of the rules inherited from super-classes of Field:
--
-- > zero + a == a
-- > a + zero == a
-- > ((a + b) + c) (a + (b + c))
-- > a + b == b + a
-- > a - a == zero
-- > negate a == zero - a
-- > negate a + a == zero
-- > a + negate a == zero
-- > one * a == a
-- > a * one == a
-- > ((a * b) * c) == (a * (b * c))
-- > (a * (b + c)) == (a * b + a * c)
-- > ((a + b) * c) == (a * c + b * c)
-- > a * zero == zero
-- > zero * a == zero
-- > a / a == one || a == zero
-- > recip a == one / a || a == zero
-- > recip a * a == one || a == zero
-- > a * recip a == one || a == zero
type Field a = (Ring a, Divisive a)

-- | A hyperbolic field class
--
-- prop> \(a::Double) -> a < zero || (sqrt . (**2)) a == a
-- prop> \(a::Double) -> a < zero || (log . exp) a ~= a
-- prop> \(a::Double) (b::Double) -> (b < zero) || a <= zero || a == 1 || abs (a ** logBase a b - b) < 10 * epsilon
class
  (Field a) =>
  ExpField a
  where
  exp :: a -> a
  log :: a -> a
  (**) :: a -> a -> a
  (**) a
a a
b = a -> a
forall a. ExpField a => a -> a
exp (a -> a
forall a. ExpField a => a -> a
log a
a a -> a -> a
forall a. Multiplicative a => a -> a -> a
* a
b)

  -- | log to the base of
  --
  -- >>> logBase 2 8
  -- 2.9999999999999996
  logBase :: a -> a -> a
  logBase a
a a
b = a -> a
forall a. ExpField a => a -> a
log a
b a -> a -> a
forall a. Divisive a => a -> a -> a
/ a -> a
forall a. ExpField a => a -> a
log a
a

  -- | square root
  --
  -- >>> sqrt 4
  -- 2.0
  sqrt :: a -> a
  sqrt a
a = a
a a -> a -> a
forall a. ExpField a => a -> a -> a
** (a
forall a. Multiplicative a => a
one a -> a -> a
forall a. Divisive a => a -> a -> a
/ (a
forall a. Multiplicative a => a
one a -> a -> a
forall a. Additive a => a -> a -> a
+ a
forall a. Multiplicative a => a
one))

instance ExpField P.Double where
  exp :: Double -> Double
exp = Double -> Double
forall a. Floating a => a -> a
P.exp
  log :: Double -> Double
log = Double -> Double
forall a. Floating a => a -> a
P.log
  ** :: Double -> Double -> Double
(**) = Double -> Double -> Double
forall a. Floating a => a -> a -> a
(P.**)

instance ExpField P.Float where
  exp :: Float -> Float
exp = Float -> Float
forall a. Floating a => a -> a
P.exp
  log :: Float -> Float
log = Float -> Float
forall a. Floating a => a -> a
P.log
  ** :: Float -> Float -> Float
(**) = Float -> Float -> Float
forall a. Floating a => a -> a -> a
(P.**)

instance (ExpField b) => ExpField (a -> b) where
  exp :: (a -> b) -> a -> b
exp a -> b
f = b -> b
forall a. ExpField a => a -> a
exp (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  log :: (a -> b) -> a -> b
log a -> b
f = b -> b
forall a. ExpField a => a -> a
log (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f

-- | Quotienting of a 'Field' into a 'NumHask.Algebra.Ring'
--
-- See [Field of fractions](https://en.wikipedia.org/wiki/Field_of_fractions)
--
-- > \a -> a - one < floor a <= a <= ceiling a < a + one
class (SemiField a) => QuotientField a where
  type Whole a :: Type
  properFraction :: a -> (Whole a, a)

  -- | round to the nearest Int
  --
  -- Exact ties are managed by rounding down ties if the whole component is even.
  --
  -- >>> round (1.5 :: Double)
  -- 2
  --
  -- >>> round (2.5 :: Double)
  -- 2
  round :: a -> Whole a
  default round :: (Subtractive a, Integral (Whole a), P.Eq (Whole a), P.Ord a, Subtractive (Whole a)) => a -> Whole a
  round a
x = case a -> (Whole a, a)
forall a. QuotientField a => a -> (Whole a, a)
properFraction a
x of
    (Whole a
n, a
r) ->
      let m :: Whole a
m = Whole a -> Whole a -> Bool -> Whole a
forall a. a -> a -> Bool -> a
bool (Whole a
n Whole a -> Whole a -> Whole a
forall a. Additive a => a -> a -> a
+ Whole a
forall a. Multiplicative a => a
one) (Whole a
n Whole a -> Whole a -> Whole a
forall a. Subtractive a => a -> a -> a
- Whole a
forall a. Multiplicative a => a
one) (a
r a -> a -> Bool
forall a. Ord a => a -> a -> Bool
P.< a
forall a. Additive a => a
zero)
          half_up :: a
half_up = a -> a
forall {a}. (Ord a, Subtractive a) => a -> a
abs' a
r a -> a -> a
forall a. Additive a => a -> a -> a
+ a
forall a. (Additive a, Divisive a) => a
half
          abs' :: a -> a
abs' a
a
            | a
a a -> a -> Bool
forall a. Ord a => a -> a -> Bool
P.< a
forall a. Additive a => a
zero = a -> a
forall a. Subtractive a => a -> a
negate a
a
            | Bool
P.otherwise = a
a
       in case a -> a -> Ordering
forall a. Ord a => a -> a -> Ordering
P.compare a
half_up a
forall a. Multiplicative a => a
one of
            Ordering
P.LT -> Whole a
n
            Ordering
P.EQ -> Whole a -> Whole a -> Bool -> Whole a
forall a. a -> a -> Bool -> a
bool Whole a
m Whole a
n (Whole a -> Bool
forall a. (Eq a, Integral a) => a -> Bool
even Whole a
n)
            Ordering
P.GT -> Whole a
m

  -- | supply the next upper whole component
  --
  -- >>> ceiling (1.001 :: Double)
  -- 2
  ceiling :: a -> Whole a
  default ceiling :: (P.Ord a, Distributive (Whole a)) => a -> Whole a
  ceiling a
x = Whole a -> Whole a -> Bool -> Whole a
forall a. a -> a -> Bool -> a
bool Whole a
n (Whole a
n Whole a -> Whole a -> Whole a
forall a. Additive a => a -> a -> a
+ Whole a
forall a. Multiplicative a => a
one) (a
r a -> a -> Bool
forall a. Ord a => a -> a -> Bool
P.> a
forall a. Additive a => a
zero)
    where
      (Whole a
n, a
r) = a -> (Whole a, a)
forall a. QuotientField a => a -> (Whole a, a)
properFraction a
x

  -- | supply the previous lower whole component
  --
  -- >>> floor (1.001 :: Double)
  -- 1
  floor :: a -> Whole a
  default floor :: (P.Ord a, Subtractive (Whole a), Distributive (Whole a)) => a -> Whole a
  floor a
x = Whole a -> Whole a -> Bool -> Whole a
forall a. a -> a -> Bool -> a
bool Whole a
n (Whole a
n Whole a -> Whole a -> Whole a
forall a. Subtractive a => a -> a -> a
- Whole a
forall a. Multiplicative a => a
one) (a
r a -> a -> Bool
forall a. Ord a => a -> a -> Bool
P.< a
forall a. Additive a => a
zero)
    where
      (Whole a
n, a
r) = a -> (Whole a, a)
forall a. QuotientField a => a -> (Whole a, a)
properFraction a
x

  -- | supply the whole component closest to zero
  --
  -- >>> floor (-1.001 :: Double)
  -- -2
  --
  -- >>> truncate (-1.001 :: Double)
  -- -1
  truncate :: a -> Whole a
  default truncate :: (P.Ord a) => a -> Whole a
  truncate a
x = Whole a -> Whole a -> Bool -> Whole a
forall a. a -> a -> Bool -> a
bool (a -> Whole a
forall a. QuotientField a => a -> Whole a
ceiling a
x) (a -> Whole a
forall a. QuotientField a => a -> Whole a
floor a
x) (a
x a -> a -> Bool
forall a. Ord a => a -> a -> Bool
P.> a
forall a. Additive a => a
zero)

instance QuotientField P.Float where
  type Whole P.Float = P.Int
  properFraction :: Float -> (Whole Float, Float)
properFraction = Float -> (Int, Float)
Float -> (Whole Float, Float)
forall b. Integral b => Float -> (b, Float)
forall a b. (RealFrac a, Integral b) => a -> (b, a)
P.properFraction

instance QuotientField P.Double where
  type Whole P.Double = P.Int
  properFraction :: Double -> (Whole Double, Double)
properFraction = Double -> (Int, Double)
Double -> (Whole Double, Double)
forall b. Integral b => Double -> (b, Double)
forall a b. (RealFrac a, Integral b) => a -> (b, a)
P.properFraction

-- | infinity is defined for any 'Field'.
--
-- >>> one / zero + infinity
-- Infinity
--
-- >>> infinity + 1
-- Infinity
infinity :: (SemiField a) => a
infinity :: forall a. SemiField a => a
infinity = a
forall a. Multiplicative a => a
one a -> a -> a
forall a. Divisive a => a -> a -> a
/ a
forall a. Additive a => a
zero

-- | nan is defined as zero/zero
--
-- but note the (social) law:
--
-- >>> nan == zero / zero
-- False
nan :: (SemiField a) => a
nan :: forall a. SemiField a => a
nan = a
forall a. Additive a => a
zero a -> a -> a
forall a. Divisive a => a -> a -> a
/ a
forall a. Additive a => a
zero

-- | negative infinity
--
-- >>> negInfinity + infinity
-- NaN
negInfinity :: (Field a) => a
negInfinity :: forall a. Field a => a
negInfinity = a -> a
forall a. Subtractive a => a -> a
negate a
forall a. SemiField a => a
infinity

-- | Trigonometric Field
--
-- The list of laws is quite long: <https://en.wikipedia.org/wiki/List_of_trigonometric_identities trigonometric identities>
class
  (Field a) =>
  TrigField a
  where
  pi :: a
  sin :: a -> a
  cos :: a -> a
  tan :: a -> a
  tan a
x = a -> a
forall a. TrigField a => a -> a
sin a
x a -> a -> a
forall a. Divisive a => a -> a -> a
/ a -> a
forall a. TrigField a => a -> a
cos a
x
  asin :: a -> a
  acos :: a -> a
  atan :: a -> a
  atan2 :: a -> a -> a
  sinh :: a -> a
  cosh :: a -> a
  tanh :: a -> a
  tanh a
x = a -> a
forall a. TrigField a => a -> a
sinh a
x a -> a -> a
forall a. Divisive a => a -> a -> a
/ a -> a
forall a. TrigField a => a -> a
cosh a
x
  asinh :: a -> a
  acosh :: a -> a
  atanh :: a -> a

instance TrigField P.Double where
  pi :: Double
pi = Double
forall a. Floating a => a
P.pi
  sin :: Double -> Double
sin = Double -> Double
forall a. Floating a => a -> a
P.sin
  cos :: Double -> Double
cos = Double -> Double
forall a. Floating a => a -> a
P.cos
  asin :: Double -> Double
asin = Double -> Double
forall a. Floating a => a -> a
P.asin
  acos :: Double -> Double
acos = Double -> Double
forall a. Floating a => a -> a
P.acos
  atan :: Double -> Double
atan = Double -> Double
forall a. Floating a => a -> a
P.atan
  atan2 :: Double -> Double -> Double
atan2 = Double -> Double -> Double
forall a. RealFloat a => a -> a -> a
P.atan2
  sinh :: Double -> Double
sinh = Double -> Double
forall a. Floating a => a -> a
P.sinh
  cosh :: Double -> Double
cosh = Double -> Double
forall a. Floating a => a -> a
P.cosh
  asinh :: Double -> Double
asinh = Double -> Double
forall a. Floating a => a -> a
P.sinh
  acosh :: Double -> Double
acosh = Double -> Double
forall a. Floating a => a -> a
P.acosh
  atanh :: Double -> Double
atanh = Double -> Double
forall a. Floating a => a -> a
P.atanh

instance TrigField P.Float where
  pi :: Float
pi = Float
forall a. Floating a => a
P.pi
  sin :: Float -> Float
sin = Float -> Float
forall a. Floating a => a -> a
P.sin
  cos :: Float -> Float
cos = Float -> Float
forall a. Floating a => a -> a
P.cos
  asin :: Float -> Float
asin = Float -> Float
forall a. Floating a => a -> a
P.asin
  acos :: Float -> Float
acos = Float -> Float
forall a. Floating a => a -> a
P.acos
  atan :: Float -> Float
atan = Float -> Float
forall a. Floating a => a -> a
P.atan
  atan2 :: Float -> Float -> Float
atan2 = Float -> Float -> Float
forall a. RealFloat a => a -> a -> a
P.atan2
  sinh :: Float -> Float
sinh = Float -> Float
forall a. Floating a => a -> a
P.sinh
  cosh :: Float -> Float
cosh = Float -> Float
forall a. Floating a => a -> a
P.cosh
  asinh :: Float -> Float
asinh = Float -> Float
forall a. Floating a => a -> a
P.sinh
  acosh :: Float -> Float
acosh = Float -> Float
forall a. Floating a => a -> a
P.acosh
  atanh :: Float -> Float
atanh = Float -> Float
forall a. Floating a => a -> a
P.atanh

instance (TrigField b) => TrigField (a -> b) where
  pi :: a -> b
pi a
_ = b
forall a. TrigField a => a
pi
  sin :: (a -> b) -> a -> b
sin a -> b
f = b -> b
forall a. TrigField a => a -> a
sin (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  cos :: (a -> b) -> a -> b
cos a -> b
f = b -> b
forall a. TrigField a => a -> a
cos (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  asin :: (a -> b) -> a -> b
asin a -> b
f = b -> b
forall a. TrigField a => a -> a
asin (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  acos :: (a -> b) -> a -> b
acos a -> b
f = b -> b
forall a. TrigField a => a -> a
acos (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  atan :: (a -> b) -> a -> b
atan a -> b
f = b -> b
forall a. TrigField a => a -> a
atan (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  atan2 :: (a -> b) -> (a -> b) -> a -> b
atan2 a -> b
f a -> b
g a
x = b -> b -> b
forall a. TrigField a => a -> a -> a
atan2 (a -> b
f a
x) (a -> b
g a
x)
  sinh :: (a -> b) -> a -> b
sinh a -> b
f = b -> b
forall a. TrigField a => a -> a
sinh (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  cosh :: (a -> b) -> a -> b
cosh a -> b
f = b -> b
forall a. TrigField a => a -> a
cosh (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  asinh :: (a -> b) -> a -> b
asinh a -> b
f = b -> b
forall a. TrigField a => a -> a
asinh (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  acosh :: (a -> b) -> a -> b
acosh a -> b
f = b -> b
forall a. TrigField a => a -> a
acosh (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f
  atanh :: (a -> b) -> a -> b
atanh a -> b
f = b -> b
forall a. TrigField a => a -> a
atanh (b -> b) -> (a -> b) -> a -> b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> b
f

-- | A half of 'one'
--
-- >>> half :: Double
-- 0.5
half :: (Additive a, Divisive a) => a
half :: forall a. (Additive a, Divisive a) => a
half = a
forall a. Multiplicative a => a
one a -> a -> a
forall a. Divisive a => a -> a -> a
/ a
forall a. (Multiplicative a, Additive a) => a
two