diff --git a/AUTHORS.md b/AUTHORS.md
new file mode 100644
--- /dev/null
+++ b/AUTHORS.md
@@ -0,0 +1,2 @@
+* [Christiaan Baaij](mailto:christiaan.baaij@gmail.com) [@christiaanb](https://github.com/christiaanb)
+* John Ericson [@Ericson2314](https://github.com/Ericson2314)
diff --git a/CHANGELOG.md b/CHANGELOG.md
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,9 @@
# Changelog for [`clash-prelude` package](http://hackage.haskell.org/package/clash-prelude)
+## 0.7.5 **May 7th 2015**
+* New features:
+ * Moore machine combinators
+
## 0.7.4 **May 5th 2015*
* New features:
* Add `TopEntity` annotations
diff --git a/clash-prelude.cabal b/clash-prelude.cabal
--- a/clash-prelude.cabal
+++ b/clash-prelude.cabal
@@ -1,5 +1,5 @@
Name: clash-prelude
-Version: 0.7.4
+Version: 0.7.5
Synopsis: CAES Language for Synchronous Hardware - Prelude library
Description:
CλaSH (pronounced ‘clash’) is a functional hardware description language that
@@ -34,6 +34,7 @@
Extra-source-files: README.md
CHANGELOG.md
+ AUTHORS.md
extra-doc-files: doc/*.svg
@@ -68,6 +69,7 @@
CLaSH.Prelude.DataFlow
CLaSH.Prelude.Explicit
CLaSH.Prelude.Mealy
+ CLaSH.Prelude.Moore
CLaSH.Prelude.Testbench
CLaSH.Promoted.Nat
@@ -120,7 +122,7 @@
data-default >= 0.5.3,
integer-gmp >= 0.5.1.0,
ghc-prim >= 0.3.1.0,
- ghc-typelits-natnormalise >= 0.2,
+ ghc-typelits-natnormalise >= 0.2.1,
singletons >= 1.0,
template-haskell >= 2.9.0.0,
th-lift >= 0.5.6
diff --git a/doc/foldl.svg b/doc/foldl.svg
new file mode 100644
--- /dev/null
+++ b/doc/foldl.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/foldl1.svg b/doc/foldl1.svg
new file mode 100644
--- /dev/null
+++ b/doc/foldl1.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/foldr.svg b/doc/foldr.svg
new file mode 100644
--- /dev/null
+++ b/doc/foldr.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/foldr1.svg b/doc/foldr1.svg
new file mode 100644
--- /dev/null
+++ b/doc/foldr1.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/generate.svg b/doc/generate.svg
new file mode 100644
--- /dev/null
+++ b/doc/generate.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/iterate.svg b/doc/iterate.svg
new file mode 100644
--- /dev/null
+++ b/doc/iterate.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/map.svg b/doc/map.svg
new file mode 100644
--- /dev/null
+++ b/doc/map.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/mapAccumL.svg b/doc/mapAccumL.svg
new file mode 100644
--- /dev/null
+++ b/doc/mapAccumL.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/mapAccumR.svg b/doc/mapAccumR.svg
new file mode 100644
--- /dev/null
+++ b/doc/mapAccumR.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/scanl.svg b/doc/scanl.svg
new file mode 100644
--- /dev/null
+++ b/doc/scanl.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/scanr.svg b/doc/scanr.svg
new file mode 100644
--- /dev/null
+++ b/doc/scanr.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/sscanl.svg b/doc/sscanl.svg
new file mode 100644
--- /dev/null
+++ b/doc/sscanl.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/sscanr.svg b/doc/sscanr.svg
new file mode 100644
--- /dev/null
+++ b/doc/sscanr.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/zipWith.svg b/doc/zipWith.svg
new file mode 100644
--- /dev/null
+++ b/doc/zipWith.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/doc/zipWith3.svg b/doc/zipWith3.svg
new file mode 100644
--- /dev/null
+++ b/doc/zipWith3.svg
@@ -0,0 +1,3 @@
+
+
+
diff --git a/src/CLaSH/Annotations/TopEntity.hs b/src/CLaSH/Annotations/TopEntity.hs
--- a/src/CLaSH/Annotations/TopEntity.hs
+++ b/src/CLaSH/Annotations/TopEntity.hs
@@ -12,7 +12,7 @@
We can exert some control how the top level function is created by the CλaSH
compiler by annotating the @topEntity@ function with a 'TopEntity' annotation.
-You apply these annotation using the @ANN@ pragma like so:
+You apply these annotations using the @ANN@ pragma like so:
@
{\-\# ANN topEntity (TopEntity {t_name = ..., ... }) \#-\}
diff --git a/src/CLaSH/Class/BitPack.hs b/src/CLaSH/Class/BitPack.hs
--- a/src/CLaSH/Class/BitPack.hs
+++ b/src/CLaSH/Class/BitPack.hs
@@ -75,7 +75,7 @@
pack v = v
unpack v = v
-instance (KnownNat (BitSize a), KnownNat (BitSize b), BitPack a, BitPack b) =>
+instance (KnownNat (BitSize b), BitPack a, BitPack b) =>
BitPack (a,b) where
type BitSize (a,b) = BitSize a + BitSize b
pack (a,b) = pack a ++# pack b
diff --git a/src/CLaSH/Prelude.hs b/src/CLaSH/Prelude.hs
--- a/src/CLaSH/Prelude.hs
+++ b/src/CLaSH/Prelude.hs
@@ -34,6 +34,8 @@
mealy
, mealyB
, (<^>)
+ , moore
+ , mooreB
, registerB
-- * BlockRAM primitives
, blockRam
@@ -114,6 +116,7 @@
import CLaSH.Prelude.Explicit (registerB', window', windowD', isRising',
isFalling')
import CLaSH.Prelude.Mealy (mealy, mealyB, (<^>))
+import CLaSH.Prelude.Moore (moore, mooreB)
import CLaSH.Prelude.DataFlow
import CLaSH.Prelude.Testbench (assert, stimuliGenerator, outputVerifier)
import CLaSH.Promoted.Nat
diff --git a/src/CLaSH/Prelude/BlockRam.hs b/src/CLaSH/Prelude/BlockRam.hs
--- a/src/CLaSH/Prelude/BlockRam.hs
+++ b/src/CLaSH/Prelude/BlockRam.hs
@@ -12,7 +12,7 @@
import GHC.TypeLits (KnownNat, type (^))
import Prelude hiding ((!!))
-import CLaSH.Prelude.Mealy (mealy')
+import CLaSH.Prelude.Moore (moore')
import CLaSH.Signal (Signal)
import CLaSH.Signal.Explicit (Signal', SClock, systemClock)
import CLaSH.Signal.Bundle (bundle')
@@ -99,9 +99,9 @@
-- ^ Value of the @blockRAM@ at address @r@ from the previous clock
-- cycle
blockRam' clk binit wr rd en din =
- mealy' clk bram' (binit,undefined) (bundle' clk (wr,rd,en,din))
+ moore' clk bram' snd (binit,undefined) (bundle' clk (wr,rd,en,din))
where
- bram' (ram,o) (w,r,e,d) = ((ram',o'),o)
+ bram' (ram,_) (w,r,e,d) = (ram',o')
where
ram' | e = replace ram w d
| otherwise = ram
diff --git a/src/CLaSH/Prelude/DataFlow.hs b/src/CLaSH/Prelude/DataFlow.hs
--- a/src/CLaSH/Prelude/DataFlow.hs
+++ b/src/CLaSH/Prelude/DataFlow.hs
@@ -20,6 +20,7 @@
-- * Creating DataFlow circuits
, liftDF
, mealyDF
+ , mooreDF
-- * Composition combinators
, idDF
, seqDF
@@ -129,6 +130,19 @@
s = regEn iS en s'
in (o,iV,oR))
+-- | Create a 'DataFlow' circuit from a Moore machine description as those of
+-- "CLaSH.Prelude.Moore"
+mooreDF :: (s -> i -> s)
+ -> (s -> o)
+ -> s
+ -> DataFlow Bool Bool i o
+mooreDF ft fo iS = DF (\i iV oR -> let en = iV .&&. oR
+ s' = ft <$> s <*> i
+ s = regEn iS en s'
+ o = fo <$> s
+ in (o,iV,oR))
+
+
-- | Identity circuit
--
-- <>
@@ -166,8 +180,7 @@
-- | Swap the two communication channels.
--
-- <>
-swapDF :: (KnownSymbol nm, KnownNat rate)
- => DataFlow' ('Clk nm rate) (aEn,bEn) (bEn,aEn) (a,b) (b,a)
+swapDF :: DataFlow' ('Clk nm rate) (aEn,bEn) (bEn,aEn) (a,b) (b,a)
swapDF = DF (\ab abV baR -> (swap <$> ab, swap <$> abV, swap <$> baR))
where
swap ~(a,b) = (b,a)
diff --git a/src/CLaSH/Prelude/Explicit.hs b/src/CLaSH/Prelude/Explicit.hs
--- a/src/CLaSH/Prelude/Explicit.hs
+++ b/src/CLaSH/Prelude/Explicit.hs
@@ -21,6 +21,8 @@
( -- * Creating synchronous sequential circuits
mealy'
, mealyB'
+ , moore'
+ , mooreB'
, registerB'
-- * BlockRAM primitives
, blockRam'
@@ -46,6 +48,7 @@
import CLaSH.Prelude.BlockRam (blockRam', blockRamPow2')
import CLaSH.Prelude.Mealy (mealy', mealyB')
+import CLaSH.Prelude.Moore (moore', mooreB')
import CLaSH.Prelude.Testbench (stimuliGenerator', outputVerifier')
import CLaSH.Signal.Explicit
import CLaSH.Sized.Vector (Vec (..), (+>>), asNatProxy, repeat)
diff --git a/src/CLaSH/Prelude/Mealy.hs b/src/CLaSH/Prelude/Mealy.hs
--- a/src/CLaSH/Prelude/Mealy.hs
+++ b/src/CLaSH/Prelude/Mealy.hs
@@ -1,7 +1,13 @@
{-|
-Copyright : (C) 2013-2015, University of Twente
-License : BSD2 (see the file LICENSE)
-Maintainer : Christiaan Baaij
+ Copyright : (C) 2013-2015, University of Twente
+ License : BSD2 (see the file LICENSE)
+ Maintainer : Christiaan Baaij
+
+ Whereas the output of a Moore machine depends on the /previous state/, the
+ outputof a Mealy machine depends on /current transition/.
+
+ Mealy machines are strictly more expressive, but may impose stricter timing
+ requirements.
-}
module CLaSH.Prelude.Mealy
( -- * Mealy machine synchronised to the system clock
diff --git a/src/CLaSH/Prelude/Moore.hs b/src/CLaSH/Prelude/Moore.hs
new file mode 100644
--- /dev/null
+++ b/src/CLaSH/Prelude/Moore.hs
@@ -0,0 +1,204 @@
+{-|
+ Copyright : (C) 2013-2015, University of Twente
+ License : BSD2 (see the file LICENSE)
+ Maintainer : Christiaan Baaij
+
+ Whereas the output of a Mealy machine depends on /current transition/, the
+ output of a Moore machine depends on the /previous state/.
+
+ Moore machines are strictly less expressive, but may impose laxer timing
+ requirements.
+-}
+module CLaSH.Prelude.Moore
+ ( -- * Moore machine synchronised to the system clock
+ moore
+ , mooreB
+ -- * Moore machine synchronised to an arbitrary clock
+ , moore'
+ , mooreB'
+ )
+where
+
+import CLaSH.Signal (Signal, Unbundled)
+import CLaSH.Signal.Explicit (Signal', SClock, register', systemClock)
+import CLaSH.Signal.Bundle (Bundle (..), Unbundled')
+
+-- $setup
+-- >>> :set -XDataKinds
+-- >>> import CLaSH.Prelude
+-- >>> :{
+-- let mac s (x,y) = x * y + s
+-- topEntity = moore mac id 0
+-- :}
+--
+-- >>> import CLaSH.Prelude.Explicit
+-- >>> type ClkA = Clk "A" 100
+-- >>> let clkA = sclock :: SClock ClkA
+-- >>> let mac s (x,y) = x * y + s
+--
+-- >>> let topEntity = moore' clkA mac id 0
+
+{-# INLINE moore #-}
+-- | Create a synchronous function from a combinational function describing
+-- a moore machine
+--
+-- @
+-- mac :: Int -- Current state
+-- -> (Int,Int) -- Input
+-- -> Int -- Updated state
+-- mac s (x,y) = x * y + s
+--
+-- topEntity :: 'Signal' (Int, Int) -> 'Signal' Int
+-- topEntity = 'moore' mac id 0
+-- @
+--
+-- >>> simulate topEntity [(1,1),(2,2),(3,3),(4,4)]
+-- [0,1,5,14...
+--
+-- Synchronous sequential functions can be composed just like their
+-- combinational counterpart:
+--
+-- @
+-- dualMac :: ('Signal' Int, 'Signal' Int)
+-- -> ('Signal' Int, 'Signal' Int)
+-- -> 'Signal' Int
+-- dualMac (a,b) (x,y) = s1 + s2
+-- where
+-- s1 = 'moore' mac id 0 ('CLaSH.Signal.bundle' (a,x))
+-- s2 = 'moore' mac id 0 ('CLaSH.Signal.bundle' (b,y))
+-- @
+moore :: (s -> i -> s) -- ^ Transfer function in moore machine form:
+ -- @state -> input -> newstate@
+ -> (s -> o) -- ^ Output function in moore machine form:
+ -- @state -> output@
+ -> s -- ^ Initial state
+ -> (Signal i -> Signal o)
+ -- ^ Synchronous sequential function with input and output matching that
+ -- of the moore machine
+moore = moore' systemClock
+
+{-# INLINE mooreB #-}
+-- | A version of 'moore' that does automatic 'Bundle'ing
+--
+-- Given a functions @t@ and @o@ of types:
+--
+-- @
+-- __t__ :: Int -> (Bool, Int) -> Int
+-- __o__ :: Int -> (Int, Bool)
+-- @
+--
+-- When we want to make compositions of @t@ and @o@ in @g@ using 'moore', we have to
+-- write:
+--
+-- @
+-- g a b c = (b1,b2,i2)
+-- where
+-- (i1,b1) = 'CLaSH.Signal.unbundle' ('moore' t o 0 ('CLaSH.Signal.bundle' (a,b)))
+-- (i2,b2) = 'CLaSH.Signal.unbundle' ('moore' t o 3 ('CLaSH.Signal.bundle' (i1,c)))
+-- @
+--
+-- Using 'mooreB' however we can write:
+--
+-- @
+-- g a b c = (b1,b2,i2)
+-- where
+-- (i1,b1) = 'mooreB' t o 0 (a,b)
+-- (i2,b2) = 'mooreB' t o 3 (i1,c)
+-- @
+mooreB :: (Bundle i, Bundle o)
+ => (s -> i -> s) -- ^ Transfer function in moore machine form:
+ -- @state -> input -> newstate@
+ -> (s -> o) -- ^ Output function in moore machine form:
+ -- @state -> output@
+ -> s -- ^ Initial state
+ -> (Unbundled i -> Unbundled o)
+ -- ^ Synchronous sequential function with input and output matching that
+ -- of the moore machine
+mooreB = mooreB' systemClock
+
+{-# INLINABLE moore' #-}
+-- | Create a synchronous function from a combinational function describing
+-- a moore machine
+--
+-- @
+-- mac :: Int -- Current state
+-- -> (Int,Int) -- Input
+-- -> (Int,Int) -- Updated state
+-- mac s (x,y) = x * y + s
+--
+-- type ClkA = 'CLaSH.Signal.Explicit.Clk' \"A\" 100
+--
+-- clkA :: 'SClock' ClkA
+-- clkA = 'CLaSH.Signal.Explicit.sclock'
+--
+-- topEntity :: 'Signal'' ClkA (Int, Int) -> 'Signal'' ClkA Int
+-- topEntity = 'moore'' clkA mac id 0
+-- @
+--
+-- >>> simulate topEntity [(1,1),(2,2),(3,3),(4,4)]
+-- [0,1,5,14...
+--
+-- Synchronous sequential functions can be composed just like their
+-- combinational counterpart:
+--
+-- @
+-- dualMac :: ('Signal'' clkA Int, 'Signal'' clkA Int)
+-- -> ('Signal'' clkA Int, 'Signal'' clkA Int)
+-- -> 'Signal'' clkA Int
+-- dualMac (a,b) (x,y) = s1 + s2
+-- where
+-- s1 = 'moore'' clkA mac id 0 ('CLaSH.Signal.Explicit.bundle'' clkA (a,x))
+-- s2 = 'moore'' clkA mac id 0 ('CLaSH.Signal.Explicit.bundle'' clkA (b,y))
+-- @
+moore' :: SClock clk -- ^ 'Clock' to synchronize to
+ -> (s -> i -> s) -- ^ Transfer function in moore machine form:
+ -- @state -> input -> newstate@
+ -> (s -> o) -- ^ Output function in moore machine form:
+ -- @state -> output@
+ -> s -- ^ Initial state
+ -> (Signal' clk i -> Signal' clk o)
+ -- ^ Synchronous sequential function with input and output matching that
+ -- of the moore machine
+moore' clk ft fo iS = \i -> let s' = ft <$> s <*> i
+ s = register' clk iS s'
+ in fo <$> s
+
+{-# INLINE mooreB' #-}
+-- | A version of 'moore'' that does automatic 'Bundle'ing
+--
+-- Given a functions @t@ and @o@ of types:
+--
+-- @
+-- __t__ :: Int -> (Bool, Int) -> Int
+-- __o__ :: Int -> (Int, Bool)
+-- @
+--
+-- When we want to make compositions of @t@ and @o@ in @g@ using 'moore'', we have to
+-- write:
+--
+-- @
+-- g clk a b c = (b1,b2,i2)
+-- where
+-- (i1,b1) = 'CLaSH.Signal.Explicit.unbundle'' clk (moore' clk t o 0 ('CLaSH.Signal.Explicit.bundle'' clk (a,b)))
+-- (i2,b2) = 'CLaSH.Signal.Explicit.unbundle'' clk (moore' clk t o 3 ('CLaSH.Signal.Explicit.bundle'' clk (i1,c)))
+-- @
+--
+-- Using 'mooreB'' however we can write:
+--
+-- @
+-- g clk a b c = (b1,b2,i2)
+-- where
+-- (i1,b1) = 'mooreB'' clk t o 0 (a,b)
+-- (i2,b2) = 'mooreB'' clk to 3 (i1,c)
+-- @
+mooreB' :: (Bundle i, Bundle o)
+ => SClock clk
+ -> (s -> i -> s) -- ^ Transfer function in moore machine form:
+ -- @state -> input -> newstate@
+ -> (s -> o) -- ^ Output function in moore machine form:
+ -- @state -> output@
+ -> s -- ^ Initial state
+ -> (Unbundled' clk i -> Unbundled' clk o)
+ -- ^ Synchronous sequential function with input and output matching that
+ -- of the moore machine
+mooreB' clk ft fo iS i = unbundle' clk (moore' clk ft fo iS (bundle' clk i))
diff --git a/src/CLaSH/Sized/Fixed.hs b/src/CLaSH/Sized/Fixed.hs
--- a/src/CLaSH/Sized/Fixed.hs
+++ b/src/CLaSH/Sized/Fixed.hs
@@ -128,7 +128,7 @@
-- 3.9375
-- >>> minBound :: SFixed 3 4
-- -4.0
--- >>> 1 + 2 :: SFixed 3 4
+-- >>> 1 + 2 :: SFixed 3 4
-- 3.0
-- >>> 2 + 3 :: SFixed 3 4
-- 3.9375
@@ -221,8 +221,7 @@
fracShift :: KnownNat frac => Fixed rep int frac -> Int
fracShift fx = fromInteger (natVal fx)
-instance ( size ~ (int + frac), Show (rep size), Bits (rep size), KnownNat frac
- , Integral (rep size)
+instance ( size ~ (int + frac), KnownNat frac, Integral (rep size)
) => Show (Fixed rep int frac) where
show f@(Fixed fRep) =
i ++ "." ++ (uncurry pad . second (show . numerator) .
@@ -571,7 +570,7 @@
-- >>> $$(fLit (atan 0.2)) :: SFixed 1 20
-- 0.19739532470703125
fLit :: forall rep int frac size .
- ( size ~ (int + frac), KnownNat frac, Num (rep size), Bounded (rep size)
+ ( size ~ (int + frac), KnownNat frac, Bounded (rep size)
, Integral (rep size))
=> Double
-> Q (TExp (Fixed rep int frac))
diff --git a/src/CLaSH/Sized/Internal/Index.hs b/src/CLaSH/Sized/Internal/Index.hs
--- a/src/CLaSH/Sized/Internal/Index.hs
+++ b/src/CLaSH/Sized/Internal/Index.hs
@@ -51,6 +51,21 @@
-- | Arbitrary-bounded unsigned integer represented by @ceil(log_2(n))@ bits.
--
-- Given an upper bound @n@, an 'Index' @n@ number has a range of: [0 .. @n@-1]
+--
+-- >>> maxBound :: Index 8
+-- 7
+-- >>> minBound :: Index 8
+-- 0
+-- >>> 1 + 2 :: Index 8
+-- 3
+-- >>> 2 + 6 :: Index 8
+-- *** Exception: 8 is out of bounds: [0..7]
+-- >>> 1 - 3 :: Index 8
+-- *** Exception: -2 is out of bounds: [0..7]
+-- >>> 2 * 3 :: Index 8
+-- 6
+-- >>> 2 * 4 :: Index 8
+-- *** Exception: 8 is out of bounds: [0..7]
newtype Index (n :: Nat) =
-- | The constructor, 'I', and the field, 'unsafeToInteger', are not
-- synthesisable.
@@ -160,7 +175,7 @@
divMod n d = (n `quot#` d,n `mod#` d)
toInteger = toInteger#
-quot#,rem#,mod# :: KnownNat n => Index n -> Index n -> Index n
+quot#,rem#,mod# :: Index n -> Index n -> Index n
{-# NOINLINE quot# #-}
(I a) `quot#` (I b) = I (a `div` b)
{-# NOINLINE rem# #-}
diff --git a/src/CLaSH/Sized/Internal/Signed.hs b/src/CLaSH/Sized/Internal/Signed.hs
--- a/src/CLaSH/Sized/Internal/Signed.hs
+++ b/src/CLaSH/Sized/Internal/Signed.hs
@@ -100,6 +100,31 @@
--
-- __NB__: The 'Num' operators perform @wrap-around@ on overflow. If you want
-- saturation on overflow, check out the 'SaturatingNum' class.
+--
+-- >>> maxBound :: Signed 3
+-- 3
+-- >>> minBound :: Signed 3
+-- -4
+-- >>> 1 + 2 :: Signed 3
+-- 3
+-- >>> 2 + 3 :: Signed 3
+-- -3
+-- >>> (-2) + (-3) :: Signed 3
+-- 3
+-- >>> 2 * 3 :: Signed 4
+-- 6
+-- >>> 2 * 4 :: Signed 4
+-- -8
+-- >>> (2 :: Signed 3) `times` (4 :: Signed 4) :: Signed 7
+-- 8
+-- >>> (2 :: Signed 3) `plus` (3 :: Signed 3) :: Signed 4
+-- 5
+-- >>> (-2 :: Signed 3) `plus` (-3 :: Signed 3) :: Signed 4
+-- -5
+-- >>> satPlus SatSymmetric 2 3 :: Signed 3
+-- 3
+-- >>> satPlus SatSymmetric (-2) (-3) :: Signed 3
+-- -3
newtype Signed (n :: Nat) =
-- | The constructor, 'S', and the field, 'unsafeToInteger', are not
-- synthesisable.
@@ -267,11 +292,13 @@
divMod n d = (n `div#` d,n `mod#` d)
toInteger = toInteger#
-quot#,rem#,div#,mod# :: KnownNat n => Signed n -> Signed n -> Signed n
+quot#,rem# :: Signed n -> Signed n -> Signed n
{-# NOINLINE quot# #-}
quot# (S a) (S b) = S (a `quot` b)
{-# NOINLINE rem# #-}
rem# (S a) (S b) = S (a `rem` b)
+
+div#,mod# :: KnownNat n => Signed n -> Signed n -> Signed n
{-# NOINLINE div# #-}
div# (S a) (S b) = S (a `div` b)
{-# NOINLINE mod# #-}
diff --git a/src/CLaSH/Sized/Internal/Unsigned.hs b/src/CLaSH/Sized/Internal/Unsigned.hs
--- a/src/CLaSH/Sized/Internal/Unsigned.hs
+++ b/src/CLaSH/Sized/Internal/Unsigned.hs
@@ -92,6 +92,29 @@
--
-- __NB__: The 'Num' operators perform @wrap-around@ on overflow. If you want
-- saturation on overflow, check out the 'SaturatingNum' class.
+--
+-- >>> maxBound :: Unsigned 3
+-- 7
+-- >>> minBound :: Unsigned 3
+-- 0
+-- >>> 1 + 2 :: Unsigned 3
+-- 3
+-- >>> 2 + 6 :: Unsigned 3
+-- 0
+-- >>> 1 - 3 :: Unsigned 3
+-- 6
+-- >>> 2 * 3 :: Unsigned 3
+-- 6
+-- >>> 2 * 4 :: Unsigned 3
+-- 0
+-- >>> (2 :: Unsigned 3) `times` (4 :: Unsigned 3) :: Unsigned 6
+-- 8
+-- >>> (2 :: Unsigned 3) `plus` (6 :: Unsigned 3) :: Unsigned 4
+-- 8
+-- >>> satPlus SatSymmetric 2 6 :: Unsigned 3
+-- 7
+-- >>> satMin SatSymmetric 2 3 :: Unsigned 3
+-- 0
newtype Unsigned (n :: Nat) =
-- | The constructor, 'U', and the field, 'unsafeToBitVector', are not
-- synthesisable.
diff --git a/src/CLaSH/Sized/Vector.hs b/src/CLaSH/Sized/Vector.hs
--- a/src/CLaSH/Sized/Vector.hs
+++ b/src/CLaSH/Sized/Vector.hs
@@ -123,10 +123,11 @@
-- * 'Vec'tor elements have an __ASCENDING__ subscript starting from 0 and
-- ending at 'maxIndex' (== 'length' - 1).
--
--- >>> (3:>4:>5:>Nil)
+-- >>> 3:>4:>5:>Nil
-- <3,4,5>
--- >>> :t (3:>4:>5:>Nil)
--- (3:>4:>5:>Nil) :: Num a => Vec (2 + 1) a
+-- >>> let x = 3:>4:>5:>Nil
+-- >>> :t x
+-- x :: Num a => Vec 3 a
data Vec :: Nat -> * -> * where
Nil :: Vec 0 a
(:>) :: a -> Vec n a -> Vec (n + 1) a
@@ -136,7 +137,7 @@
instance Show a => Show (Vec n a) where
show vs = "<" P.++ punc vs P.++ ">"
where
- punc :: Show a => Vec m a -> String
+ punc :: Vec m a -> String
punc Nil = ""
punc (x :> Nil) = show x
punc (x :> xs) = show x P.++ "," P.++ punc xs
@@ -197,8 +198,8 @@
-- >>> head Nil
--
-- :...
--- Couldn't match type ‘1’ with ‘0’
--- Expected type: Vec (0 + 1) a
+-- Couldn't match type ‘...’ with ‘0’
+-- Expected type: Vec ... a
-- Actual type: Vec 0 a
-- In the first argument of ‘head’, namely ‘Nil’
-- In the expression: head Nil
@@ -213,8 +214,8 @@
-- >>> tail Nil
--
-- :...
--- Couldn't match type ‘1’ with ‘0’
--- Expected type: Vec (0 + 1) a
+-- Couldn't match type ‘...’ with ‘0’
+-- Expected type: Vec ... a
-- Actual type: Vec 0 a
-- In the first argument of ‘tail’, namely ‘Nil’
-- In the expression: tail Nil
@@ -229,8 +230,8 @@
-- >>> last Nil
--
-- :...
--- Couldn't match type ‘1’ with ‘0’
--- Expected type: Vec (0 + 1) a
+-- Couldn't match type ‘...’ with ‘0’
+-- Expected type: Vec ... a
-- Actual type: Vec 0 a
-- In the first argument of ‘last’, namely ‘Nil’
-- In the expression: last Nil
@@ -246,8 +247,8 @@
-- >>> init Nil
--
-- :...
--- Couldn't match type ‘1’ with ‘0’
--- Expected type: Vec (0 + 1) a
+-- Couldn't match type ‘...’ with ‘0’
+-- Expected type: Vec ... a
-- Actual type: Vec 0 a
-- In the first argument of ‘init’, namely ‘Nil’
-- In the expression: init Nil
@@ -300,8 +301,9 @@
--
-- >>> (3:>4:>5:>Nil) <: 1
-- <3,4,5,1>
--- >>> :t (3:>4:>5:>Nil) <: 1
--- (3:>4:>5:>Nil) <: 1 :: Num a => Vec (3 + 1) a
+-- >>> let x = (3:>4:>5:>Nil) <: 1
+-- >>> :t x
+-- x :: Num a => Vec 4 a
(<:) :: Vec n a -> a -> Vec (n + 1) a
xs <: x = xs ++ singleton x
@@ -326,7 +328,7 @@
-- <4,5,1>
-- >>> Nil <<+ 1
-- <>
-(<<+) :: KnownNat n => Vec n a -> a -> Vec n a
+(<<+) :: Vec n a -> a -> Vec n a
xs <<+ s = fst (shiftInAtN xs (singleton s))
{-# INLINE shiftOutFrom0 #-}
@@ -450,6 +452,10 @@
-- of @xs@, i.e.,
--
-- > map f (x1 :> x2 :> ... :> xn :> Nil) == (f x1 :> f x2 :> ... :> f xn :> Nil)
+--
+-- and corresponds to the following circuit layout:
+--
+-- <>
map :: (a -> b) -> Vec n a -> Vec n b
map _ Nil = Nil
map f (x :> xs) = f x :> map f xs
@@ -462,6 +468,10 @@
--
-- > zipWith f (x1 :> x2 :> ... xn :> Nil) (y1 :> y2 :> ... :> yn :> Nil) == (f x1 y1 :> f x2 y2 :> ... :> f xn yn :> Nil)
--
+-- @zipWith f xs ys@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB:__ 'zipWith' is /strict/ in its second argument, and /lazy/ in its
-- third. This matters when 'zipWith' is used in a recursive setting. See
-- 'lazyV' for more information.
@@ -475,6 +485,10 @@
--
-- > zipWith3 f (x1 :> x2 :> ... xn :> Nil) (y1 :> y2 :> ... :> yn :> Nil) (z1 :> z2 :> ... :> zn :> Nil) == (f x1 y1 z1 :> f x2 y2 z2 :> ... :> f xn yn zn :> Nil)
--
+-- @zipWith3 f xs ys zs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB:__ 'zipWith3' is /strict/ in its second argument, and /lazy/ in its
-- third and fourth. This matters when 'zipWith3' is used in a recursive setting.
-- See 'lazyV' for more information.
@@ -492,6 +506,10 @@
-- >>> foldr (/) 1 (5 :> 4 :> 3 :> 2 :> Nil)
-- 1.875
--
+-- @foldr f z xs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB__: @"'foldr' f z xs"@ produces a linear structure, which has a depth, or
-- delay, of O(@'length' xs@). Use 'fold' if your binary operator @f@ is
-- associative, as @"'fold' f xs"@ produces a structure with a depth of
@@ -510,6 +528,10 @@
-- >>> foldl (/) 1 (5 :> 4 :> 3 :> 2 :> Nil)
-- 8.333333333333333e-3
--
+-- @foldl f z xs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB__: @"'foldl' f z xs"@ produces a linear structure, which has a depth, or
-- delay, of O(@'length' xs@). Use 'fold' if your binary operator @f@ is
-- associative, as @"'fold' f xs"@ produces a structure with a depth of
@@ -528,6 +550,10 @@
-- >>> foldr1 (/) (5 :> 4 :> 3 :> 2 :> 1 :> Nil)
-- 1.875
--
+-- @foldr1 f xs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB__: @"'foldr1' f z xs"@ produces a linear structure, which has a depth,
-- or delay, of O(@'length' xs@). Use 'fold' if your binary operator @f@ is
-- associative, as @"'fold' f xs"@ produces a structure with a depth of
@@ -546,6 +572,10 @@
-- >>> foldl1 (/) (1 :> 5 :> 4 :> 3 :> 2 :> Nil)
-- 8.333333333333333e-3
--
+-- @foldl1 f xs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB__: @"'foldl1' f z xs"@ produces a linear structure, which has a depth,
-- or delay, of O(@'length' xs@). Use 'fold' if your binary operator @f@ is
-- associative, as @"'fold' f xs"@ produces a structure with a depth of
@@ -586,6 +616,10 @@
-- >>> scanl (+) 0 (5 :> 4 :> 3 :> 2 :> Nil)
-- <0,5,9,12,14>
--
+-- @scanl f z xs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB__:
--
-- > last (scanl f z xs) == foldl f z xs
@@ -601,6 +635,10 @@
--
-- >>> sscanl (+) 0 (5 :> 4 :> 3 :> 2 :> Nil)
-- <5,9,12,14>
+--
+-- @sscanl f z xs@ corresponds to the following circuit layout:
+--
+-- <>
sscanl :: (b -> a -> b) -> b -> Vec n a -> Vec n b
sscanl f z xs = tail (scanl f z xs)
@@ -613,6 +651,10 @@
-- >>> scanr (+) 0 (5 :> 4 :> 3 :> 2 :> Nil)
-- <14,9,5,2,0>
--
+-- @scanr f z xs@ corresponds to the following circuit layout:
+--
+-- <>
+--
-- __NB__:
--
-- > head (scanr f z xs) == foldr f z xs
@@ -628,6 +670,10 @@
--
-- >>> sscanr (+) 0 (5 :> 4 :> 3 :> 2 :> Nil)
-- <14,9,5,2>
+--
+-- @sscanr f z xs@ corresponds to the following circuit layout:
+--
+-- <>
sscanr :: (a -> b -> b) -> b -> Vec n a -> Vec n b
sscanr f z xs = init (scanr f z xs)
@@ -639,6 +685,10 @@
--
-- >>> mapAccumL (\acc x -> (acc + x,acc + 1)) 0 (1 :> 2 :> 3 :> 4 :> Nil)
-- (10,<1,2,4,7>)
+--
+-- @mapAccumL f acc xs@ corresponds to the following circuit layout:
+--
+-- <>
mapAccumL :: (acc -> x -> (acc,y)) -> acc -> Vec n x -> (acc,Vec n y)
mapAccumL f acc xs = (acc',ys)
where
@@ -656,6 +706,10 @@
--
-- >>> mapAccumR (\acc x -> (acc + x,acc + 1)) 0 (1 :> 2 :> 3 :> 4 :> Nil)
-- (10,<10,8,5,1>)
+--
+-- @mapAccumR f acc xs@ corresponds to the following circuit layout:
+--
+-- <>
mapAccumR :: (acc -> x -> (acc,y)) -> acc -> Vec n x -> (acc, Vec n y)
mapAccumR f acc xs = (acc',ys)
where
@@ -917,6 +971,10 @@
--
-- >>> iterate d4 (+1) 1
-- <1,2,3,4>
+--
+-- @interate n f z@ corresponds to the following circuit layout:
+--
+-- <>
iterate :: SNat n -> (a -> a) -> a -> Vec n a
iterate (SNat _) = iterateI
@@ -928,6 +986,10 @@
--
-- >>> iterateI (+1) 1 :: Vec 3 Int
-- <1,2,3>
+--
+-- @interateI f z@ corresponds to the following circuit layout:
+--
+-- <>
iterateI :: KnownNat n => (a -> a) -> a -> Vec n a
iterateI f a = xs
where
@@ -943,6 +1005,10 @@
--
-- >>> generate d4 (+1) 1
-- <2,3,4,5>
+--
+-- @generate n f z@ corresponds to the following circuit layout:
+--
+-- <>
generate :: SNat n -> (a -> a) -> a -> Vec n a
generate (SNat _) f a = iterateI f (f a)
@@ -954,6 +1020,10 @@
--
-- >>> generateI (+1) 1 :: Vec 3 Int
-- <2,3,4>
+--
+-- @generateI f z@ corresponds to the following circuit layout:
+--
+-- <>
generateI :: KnownNat n => (a -> a) -> a -> Vec n a
generateI f a = iterateI f (f a)