Added batch suite of functions.

- Additional tests
- Added doctests
- Added docs + examples
- Added .ghci
- Updated .gitignore
- More bash functions in shell.nix

Author: dmjio

.ghci

@@ -0,0 +1,4 @@
+:set prompt "\x03BB> "
+:seti -XTypeApplications
+:load ArrayFire
+:set -laf

.gitignore

@@ -4,3 +4,5 @@ result/
 /result
 *~
 /ctags
+cabal.project.local
+tags

README.md

@@ -1,7 +1,7 @@
 ## <a href="http://arrayfire.com/"><img src="http://arrayfire.com/logos/arrayfire_logo_whitebkgnd.png" width="300"></a>
 `ArrayFire` is a general-purpose library that simplifies the process of developing software that targets parallel and massively-parallel architectures including CPUs, GPUs, and other hardware acceleration devices.
 
-`arrayfire-haskell` is a [Haskell](https://haskell.org) binding for [ArrayFire](https://arrayfire.com).
+`arrayfire-haskell` is a [Haskell](https://haskell.org) binding to [ArrayFire](https://arrayfire.com).
 
 ## Table of Contents
  - [Installation](#Installation)
@@ -25,31 +25,59 @@ To hack on this library locally, complete the installation step above. We recomm
 
 After the above tools are installed, clone the source from Github.
 
-``bash
+```bash
 git clone [email protected]:arrayfire/arrayfire-haskell.git
 cd arrayfire-haskell
 ```
 
-To build and run all tests in response to file changes.
+To build and run all tests in response to file changes
 
 ```bash
 nix-shell --run test-runner
 ```
 
-To perform interactive development w/ `ghcid`.
+To perform interactive development w/ `ghcid`
 
 ```bash
 nix-shell --run ghcid
 ```
 
+To interactively evaluate code in the `repl`
+
+```bash
+nix-shell --run repl
+```
+
+To run the doctests on each file change
+
+```bash
+nix-shell --run doctest-runner
+```
+
+To produce the haddocks and open them in a browser
+
+```bash
+nix-shell --run docs
+```
+
+
 ## Example
 ```haskell
 module Main where
 
 import qualified ArrayFire as A
 
 main :: IO ()
-main = A.printArray action `catch` (\(e :: A.AFException) -> print e)
+main = print newArray `catch` (\(e :: A.AFException) -> print e)
   where
-    action = A.matrix @Double (3,3) [1.0 ..] `A.mul` A.matrix @Double (3,3) [1.0 ..]
-```
+    newArray = A.matrix @Double (2,2) [ [1..], [1..] ] * A.matrix @Double (2,2) [ [2..], [2..] ]
+
+{-|
+
+ArrayFire Array
+[2 2 1 1]
+    2.0000     6.0000
+    2.0000     6.0000
+
+-}
+```

Setup.hs

@@ -1,2 +1,6 @@
-import Distribution.Simple
-main = defaultMain
+module Main where
+
+import Distribution.Extra.Doctest (defaultMainWithDoctests)
+
+main :: IO ()
+main = defaultMainWithDoctests "doctests"

arrayfire.cabal

@@ -8,7 +8,7 @@ author:              David Johnson
 maintainer:          [email protected]
 copyright:           David Johnson (c) 2018-2020
 category:            Math
-build-type:          Simple
+build-type:          Custom
 extra-source-files:  CHANGELOG.md
 cabal-version:       >=1.10
 description:         High-level Haskell bindings to the ArrayFire General-purpose GPU library
@@ -21,6 +21,12 @@ flag disable-default-paths
     default:        False
     manual:         True
 
+custom-setup
+ setup-depends:
+   base <5,
+   Cabal,
+   cabal-doctest >=1 && <1.1
+
 library
   exposed-modules:
     ArrayFire
@@ -80,7 +86,7 @@ library
   hs-source-dirs:
     src
   ghc-options:
-    -Wall
+    -Wall -Wno-missing-home-modules
   default-language:
     Haskell2010
 
@@ -90,9 +96,7 @@ library
     extra-lib-dirs:
       /opt/arrayfire/lib
     ld-options:
-      -rpath /opt/arrayfire/lib
-    cc-options:
-      -fPIC
+      -Wl -rpath /opt/arrayfire/lib
 
 executable main
   hs-source-dirs:
@@ -157,3 +161,18 @@ test-suite test
     ArrayFire.StatisticsSpec
     ArrayFire.UtilSpec
     ArrayFire.VisionSpec
+
+test-suite doctests
+  type:
+    exitcode-stdio-1.0
+  ghc-options:
+    -threaded
+  main-is:
+    Main.hs
+  hs-source-dirs:
+    doctest
+  build-depends:
+    base, doctest >= 0.8
+  default-language:
+    Haskell2010
+

default.nix

@@ -1,2 +1,3 @@
 { pkgs ? import <nixpkgs> {} }:
-pkgs.haskellPackages.callPackage ./pkg.nix {}
+# Latest arrayfire is not yet procured w/ nix.
+pkgs.haskellPackages.callCabal2nix "arrayfire" ./. { af = null; }

doctest/Main.hs

@@ -0,0 +1,7 @@
+module Main (main) where
+
+import Build_doctests            (flags, pkgs, module_sources)
+import Test.DocTest              (doctest)
+
+main :: IO ()
+main = doctest (flags ++ pkgs ++ module_sources)

exe/Main.hs

@@ -5,7 +5,8 @@
 module Main where
 
 import ArrayFire
-import Prelude   hiding (sum, product)
+import Control.Concurrent
+import Prelude            hiding (sum, product)
 -- import GHC.RTS
 
 foreign import ccall safe "test_bool"
@@ -16,11 +17,11 @@ foreign import ccall safe "test_window"
 
 main :: IO ()
 main = do
-  testBool >> testWindow
---  ks <- randn @'(100,100) @Double
---  saveArray 0 "key" ks "array.txt" False
---  !ks' <- readArrayKey "array.txt" "key"
---  print ks'
+  -- testWindow
+  -- ks <- randn @Double [100,100]
+  -- saveArray "key" ks "array.txt" False
+  -- !ks' <- readArrayKey "array.txt" "key"
+  -- print ks'
 
 --   info >> putStrLn "ok" >> afInit
 --   -- Info things
@@ -70,13 +71,13 @@ main = do
 --                 putStrLn "got one"
 --                 print e)
 
---   putStrLn "create window"
---   window <- createWindow 200 200 "hey"
---   putStrLn "set visibility"
---   setVisibility window True
---   putStrLn "show window"
---   showWindow window
-
+  putStrLn "create window"
+  window <- createWindow 200 200 "hey"
+  putStrLn "set visibility"
+  setVisibility window True
+  putStrLn "show window"
+  showWindow window
+  threadDelay (secs 10)
 
 --   -- print =<< getActiveBackend
 --   -- print =<< getDeviceCount
@@ -88,5 +89,5 @@ main = do
 --   -- print =<< getVersion
 
 
--- secs :: Int -> Int
--- secs = (*1000000)
+secs :: Int -> Int
+secs = (*1000000)

shell.nix

@@ -4,6 +4,7 @@ let
 in
   pkgs.lib.overrideDerivation pkg (drv: {
     shellHook = ''
+      export PATH=$PATH:${pkgs.haskellPackages.doctest}/bin
       function ghcid () {
         ${pkgs.haskellPackages.ghcid.bin}/bin/ghcid -c 'cabal v1-repl lib:arrayfire'
       };
@@ -13,5 +14,18 @@ in
              'cabal v1-configure --enable-tests && \
                 cabal v1-build test && dist/build/test/test'
       }
+      function doctest-runner () {
+         ${pkgs.ag}/bin/ag -l | \
+           ${pkgs.entr}/bin/entr sh -c \
+             'cabal v1-configure --enable-tests && \
+                cabal v1-build doctests && dist/build/doctests/doctests'
+      }
+      function repl () {
+        ${pkgs.cabal-install}/bin/cabal v1-repl lib:arrayfire
+      }
+      function docs () {
+        ${pkgs.cabal-install}/bin/cabal haddock
+        open ./dist-newstyle/*/*/*/*/doc/html/arrayfire/index.html
+      }
     '';
   })

src/ArrayFire.hs

@@ -71,7 +71,7 @@ import Data.Word
 -- import qualified ArrayFire as A
 --
 -- main :: IO ()
--- main = A.printArray $ A.matrix @Double (3,3) [1.0 .. ]
+-- main = print $ A.matrix @Double (2,2) [[1,2],[3,4]]
 -- @
 --
 -- * Exception Handling
@@ -84,9 +84,11 @@ import Data.Word
 -- import           Control.Exception ( catch )
 --
 -- main :: IO ()
--- main = A.printArray (action shouldBatchOperation) \`catch\` (\\(e :: A.AFException) -> print e)
+-- main = A.printArray action \`catch\` (\\(e :: A.AFException) -> print e)
 --   where
---     action = A.matrix \@Double (3,3) [1.0 .. ] \`A.mul\` A.matrix \@Double (2,2) [1.0 .. ]
+--     action =
+--       A.matrix \@Double (3,3) [[[1..],[1..],[1..]]]
+--         \`A.mul\` A.matrix \@Double (2,2) [[1..],[1..]]
 -- @
 --
 -- The above operation is invalid since the matrix multiply has improper dimensions. The caught exception produces the following error: