{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE UndecidableInstances #-}
--------------------------------------------------------------------------------
-- |
-- Module      :  HGeometry.ByIndex
-- Copyright   :  (C) Frank Staals
-- License     :  see the LICENSE file
-- Maintainer  :  Frank Staals
--
-- Types that have an Index, which is used to distinguish the
-- items. Hence, Eq and Ord are *only* based on the Index.
--
--------------------------------------------------------------------------------
module HGeometry.ByIndex
  ( ByIndex(ByIndex), theIndex, theValue
  , labelWithIndex
  ) where


import Control.Lens
import Data.Foldable1
import Control.DeepSeq
import GHC.Generics(Generic)
import Control.Monad.State.Strict

--------------------------------------------------------------------------------

-- | Helper data type for which the Ord and Eq instance are by index.
--
-- Note that one may use the index as some sort of optimization.
-- i.e. if the indices are the same, then the values are considerd the
-- same
data ByIndex ix a = ByIndex { forall ix a. ByIndex ix a -> ix
_theIndex :: !ix
                            , forall ix a. ByIndex ix a -> a
_theValue :: !a
                            }
  deriving stock ((forall a b. (a -> b) -> ByIndex ix a -> ByIndex ix b)
-> (forall a b. a -> ByIndex ix b -> ByIndex ix a)
-> Functor (ByIndex ix)
forall a b. a -> ByIndex ix b -> ByIndex ix a
forall a b. (a -> b) -> ByIndex ix a -> ByIndex ix b
forall ix a b. a -> ByIndex ix b -> ByIndex ix a
forall ix a b. (a -> b) -> ByIndex ix a -> ByIndex ix b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall ix a b. (a -> b) -> ByIndex ix a -> ByIndex ix b
fmap :: forall a b. (a -> b) -> ByIndex ix a -> ByIndex ix b
$c<$ :: forall ix a b. a -> ByIndex ix b -> ByIndex ix a
<$ :: forall a b. a -> ByIndex ix b -> ByIndex ix a
Functor,(forall m. Monoid m => ByIndex ix m -> m)
-> (forall m a. Monoid m => (a -> m) -> ByIndex ix a -> m)
-> (forall m a. Monoid m => (a -> m) -> ByIndex ix a -> m)
-> (forall a b. (a -> b -> b) -> b -> ByIndex ix a -> b)
-> (forall a b. (a -> b -> b) -> b -> ByIndex ix a -> b)
-> (forall b a. (b -> a -> b) -> b -> ByIndex ix a -> b)
-> (forall b a. (b -> a -> b) -> b -> ByIndex ix a -> b)
-> (forall a. (a -> a -> a) -> ByIndex ix a -> a)
-> (forall a. (a -> a -> a) -> ByIndex ix a -> a)
-> (forall a. ByIndex ix a -> [a])
-> (forall a. ByIndex ix a -> Bool)
-> (forall a. ByIndex ix a -> Int)
-> (forall a. Eq a => a -> ByIndex ix a -> Bool)
-> (forall a. Ord a => ByIndex ix a -> a)
-> (forall a. Ord a => ByIndex ix a -> a)
-> (forall a. Num a => ByIndex ix a -> a)
-> (forall a. Num a => ByIndex ix a -> a)
-> Foldable (ByIndex ix)
forall a. Eq a => a -> ByIndex ix a -> Bool
forall a. Num a => ByIndex ix a -> a
forall a. Ord a => ByIndex ix a -> a
forall m. Monoid m => ByIndex ix m -> m
forall a. ByIndex ix a -> Bool
forall a. ByIndex ix a -> Int
forall a. ByIndex ix a -> [a]
forall a. (a -> a -> a) -> ByIndex ix a -> a
forall ix a. Eq a => a -> ByIndex ix a -> Bool
forall ix a. Num a => ByIndex ix a -> a
forall ix a. Ord a => ByIndex ix a -> a
forall ix m. Monoid m => ByIndex ix m -> m
forall m a. Monoid m => (a -> m) -> ByIndex ix a -> m
forall ix a. ByIndex ix a -> Bool
forall ix a. ByIndex ix a -> Int
forall ix a. ByIndex ix a -> [a]
forall b a. (b -> a -> b) -> b -> ByIndex ix a -> b
forall a b. (a -> b -> b) -> b -> ByIndex ix a -> b
forall ix a. (a -> a -> a) -> ByIndex ix a -> a
forall ix m a. Monoid m => (a -> m) -> ByIndex ix a -> m
forall ix b a. (b -> a -> b) -> b -> ByIndex ix a -> b
forall ix a b. (a -> b -> b) -> b -> ByIndex ix a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
$cfold :: forall ix m. Monoid m => ByIndex ix m -> m
fold :: forall m. Monoid m => ByIndex ix m -> m
$cfoldMap :: forall ix m a. Monoid m => (a -> m) -> ByIndex ix a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> ByIndex ix a -> m
$cfoldMap' :: forall ix m a. Monoid m => (a -> m) -> ByIndex ix a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> ByIndex ix a -> m
$cfoldr :: forall ix a b. (a -> b -> b) -> b -> ByIndex ix a -> b
foldr :: forall a b. (a -> b -> b) -> b -> ByIndex ix a -> b
$cfoldr' :: forall ix a b. (a -> b -> b) -> b -> ByIndex ix a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> ByIndex ix a -> b
$cfoldl :: forall ix b a. (b -> a -> b) -> b -> ByIndex ix a -> b
foldl :: forall b a. (b -> a -> b) -> b -> ByIndex ix a -> b
$cfoldl' :: forall ix b a. (b -> a -> b) -> b -> ByIndex ix a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> ByIndex ix a -> b
$cfoldr1 :: forall ix a. (a -> a -> a) -> ByIndex ix a -> a
foldr1 :: forall a. (a -> a -> a) -> ByIndex ix a -> a
$cfoldl1 :: forall ix a. (a -> a -> a) -> ByIndex ix a -> a
foldl1 :: forall a. (a -> a -> a) -> ByIndex ix a -> a
$ctoList :: forall ix a. ByIndex ix a -> [a]
toList :: forall a. ByIndex ix a -> [a]
$cnull :: forall ix a. ByIndex ix a -> Bool
null :: forall a. ByIndex ix a -> Bool
$clength :: forall ix a. ByIndex ix a -> Int
length :: forall a. ByIndex ix a -> Int
$celem :: forall ix a. Eq a => a -> ByIndex ix a -> Bool
elem :: forall a. Eq a => a -> ByIndex ix a -> Bool
$cmaximum :: forall ix a. Ord a => ByIndex ix a -> a
maximum :: forall a. Ord a => ByIndex ix a -> a
$cminimum :: forall ix a. Ord a => ByIndex ix a -> a
minimum :: forall a. Ord a => ByIndex ix a -> a
$csum :: forall ix a. Num a => ByIndex ix a -> a
sum :: forall a. Num a => ByIndex ix a -> a
$cproduct :: forall ix a. Num a => ByIndex ix a -> a
product :: forall a. Num a => ByIndex ix a -> a
Foldable,Functor (ByIndex ix)
Foldable (ByIndex ix)
(Functor (ByIndex ix), Foldable (ByIndex ix)) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> ByIndex ix a -> f (ByIndex ix b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    ByIndex ix (f a) -> f (ByIndex ix a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> ByIndex ix a -> m (ByIndex ix b))
-> (forall (m :: * -> *) a.
    Monad m =>
    ByIndex ix (m a) -> m (ByIndex ix a))
-> Traversable (ByIndex ix)
forall ix. Functor (ByIndex ix)
forall ix. Foldable (ByIndex ix)
forall ix (m :: * -> *) a.
Monad m =>
ByIndex ix (m a) -> m (ByIndex ix a)
forall ix (f :: * -> *) a.
Applicative f =>
ByIndex ix (f a) -> f (ByIndex ix a)
forall ix (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ByIndex ix a -> m (ByIndex ix b)
forall ix (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ByIndex ix a -> f (ByIndex ix b)
forall (t :: * -> *).
(Functor t, Foldable t) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a.
Monad m =>
ByIndex ix (m a) -> m (ByIndex ix a)
forall (f :: * -> *) a.
Applicative f =>
ByIndex ix (f a) -> f (ByIndex ix a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ByIndex ix a -> m (ByIndex ix b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ByIndex ix a -> f (ByIndex ix b)
$ctraverse :: forall ix (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ByIndex ix a -> f (ByIndex ix b)
traverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> ByIndex ix a -> f (ByIndex ix b)
$csequenceA :: forall ix (f :: * -> *) a.
Applicative f =>
ByIndex ix (f a) -> f (ByIndex ix a)
sequenceA :: forall (f :: * -> *) a.
Applicative f =>
ByIndex ix (f a) -> f (ByIndex ix a)
$cmapM :: forall ix (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ByIndex ix a -> m (ByIndex ix b)
mapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> ByIndex ix a -> m (ByIndex ix b)
$csequence :: forall ix (m :: * -> *) a.
Monad m =>
ByIndex ix (m a) -> m (ByIndex ix a)
sequence :: forall (m :: * -> *) a.
Monad m =>
ByIndex ix (m a) -> m (ByIndex ix a)
Traversable,(forall x. ByIndex ix a -> Rep (ByIndex ix a) x)
-> (forall x. Rep (ByIndex ix a) x -> ByIndex ix a)
-> Generic (ByIndex ix a)
forall x. Rep (ByIndex ix a) x -> ByIndex ix a
forall x. ByIndex ix a -> Rep (ByIndex ix a) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall ix a x. Rep (ByIndex ix a) x -> ByIndex ix a
forall ix a x. ByIndex ix a -> Rep (ByIndex ix a) x
$cfrom :: forall ix a x. ByIndex ix a -> Rep (ByIndex ix a) x
from :: forall x. ByIndex ix a -> Rep (ByIndex ix a) x
$cto :: forall ix a x. Rep (ByIndex ix a) x -> ByIndex ix a
to :: forall x. Rep (ByIndex ix a) x -> ByIndex ix a
Generic,Int -> ByIndex ix a -> ShowS
[ByIndex ix a] -> ShowS
ByIndex ix a -> String
(Int -> ByIndex ix a -> ShowS)
-> (ByIndex ix a -> String)
-> ([ByIndex ix a] -> ShowS)
-> Show (ByIndex ix a)
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
forall ix a. (Show ix, Show a) => Int -> ByIndex ix a -> ShowS
forall ix a. (Show ix, Show a) => [ByIndex ix a] -> ShowS
forall ix a. (Show ix, Show a) => ByIndex ix a -> String
$cshowsPrec :: forall ix a. (Show ix, Show a) => Int -> ByIndex ix a -> ShowS
showsPrec :: Int -> ByIndex ix a -> ShowS
$cshow :: forall ix a. (Show ix, Show a) => ByIndex ix a -> String
show :: ByIndex ix a -> String
$cshowList :: forall ix a. (Show ix, Show a) => [ByIndex ix a] -> ShowS
showList :: [ByIndex ix a] -> ShowS
Show)

makeLenses ''ByIndex

instance (NFData i, NFData a) => NFData (ByIndex i a)

instance Eq ix => Eq (ByIndex ix a) where
  ByIndex ix a
x == :: ByIndex ix a -> ByIndex ix a -> Bool
== ByIndex ix a
y = ByIndex ix a -> ix
forall ix a. ByIndex ix a -> ix
_theIndex ByIndex ix a
x ix -> ix -> Bool
forall a. Eq a => a -> a -> Bool
== ByIndex ix a -> ix
forall ix a. ByIndex ix a -> ix
_theIndex ByIndex ix a
y

instance Ord ix => Ord (ByIndex ix a) where
  ByIndex ix a
x compare :: ByIndex ix a -> ByIndex ix a -> Ordering
`compare` ByIndex ix a
y = ByIndex ix a -> ix
forall ix a. ByIndex ix a -> ix
_theIndex ByIndex ix a
x ix -> ix -> Ordering
forall a. Ord a => a -> a -> Ordering
`compare` ByIndex ix a -> ix
forall ix a. ByIndex ix a -> ix
_theIndex ByIndex ix a
y

instance Foldable1 (ByIndex ix) where
  foldMap1 :: forall m a. Semigroup m => (a -> m) -> ByIndex ix a -> m
foldMap1 a -> m
f (ByIndex ix
_ a
x) = a -> m
f a
x

instance Traversable1 (ByIndex ix) where
  traverse1 :: forall (f :: * -> *) a b.
Apply f =>
(a -> f b) -> ByIndex ix a -> f (ByIndex ix b)
traverse1 a -> f b
f (ByIndex ix
i a
x) = ix -> b -> ByIndex ix b
forall ix a. ix -> a -> ByIndex ix a
ByIndex ix
i (b -> ByIndex ix b) -> f b -> f (ByIndex ix b)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> a -> f b
f a
x


-- | Label each element with its index.
labelWithIndex :: (Traversable t) => t a -> t (ByIndex Int a)
labelWithIndex :: forall (t :: * -> *) a. Traversable t => t a -> t (ByIndex Int a)
labelWithIndex = (Int -> a -> ByIndex Int a) -> t a -> t (ByIndex Int a)
forall (t :: * -> *) a b.
Traversable t =>
(Int -> a -> b) -> t a -> t b
labelWith Int -> a -> ByIndex Int a
forall ix a. ix -> a -> ByIndex ix a
ByIndex

-- | Label each element with its index using the given labelling
-- function.
labelWith   :: Traversable t => (Int -> a -> b) -> t a -> t b
labelWith :: forall (t :: * -> *) a b.
Traversable t =>
(Int -> a -> b) -> t a -> t b
labelWith Int -> a -> b
f = (t b, Int) -> t b
forall a b. (a, b) -> a
fst ((t b, Int) -> t b) -> (t a -> (t b, Int)) -> t a -> t b
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Int -> a -> b) -> t a -> (t b, Int)
forall (t :: * -> *) a b.
Traversable t =>
(Int -> a -> b) -> t a -> (t b, Int)
labelWith' Int -> a -> b
f

-- | Label each element with its index using the given labelling
-- function. Returns the new collection as well as its size.
labelWith'           :: forall t a b. Traversable t
                     => (Int -> a -> b) -> t a
                     -> (t b, Int)
labelWith' :: forall (t :: * -> *) a b.
Traversable t =>
(Int -> a -> b) -> t a -> (t b, Int)
labelWith' Int -> a -> b
withIndex' = (State Int (t b) -> Int -> (t b, Int))
-> Int -> State Int (t b) -> (t b, Int)
forall a b c. (a -> b -> c) -> b -> a -> c
flip State Int (t b) -> Int -> (t b, Int)
forall s a. State s a -> s -> (a, s)
runState Int
0 (State Int (t b) -> (t b, Int))
-> (t a -> State Int (t b)) -> t a -> (t b, Int)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (a -> StateT Int Identity b) -> t a -> State Int (t b)
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> t a -> f (t b)
traverse a -> StateT Int Identity b
lbl
  where
    lbl   :: a -> State Int b
    lbl :: a -> StateT Int Identity b
lbl a
x = do i <- StateT Int Identity Int
forall s (m :: * -> *). MonadState s m => m s
get
               put $ i+1
               pure (withIndex' i x)