{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -Wno-orphans #-}
{-# OPTIONS_GHC -Wno-pattern-namespace-specifier #-}

-- | Data primitives and utilities
--
-- Whilst the library makes use of <https://hackage.haskell.org/package/numhask numhask>, it does not re-export, to avoid clashes with Prelude, with the exception of 'zero', 'one', 'angle' & 'abs'.
--
-- 'Rect' and 'Point', from <https://hackage.haskell.org/package/numhask-space numhask-space>, make up the base elements of many chart primitives.
module Chart.Data
  ( -- * Data Primitives
    Rect (..),
    pattern Rect,
    mid,
    foldRect,
    addPoint,
    projectOnP,
    projectOnR,
    space1,
    padRect,
    padSingletons,
    isSingleton,
    Point (..),
    addp,
    Range (..),

    -- * NumHask Exports
    Multiplicative (one),
    Additive (zero),
    abs,
    Direction (..),
    Basis (..),
  )
where

import NumHask.Prelude
import NumHask.Space hiding (Chart)
import Prelude qualified as P

-- $setup
--
-- >>> import Chart
-- >>> import NumHask.Space

-- | Additive pad (or frame or buffer) a Rect.
--
-- >>> padRect 1 one
-- Rect (-1.5) 1.5 (-1.5) 1.5
padRect :: (Subtractive a) => a -> Rect a -> Rect a
padRect :: forall a. Subtractive a => a -> Rect a -> Rect a
padRect a
p (Rect a
x a
z a
y a
w) = a -> a -> a -> a -> Rect a
forall a. a -> a -> a -> a -> Rect a
Rect (a
x a -> a -> a
forall a. Subtractive a => a -> a -> a
- a
p) (a
z a -> a -> a
forall a. Additive a => a -> a -> a
+ a
p) (a
y a -> a -> a
forall a. Subtractive a => a -> a -> a
- a
p) (a
w a -> a -> a
forall a. Additive a => a -> a -> a
+ a
p)

-- | Pad a Rect to remove singleton dimensions.
--
-- Attempting to scale a singleton dimension of a Rect is a common bug.
--
-- Due to the use of scaling, and thus zero dividing, this is a common exception to guard against.
--
-- >>> project (Rect 0 0 0 1) one (Point 0 0)
-- Point NaN (-0.5)
--
-- >>> project (padSingletons (Rect 0 0 0 1)) one (Point 0 0)
-- Point 0.0 (-0.5)
padSingletons :: Rect Double -> Rect Double
padSingletons :: Rect Double -> Rect Double
padSingletons (Rect Double
x Double
z Double
y Double
w)
  | Double
x Double -> Double -> Bool
forall a. Eq a => a -> a -> Bool
== Double
z Bool -> Bool -> Bool
&& Double
y Double -> Double -> Bool
forall a. Eq a => a -> a -> Bool
== Double
w = Double -> Double -> Double -> Double -> Rect Double
forall a. a -> a -> a -> a -> Rect a
Rect (Double
x Double -> Double -> Double
forall a. Subtractive a => a -> a -> a
- Double
0.5) (Double
x Double -> Double -> Double
forall a. Additive a => a -> a -> a
+ Double
0.5) (Double
y Double -> Double -> Double
forall a. Subtractive a => a -> a -> a
- Double
0.5) (Double
y Double -> Double -> Double
forall a. Additive a => a -> a -> a
+ Double
0.5)
  | Double
x Double -> Double -> Bool
forall a. Eq a => a -> a -> Bool
== Double
z = Double -> Double -> Double -> Double -> Rect Double
forall a. a -> a -> a -> a -> Rect a
Rect (Double
x Double -> Double -> Double
forall a. Subtractive a => a -> a -> a
- Double
0.5) (Double
x Double -> Double -> Double
forall a. Additive a => a -> a -> a
+ Double
0.5) Double
y Double
w
  | Double
y Double -> Double -> Bool
forall a. Eq a => a -> a -> Bool
== Double
w = Double -> Double -> Double -> Double -> Rect Double
forall a. a -> a -> a -> a -> Rect a
Rect Double
x Double
z (Double
y Double -> Double -> Double
forall a. Subtractive a => a -> a -> a
- Double
0.5) (Double
y Double -> Double -> Double
forall a. Additive a => a -> a -> a
+ Double
0.5)
  | Bool
otherwise = Double -> Double -> Double -> Double -> Rect Double
forall a. a -> a -> a -> a -> Rect a
Rect Double
x Double
z Double
y Double
w

-- | is any dimension singular?
isSingleton :: Rect Double -> Bool
isSingleton :: Rect Double -> Bool
isSingleton (Rect Double
x Double
z Double
y Double
w) = Double
x Double -> Double -> Bool
forall a. Eq a => a -> a -> Bool
== Double
z Bool -> Bool -> Bool
|| Double
y Double -> Double -> Bool
forall a. Eq a => a -> a -> Bool
== Double
w

-- | add Points, dimension-wise
--
-- >>> Point 1 1 `addp` Point 0 2
-- Point 1.0 3.0
addp :: Point Double -> Point Double -> Point Double
addp :: Point Double -> Point Double -> Point Double
addp = Point Double -> Point Double -> Point Double
forall a. Additive a => a -> a -> a
(+)

-- | Orphan: bridge NumHask operations to Prelude.Num so numeric literals
-- and unary negation work without RebindableSyntax.
instance P.Num (Point Double) where
  + :: Point Double -> Point Double -> Point Double
(+) = Point Double -> Point Double -> Point Double
forall a. Additive a => a -> a -> a
(+)
  (-) = (-)
  * :: Point Double -> Point Double -> Point Double
(*) = Point Double -> Point Double -> Point Double
forall a. Multiplicative a => a -> a -> a
(*)
  negate :: Point Double -> Point Double
negate = Point Double -> Point Double
forall a. Subtractive a => a -> a
negate
  abs :: Point Double -> Point Double
abs = [Char] -> Point Double -> Point Double
forall a. HasCallStack => [Char] -> a
error [Char]
"abs: not defined for Point"
  signum :: Point Double -> Point Double
signum = [Char] -> Point Double -> Point Double
forall a. HasCallStack => [Char] -> a
error [Char]
"signum: not defined for Point"
  fromInteger :: Integer -> Point Double
fromInteger Integer
i = Double -> Double -> Point Double
forall a. a -> a -> Point a
Point (Integer -> Double
forall a. Num a => Integer -> a
P.fromInteger Integer
i) (Integer -> Double
forall a. Num a => Integer -> a
P.fromInteger Integer
i)