Added additional documentation.

Author: dmjio

arrayfire.cabal

@@ -1,8 +1,7 @@
 name:                arrayfire
 version:             0.1.0.0
-synopsis:            Haskell bindings to ArrayFire
-description:         High-level Haskell bindings to ArrayFire
-homepage:            https://github.com/dmjio/fire
+synopsis:            Haskell bindings to the ArrayFire general-purpose GPU library
+homepage:            https://github.com/arrayfire/arrayfire-haskell
 license:             BSD3
 license-file:        LICENSE
 author:              David Johnson
@@ -12,6 +11,12 @@ category:            Math
 build-type:          Simple
 extra-source-files:  CHANGELOG.md
 cabal-version:       >=1.10
+description:         High-level Haskell bindings to the ArrayFire General-purpose GPU library
+    .
+    <<https://user-images.githubusercontent.com/875324/59819388-9ff83f00-92f5-11e9-9ac0-51eef200c716.png>>
+    .
+    <https://www.youtube.com/watch?v=tI89V1Z8QHw>
+    .
 
 library
   exposed-modules:

src/ArrayFire.hs

@@ -2,14 +2,18 @@
 -- |
 -- Module      : ArrayFire
 -- Copyright   : David Johnson (c) 2019-2020
--- License     : BSD 3
+-- License     : BSD3
 -- Maintainer  : David Johnson <[email protected]>
 -- Stability   : Experimental
 -- Portability : GHC
 --
+-- <<https://user-images.githubusercontent.com/875324/59819703-0fbaf980-92f7-11e9-8f53-adebea590bfb.png>>
+--
 --------------------------------------------------------------------------------
 module ArrayFire
-  ( module ArrayFire.Algorithm
+  ( -- * Tutorial
+    -- $tutorial
+    module ArrayFire.Algorithm
   , module ArrayFire.Arith
   , module ArrayFire.Array
   , module ArrayFire.Backend
@@ -58,3 +62,37 @@ import Foreign.C.Types
 import Data.Int
 import Data.Complex
 import Data.Word
+
+-- $tutorial
+--
+-- @
+-- module Main where
+--
+-- import qualified ArrayFire as A
+--
+-- main :: IO ()
+-- main = A.printArray $ A.matrix @Double (3,3) [1.0 .. ]
+-- @
+--
+-- * Exception Handling
+--
+-- @
+-- {\-\# LANGUAGE TypeApplications \#\-}
+-- module Main where
+--
+-- import qualified ArrayFire         as A
+-- import           Control.Exception ( catch )
+--
+-- main :: IO ()
+-- main = A.printArray (action shouldBatchOperation) \`catch\` (\\(e :: A.AFException) -> print e)
+--   where
+--     action = A.matrix \@Double (3,3) [1.0 .. ] \`A.mul\` A.matrix \@Double (2,2) [1.0 .. ]
+--     shouldBatchOperation = True
+-- @
+--
+-- The above operation is invalid since the matrix multiply has improper dimensions. The caught exception produces the following error:
+--
+-- > AFException {afExceptionType = SizeError, afExceptionCode = 203, afExceptionMsg = "Invalid input size"}
+--
+
+

src/ArrayFire/Algorithm.hs

@@ -10,6 +10,8 @@
 -- Stability   : Experimental
 -- Portability : GHC
 --
+-- Functions for aggregation, manipulation of 'Array'
+--
 --------------------------------------------------------------------------------
 module ArrayFire.Algorithm where
 

src/ArrayFire/Arith.hs

@@ -10,6 +10,8 @@
 -- Stability   : Experimental
 -- Portability : GHC
 --
+-- Arithmetic functions over 'Array'
+--
 --------------------------------------------------------------------------------
 module ArrayFire.Arith where
 
@@ -20,6 +22,12 @@ import ArrayFire.FFI
 import ArrayFire.Internal.Arith
 import ArrayFire.Types
 
+-- | Adds two 'Array' objects
+--
+-- @
+-- >>> (scalar \@Int 1 \`add\` scalar \@Int 1) True
+-- @
+--
 add
   :: AFType a
   => Array a
@@ -34,6 +42,12 @@ add x y (fromIntegral . fromEnum -> batch) =
   x `op2` y $ \arr arr1 arr2 ->
     af_add arr arr1 arr2 batch
 
+-- | Subtracts two 'Array' objects
+--
+-- @
+-- >>> (scalar @Int 1 \`sub\` scalar @Int 1) True
+-- @
+--
 sub
   :: AFType a
   => Array a
@@ -48,6 +62,12 @@ sub x y (fromIntegral . fromEnum -> batch) = do
   x `op2` y $ \arr arr1 arr2 ->
     af_sub arr arr1 arr2 batch
 
+-- | Multiply two 'Array' objects
+--
+-- @
+-- >>> (scalar @Int 1 \`mul\` scalar @Int 1) True
+-- @
+--
 mul
   :: AFType a
   => Array a
@@ -62,6 +82,12 @@ mul x y (fromIntegral . fromEnum -> batch) = do
   x `op2` y $ \arr arr1 arr2 ->
     af_mul arr arr1 arr2 batch
 
+-- | Divide two 'Array' objects
+--
+-- @
+-- >>> (scalar @Int 1 \`mul\` scalar @Int 1) True
+-- @
+--
 div
   :: AFType a
   => Array a
@@ -76,6 +102,12 @@ div x y (fromIntegral . fromEnum -> batch) = do
   x `op2` y $ \arr arr1 arr2 ->
     af_div arr arr1 arr2 batch
 
+-- | Test if on 'Array' is less than another 'Array'
+--
+-- @
+-- >>> (scalar \@Int 1 \`lt\` scalar \@Int 1) True
+-- @
+--
 lt
   :: AFType a
   => Array a