Documentation updates.

Author: dmjio

src/ArrayFire.hs

@@ -98,6 +98,12 @@ import Data.Word
 -- main = print $ A.matrix @Double (2,2) [[1,2],[3,4]]
 -- @
 --
+-- @
+-- ArrayFire Array
+-- [2 2 1 1]
+--     1.0000     2.0000
+--     3.0000     4.0000
+-- @
 
 -- $modules
 --
@@ -133,27 +139,29 @@ import Data.Word
 -- An 'Array' can be constructed using the following smart constructors:
 --
 -- @
--- >>> scalar @Double 2.0
+-- >>> scalar \@Double 2.0
 -- ArrayFire Array
 -- [1 1 1 1]
 --    2.0000
 -- @
 --
 -- @
--- >>> vector @Double 10 [1..]
+-- >>> vector \@Double 10 [1..]
 -- ArrayFire Array
 -- [10 1 1 1]
 --    1.0000     2.0000     3.0000     4.0000     5.0000     6.0000     7.0000     8.0000     9.0000    10.0000
+-- @
 --
--- >>> matrix @Double (2,2) [[1,2],[3,4]]
+-- @
+-- >>> matrix \@Double (2,2) [[1,2],[3,4]]
 -- ArrayFire Array
 -- [2 2 1 1]
 --    1.0000     2.0000
 --    3.0000     4.0000
 -- @
 --
 -- @
--- >>> cube @Double (2,2,2) [[[2,2],[2,2]],[[2,2],[2,2]]]
+-- >>> cube \@Double (2,2,2) [[[2,2],[2,2]],[[2,2],[2,2]]]
 -- ArrayFire Array
 -- [2 2 2 1]
 --    2.0000     2.0000
@@ -164,7 +172,7 @@ import Data.Word
 -- @
 --
 -- @
--- >>> tensor @Double (2,2,2,2) [[[[2,2],[2,2]],[[2,2],[2,2]]], [[[2,2],[2,2]],[[2,2],[2,2]]]]
+-- >>> tensor \@Double (2,2,2,2) [[[[2,2],[2,2]],[[2,2],[2,2]]], [[[2,2],[2,2]],[[2,2],[2,2]]]]
 -- ArrayFire Array
 -- [2 2 2 2]
 --     2.0000     2.0000
@@ -183,15 +191,15 @@ import Data.Word
 --
 -- Array construction can use Haskell's lazy lists, since 'take' is called on each dimension before sending to the 'C' API.
 --
--- >>> 'mkArray' @Double [2,2] [ [1..], [1..] ]
+-- >>> mkArray @Double [2,2] [ [1..], [1..] ]
 -- ArrayFire Array
 -- [10 1 1 1]
 --     1.0000     2.0000     3.0000     4.0000     5.0000     6.0000     7.0000     8.0000     9.0000    10.0000
 --
 -- Specifying up to 4 dimensions is allowed (anything high is ignored).
 
 -- $laws
--- Every 'Array' is an instance of 'Eq', 'Ord', 'Num', 'Fractional', 'Floating' and 'SemiGroup'
+-- Every 'Array' is an instance of 'Eq', 'Ord', 'Num', 'Fractional', 'Floating' and 'Semigroup'
 --
 -- 'Num'
 --
@@ -246,6 +254,14 @@ import Data.Word
 -- False
 -- >>> scalar @Double 1 [10] > scalar @Double 1 [10]
 -- False
+--
+-- 'Floating'
+--
+-- >>> pi :: Array Double
+-- ArrayFire Array
+-- [1 1 1 1]
+--    3.1416
+--
 
 -- $conversion
 -- 'Array' can be exported into 'Haskell' using `toVector'. This will create a 'Storable' vector suitable for use in other C programs.

src/ArrayFire/Arith.hs

@@ -1283,7 +1283,7 @@ tanh = flip op1 af_tanh
 -- >>> A.asinh (A.vector @Int 10 [1..])
 -- ArrayFire Array
 -- [10 1 1 1]
---    0.7616     0.9640     0.9951     0.9993     0.9999     1.0000     1.0000     1.0000     1.0000     1.0000
+--    0.8814     1.4436     1.8184     2.0947     2.3124     2.4918     2.6441     2.7765     2.8934     2.9982 
 asinh
   :: AFType a
   => Array a
@@ -1294,10 +1294,10 @@ asinh = flip op1 af_asinh
 
 -- | Execute acosh
 --
--- >>> A.acosh (A.vector @Int 10 [1..])
+-- >>> A.acosh (A.vector @Double 10 [1..])
 -- ArrayFire Array
 -- [10 1 1 1]
---    0.7616     0.9640     0.9951     0.9993     0.9999     1.0000     1.0000     1.0000     1.0000     1.0000
+--    0.0000     1.3170     1.7627     2.0634     2.2924     2.4779     2.6339     2.7687     2.8873     2.9932 
 acosh
   :: AFType a
   => Array a
@@ -1308,10 +1308,10 @@ acosh = flip op1 af_acosh
 
 -- | Execute atanh
 --
--- >>> A.atanh (A.vector @Int 10 [1..])
+-- >>> A.atanh (A.vector @Double 10 [1..])
 -- ArrayFire Array
 -- [10 1 1 1]
---    0.7616     0.9640     0.9951     0.9993     0.9999     1.0000     1.0000     1.0000     1.0000     1.0000
+--        inf        nan        nan        nan        nan        nan        nan        nan        nan        nan 
 atanh
   :: AFType a
   => Array a
@@ -1320,7 +1320,6 @@ atanh
   -- ^ Result of calling 'tanh'
 atanh = flip op1 af_atanh
 
-
 -- | Execute root
 --
 -- >>> A.root (A.vector @Double 10 [1..]) (A.vector @Double 10 [1..])
@@ -1635,7 +1634,6 @@ isInf = (`op1` af_isinf)
 
 -- | Execute isNaN
 --
---
 -- >>> A.isNaN $ A.acos (A.vector @Int 10 [1..])
 -- ArrayFire Array
 -- [10 1 1 1]

src/ArrayFire/BLAS.hs

@@ -136,7 +136,9 @@ transpose arr1 (fromIntegral . fromEnum -> b) =
 -- | Transposes a matrix.
 --
 -- * Warning: This function mutates an array in-place, all subsequent references will be changed. Use carefully.
---
+-- >>> array = matrix @Double (2,2) [[1..2],[3..4]]
+-- >>> transposeInPlace array False
+-- ()
 transposeInPlace
   :: Array a
   -- ^ Input matrix to be transposed

src/ArrayFire/Backend.hs

@@ -19,7 +19,6 @@
 -- @
 --
 -- @
--- [nix-shell:~\/arrayfire]$ .\/main
 -- [CPU,OpenCL]
 -- @
 --------------------------------------------------------------------------------
@@ -31,9 +30,8 @@ import ArrayFire.Internal.Types
 
 -- | Set specific 'Backend' to use
 --
--- @
--- >>> 'setBackend' 'OpenCL'
--- @
+-- >>> setBackend OpenCL
+-- ()
 setBackend
   :: Backend
   -- ^ 'Backend' to use for 'Array' construction
@@ -42,60 +40,41 @@ setBackend = afCall . af_set_backend . toAFBackend
 
 -- | Retrieve count of Backends available
 --
--- @
--- >>> 'getBackendCount'
--- @
--- @
+-- >>> getBackendCount
 -- 2
--- @
+--
 getBackendCount :: IO Int
 getBackendCount =
   fromIntegral <$>
     afCall1 af_get_backend_count
 
 -- | Retrieve available 'Backend's
 --
--- @
--- >>> 'mapM_' 'print' '=<<' 'getAvailableBackends'
--- @
--- @
--- 'CPU'
--- 'OpenCL'
--- @
+-- >>> mapM_ print =<< getAvailableBackends
+-- CPU
+-- OpenCL
 getAvailableBackends :: IO [Backend]
 getAvailableBackends =
   toBackends . fromIntegral <$>
     afCall1 af_get_available_backends
 
 -- | Retrieve 'Backend' that specific 'Array' was created from
 --
--- @
--- >>> 'getBackend' ('scalar' \@'Double' 2.0)
--- @
--- @
--- 'OpenCL'
--- @
+-- >>> getBackend (scalar @Double 2.0)
+-- OpenCL
 getBackend :: Array a -> Backend
 getBackend = toBackend . flip infoFromArray af_get_backend_id
 
 -- | Retrieve active 'Backend'
 --
--- @
--- >>> 'getActiveBackend'
--- @
--- @
--- 'OpenCL'
--- @
+-- >>> getActiveBackend
+-- OpenCL
 getActiveBackend :: IO Backend
 getActiveBackend = toBackend <$> afCall1 af_get_active_backend
 
 -- | Retrieve Device ID that 'Array' was created from
 --
--- @
--- >>> 'getDeviceID' ('scalar' \@'Double' 2.0)
--- @
--- @
+-- >>> getDeviceID (scalar \@Double 2.0)
 -- 1
--- @
 getDeviceID :: Array a -> Int
 getDeviceID = fromIntegral . flip infoFromArray af_get_device_id

src/ArrayFire/Device.hs

@@ -10,11 +10,10 @@
 --
 -- Information about ArrayFire API and devices
 --
--- @
+-- >>> info
 --  ArrayFire v3.6.4 (OpenCL, 64-bit Mac OSX, build 1b8030c5)
 -- [0] APPLE: AMD Radeon Pro 555X Compute Engine, 4096 MB
 -- -1- APPLE: Intel(R) UHD Graphics 630, 1536 MB
--- @
 --
 --------------------------------------------------------------------------------
 module ArrayFire.Device where
@@ -24,6 +23,7 @@ import ArrayFire.Internal.Device
 import ArrayFire.FFI
 
 -- | Retrieve info from ArrayFire API
+--
 -- @
 -- ArrayFire v3.6.4 (OpenCL, 64-bit Mac OSX, build 1b8030c5)
 -- [0] APPLE: AMD Radeon Pro 555X Compute Engine, 4096 MB
@@ -33,25 +33,40 @@ info :: IO ()
 info = afCall af_info
 
 -- | Calls 'af_init' C function from ArrayFire API
+--
+-- >>> afInit
+-- ()
 afInit :: IO ()
 afInit = afCall af_init
 
 -- | Retrieves ArrayFire device information as 'String', same as 'info'.
+--
+-- >>> getInfoString
+-- "ArrayFire v3.6.4 (OpenCL, 64-bit Mac OSX, build 1b8030c5)\n[0] APPLE: AMD Radeon Pro 555X Compute Engine, 4096 MB\n-1- APPLE: Intel(R) UHD Graphics 630, 1536 MB\n"
 getInfoString :: IO String
 getInfoString = peekCString =<< afCall1 (flip af_info_string 1)
 
 -- af_err af_device_info(char* d_name, char* d_platform, char *d_toolkit, char* d_compute);
 
 -- | Retrieves count of devices
+--
+-- >>> getDeviceCount
+-- 2
 getDeviceCount :: IO Int
 getDeviceCount = fromIntegral <$> afCall1 af_get_device_count
 
 -- af_err af_get_dbl_support(bool* available, const int device);
 -- | Sets a device by 'Int'
+--
+-- >>> setDevice 0
+-- ()
 setDevice :: Int -> IO ()
 setDevice (fromIntegral -> x) = afCall (af_set_device x)
 
 -- | Retrieves device identifier
+--
+-- >>> getDevice
+-- 0
 getDevice :: IO Int
 getDevice = fromIntegral <$> afCall1 af_get_device
 

src/ArrayFire/Statistics.hs

@@ -131,7 +131,7 @@ stdev a n =
   a `op1` (\x y ->
     af_stdev x y (fromIntegral n))
 
--- | Calculates 'covariance' two 'Array's with a bias specifier.
+-- | Calculates 'covariance' of two 'Array's with a bias specifier.
 --
 -- >>> cov (vector @Double 10 (repeat 1)) (vector @Double 10 (repeat 1)) False
 -- ArrayFire Array
@@ -269,6 +269,7 @@ corrCoef a b =
 
 -- | This function returns the top k values along a given dimension of the input array.
 --
+-- @
 -- >>> let (vals,indexes) = 'topk' ( 'vector' \@'Double' 10 [1..] ) 3 'TopKDefault'
 -- >>> print indexes
 --
@@ -280,6 +281,7 @@ corrCoef a b =
 -- ArrayFire 'Array'
 -- [3 1 1 1]
 --    9          8          7
+-- @
 --
 -- The indices along with their values are returned. If the input is a multi-dimensional array, the indices will be the index of the value in that dimension. Order of duplicate values are not preserved. This function is optimized for small values of k.
 -- This function performs the operation across all dimensions of the input array.