CLaSH.Util

Assortment of utility function used in the CLaSH library

Documentation

class MonadUnique m where

A class that can generate unique numbers

Methods

getUniqueM :: m Int

Get a new unique

Instances

Monad m => MonadUnique (R m)

Monad m => MonadUnique (RewriteMonad m)

Monad m => MonadUnique (StateT Int m)

curLoc :: Q Exp

Create a TH expression that returns the a formatted string containing the name of the module curLoc is spliced into, and the line where it was spliced.

makeCached

Arguments

:: (MonadState s m, Hashable k, Eq k)

=> k

The key the action is associated with

-> Lens' s (HashMap k v)

The Lens to the HashMap that is the cache

-> m v

The action to cache

-> m v

Cache the result of a monadic action

makeCachedT3

Arguments

:: (MonadTrans t2, MonadTrans t1, MonadTrans t, Eq k, Hashable k, MonadState s m, Monad (t2 m), Monad (t1 (t2 m)), Monad (t (t1 (t2 m))))

=> k

The key the action is associated with

-> Lens' s (HashMap k v)

The Lens to the HashMap that is the cache

-> t (t1 (t2 m)) v

The action to cache

-> t (t1 (t2 m)) v

Cache the result of a monadic action in a State 3 transformer layers down

makeCachedT3S :: (MonadTrans t2, MonadTrans t1, MonadTrans t, Eq k, Hashable k, MonadState s m, Monad (t2 m), Monad (t1 (t2 m)), Monad (t (t1 (t2 m))), NFData v) => k -> Lens' s (HashMap k v) -> t (t1 (t2 m)) v -> t (t1 (t2 m)) v

Spine-strict cache variant of mkCachedT3

liftState

Arguments

:: MonadState s m

=> Lens' s s'

Lens to the State in the higher-layer monad

-> State s' a

The State-action to perform

-> m a

Run a State-action using the State that is stored in a higher-layer Monad

firstM :: Functor f => (a -> f c) -> (a, b) -> f (c, b)

Functorial version of first

secondM :: Functor f => (b -> f c) -> (a, b) -> f (a, c)

Functorial version of second

traceIf :: Bool -> String -> a -> a

Performs trace when first argument evaluates to True

partitionM :: Monad m => (a -> m Bool) -> [a] -> m ([a], [a])

Monadic version of partition

mapAccumLM :: Monad m => (acc -> x -> m (acc, y)) -> acc -> [x] -> m (acc, [y])

Monadic version of mapAccumL

dot :: (c -> d) -> (a -> b -> c) -> a -> b -> d

Composition of a unary function with a binary function

ifThenElse :: (a -> Bool) -> (a -> b) -> (a -> b) -> a -> b

if-then-else as a function on an argument

(<:>) :: Applicative f => f a -> f [a] -> f [a]

Applicative version of 'GHC.Types.(:)'

indexMaybe :: [a] -> Int -> Maybe a

Safe indexing, returns a Nothing if the index does not exist

indexNote :: String -> [a] -> Int -> a

Unsafe indexing, return a custom error message when indexing fails

splitAtList :: [b] -> [a] -> ([a], [a])

Split the second list at the length of the first list

makeLenses :: Name -> Q [Dec]

Build lenses (and traversals) with a sensible default configuration.

e.g.

 data FooBar
   = Foo { _x, _y :: Int }
   | Bar { _x :: Int }
 makeLenses ''FooBar
 

will create

 x :: Lens' FooBar Int
 x f (Foo a b) = (a' -> Foo a' b) <$> f a
 x f (Bar a)   = Bar <$> f a
 y :: Traversal' FooBar Int
 y f (Foo a b) = (b' -> Foo a  b') <$> f b
 y _ c@(Bar _) = pure c
 

 makeLenses = makeLensesWith lensRules