Update documentation and types.

Author: dmjio

src/ArrayFire.hs

@@ -57,6 +57,7 @@ module ArrayFire
   , module Data.Int
   , module Data.Word
   , module Data.Complex
+  , module Foreign.Storable
   ) where
 
 import ArrayFire.Algorithm
@@ -79,6 +80,7 @@ import ArrayFire.Types
 import ArrayFire.Util
 import ArrayFire.Vision
 import ArrayFire.Orphans ()
+import Foreign.Storable
 import Foreign.C.Types
 import Data.Int
 import Data.Complex
@@ -189,7 +191,7 @@ import Data.Word
 --     2.0000     2.0000
 -- @
 --
--- Array construction can use Haskell's lazy lists, since 'take' is called on each dimension before sending to the 'C' API.
+-- 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..] ]
 -- ArrayFire Array
@@ -254,7 +256,7 @@ import Data.Word
 --
 
 -- $conversion
--- 'Array' can be exported into 'Haskell' using `toVector'. This will create a 'Storable' vector suitable for use in other C programs.
+-- 'Array' can be exported into Haskell using `toVector'. This will create a Storable vector suitable for use in other C programs.
 --
 -- >>> vector :: Vector Double <- toVector <$> randu @Double [10,10]
 --
@@ -271,7 +273,7 @@ import Data.Word
 --   let arr = A.'constant' [1,1,1,1] 10
 --   idx <- A.'saveArray' "key" arr "file.array" False
 --   foundIndex <- A.'readArrayKeyCheck' "file.array" "key"
---   'when' (idx == foundIndex) $ do
+--   when (idx == foundIndex) $ do
 --     array <- A.'readArrayKey' "file.array" "key"
 --     'print' array
 --

src/ArrayFire/Array.hs

@@ -24,7 +24,7 @@
 -- import ArrayFire
 --
 -- main :: 'IO' ()
--- main = 'print' ('matrix' \@'Double' (2,2) [ [1..], [1..] ])
+-- main = 'print' (matrix \@'Double' (2,2) [ [1..], [1..] ])
 -- @
 --
 -- @
@@ -361,7 +361,7 @@ isVector
   -> Bool
 isVector a = toEnum . fromIntegral $ (a `infoFromArray` af_is_vector)
 
--- | Checks if an 'Array' is a 'Complex'
+-- | Checks if an 'Array' is a Complex
 --
 -- >>> isComplex (scalar (1.0 :+ 1.0) :: Array (Complex Double))
 -- True
@@ -372,7 +372,7 @@ isComplex
   -> Bool
 isComplex a = toEnum . fromIntegral $ (a `infoFromArray` af_is_complex)
 
--- | Checks if an 'Array' is 'Real'
+-- | Checks if an 'Array' is Real
 --
 -- >>> isReal (scalar 1.0 :: Array Double)
 -- True
@@ -405,7 +405,7 @@ isSingle
   -> Bool
 isSingle a = toEnum . fromIntegral $ (a `infoFromArray` af_is_single)
 
--- | Checks if an 'Array' is 'Double', 'Float', 'Complex Double', or 'Complex Float'
+-- | Checks if an 'Array' is 'Double', 'Float', Complex 'Double', or Complex 'Float'
 --
 -- >>> isRealFloating (scalar 1.0 :: Array Double)
 -- True
@@ -426,7 +426,7 @@ isFloating
   -> Bool
 isFloating a = toEnum . fromIntegral $ (a `infoFromArray` af_is_floating)
 
--- | Checks if an 'Array' is of type 'Int16', 'Int32', or 'Int64'
+-- | Checks if an 'Array' is of type Int16, Int32, or Int64
 --
 -- >>> isInteger (scalar 1 :: Array Int16)
 -- True
@@ -436,7 +436,7 @@ isInteger
   -> Bool
 isInteger a = toEnum . fromIntegral $ (a `infoFromArray` af_is_integer)
 
--- | Checks if an 'Array' is of type 'CBool'
+-- | Checks if an 'Array' is of type CBool
 --
 -- >>> isBool (scalar 1 :: Array CBool)
 -- True

src/ArrayFire/BLAS.hs

@@ -80,9 +80,9 @@ dot
   -> Array a
   -- ^ Right-hand side input
   -> MatProp
-  -- ^ Options for left-hand side. Currently only 'AF_MAT_NONE' and 'AF_MAT_CONJ' are supported.
+  -- ^ Options for left-hand side. Currently only AF_MAT_NONE and AF_MAT_CONJ are supported.
   -> MatProp
-  -- ^ Options for right-hand side. Currently only 'AF_MAT_NONE' and 'AF_MAT_CONJ' are supported.
+  -- ^ Options for right-hand side. Currently only AF_MAT_NONE and AF_MAT_CONJ are supported.
   -> Array a
   -- ^ Output of 'dot'
 dot arr1 arr2 prop1 prop2 =

src/ArrayFire/Data.hs

@@ -481,7 +481,7 @@ lower
   :: Array a
   -- ^ is the input matrix
   -> Bool
-  -- ^ 'is_unit_diag' is a boolean parameter specifying if the diagonal elements should be 1
+  -- ^ boolean parameter specifying if the diagonal elements should be 1
   -> Array a
 lower a (fromIntegral . fromEnum -> b) =
   a `op1` (\p k -> af_lower p k b)

src/ArrayFire/Device.hs

@@ -32,7 +32,7 @@ import ArrayFire.FFI
 info :: IO ()
 info = afCall af_info
 
--- | Calls 'af_init' C function from ArrayFire API
+-- | Calls /af_init/ C function from ArrayFire API
 --
 -- >>> afInit
 -- ()

src/ArrayFire/Features.hs

@@ -21,7 +21,7 @@ import ArrayFire.Internal.Types
 import ArrayFire.FFI
 import ArrayFire.Exception
 
--- | Construct 'Features'
+-- | Construct Features
 --
 -- >>> features = createFeatures (createFeatures 10)
 --
@@ -37,7 +37,7 @@ createFeatures (fromIntegral -> n) =
     fptr <- newForeignPtr af_release_features ptr
     pure (Features fptr)
 
--- | Retain 'Features'
+-- | Retain Features
 --
 -- >>> features = retainFeatures (createFeatures 10)
 --
@@ -46,7 +46,7 @@ retainFeatures
   -> Features
 retainFeatures = (`op1f` af_retain_features)
 
--- | Get number of 'Feature's
+-- | Get number of Features
 --
 -- link
 --
@@ -58,7 +58,7 @@ getFeaturesNum
   -> Int
 getFeaturesNum = fromIntegral . (`infoFromFeatures` af_get_features_num)
 
--- | Get 'Feature' X-position
+-- | Get Feature X-position
 --
 -- >>> getFeaturesXPos (createFeatures 10)
 -- ArrayFire Array
@@ -70,7 +70,7 @@ getFeaturesXPos
   -> Array a
 getFeaturesXPos = (`featuresToArray` af_get_features_xpos)
 
--- | Get 'Feature' Y-position
+-- | Get Feature Y-position
 --
 -- >>> getFeaturesYPos (createFeatures 10)
 -- ArrayFire Array
@@ -82,7 +82,7 @@ getFeaturesYPos
   -> Array a
 getFeaturesYPos = (`featuresToArray` af_get_features_ypos)
 
--- | Get 'Feature' Score
+-- | Get Feature Score
 --
 -- >>> getFeaturesScore (createFeatures 10)
 -- ArrayFire Array
@@ -94,7 +94,7 @@ getFeaturesScore
   -> Array a
 getFeaturesScore = (`featuresToArray` af_get_features_score)
 
--- | Get 'Feature' orientation
+-- | Get Feature orientation
 --
 -- >>> getFeaturesOrientation (createFeatures 10)
 -- ArrayFire Array
@@ -106,7 +106,7 @@ getFeaturesOrientation
   -> Array a
 getFeaturesOrientation = (`featuresToArray` af_get_features_orientation)
 
--- | Get 'Feature' size
+-- | Get Feature size
 --
 -- >>> getFeaturesSize (createFeatures 10)
 -- ArrayFire Array