{-# LANGUAGE ScopedTypeVariables #-}

{-# LANGUAGE TypeApplications #-}

{-# LANGUAGE ViewPatterns #-}

-- |

module ArrayFire.Util where

import Control.Exception

import Data.Proxy

import Foreign.C.String

import Foreign.ForeignPtr

import Foreign.Marshal hiding (void)

import Foreign.Storable

import System.IO.Unsafe

import ArrayFire.Internal.Types

import ArrayFire.Internal.Util

import ArrayFire.Exception

import ArrayFire.FFI

-- | Retrieve version for ArrayFire API

getVersion :: IO (Int,Int,Int)

getVersion =

alloca $ \x ->

alloca $ \y ->

alloca $ \z -> do

throwAFError =<< af_get_version x y z

(,,) <$> (fromIntegral <$> peek x)

<*> (fromIntegral <$> peek y)

<*> (fromIntegral <$> peek z)

-- | Prints array to stdout

printArray

:: Array a

-- ^ Input 'Array'

-> IO ()

printArray (Array fptr) =

mask_ . withForeignPtr fptr $ \ptr ->

throwAFError =<< af_print_array ptr

-- | Gets git revision of ArrayFire

getRevision :: IO String

getRevision = peekCString =<< af_get_revision

-- | Prints 'Array' with error codes

printArrayGen

:: String

-- ^ is the expression or name of the array

-> Array a

-- ^ is the input array

-> Int

-- ^ precision for the display

-> IO ()

printArrayGen s (Array fptr) (fromIntegral -> prec) = do

mask_ . withForeignPtr fptr $ \ptr ->

withCString s $ \cstr ->

throwAFError =<< af_print_array_gen cstr ptr prec

-- | Saves 'Array' to disk

saveArray

:: String

-- ^ An expression used as tag/key for the 'Array' during readArray

-> Array a

-- ^ Input 'Array'

-> FilePath

-- ^ Path that 'Array' will be saved

-> Bool

-- ^ Used to append to an existing file when 'True' and create or overwrite an existing file when 'False'

-> IO Int

-- ^ The index location of the 'Array' in the file

saveArray key (Array fptr) filename (fromIntegral . fromEnum -> append) = do

mask_ . withForeignPtr fptr $ \ptr ->

alloca $ \ptrIdx -> do

withCString key $ \keyCstr ->

withCString filename $ \filenameCstr -> do

throwAFError =<<

af_save_array ptrIdx keyCstr

ptr filenameCstr append

fromIntegral <$> peek ptrIdx

-- | Reads Array by index

readArrayIndex

:: FilePath

-- ^ Path to 'Array' location

-> Int

-- ^ Index into 'Array'

-> IO (Array a)

readArrayIndex str (fromIntegral -> idx') =

withCString str $ \cstr ->

createArray' (\p -> af_read_array_index p cstr idx')

-- | Reads 'Array' by key

readArrayKey

:: FilePath

-- ^ Path to 'Array'

-> String

-- ^ Key of 'Array' on disk

-> IO (Array a)

-- ^ Returned 'Array'

readArrayKey fn key =

withCString fn $ \fcstr ->

withCString key $ \kcstr ->

createArray' (\p -> af_read_array_key p fcstr kcstr)

-- | Reads Array, checks if a key exists in the specified file

readArrayKeyCheck

:: FilePath

-- ^ Path to file

-> String

-- ^ Key

-> IO Int

-- ^ is the tag/name of the array to be read. The key needs to have an exact match.

readArrayKeyCheck a b =

withCString a $ \acstr ->

withCString b $ \bcstr ->

fromIntegral <$>

afCall1 (\p -> af_read_array_key_check p acstr bcstr)

-- | Convert ArrayFire 'Array' to 'String', used for 'Show' instance.

arrayString

:: Array a

-- ^ Input 'Array'

-> String

-- ^ 'String' representation of 'Array'

arrayString a = arrayToString "ArrayFire Array" a 4 True

-- | Convert ArrayFire Array to String

arrayToString

:: String

-- ^ Name of 'Array'

-> Array a

-- ^ 'Array' input

-> Int

-- ^ Precision of 'Array' values.

-> Bool

-- ^ If 'True', performs takes the transpose before rendering to 'String'

-> String

-- ^ 'Array' rendered to 'String'

arrayToString expr (Array fptr) (fromIntegral -> prec) (fromIntegral . fromEnum -> trans) =

unsafePerformIO . mask_ . withForeignPtr fptr $ \aptr ->

withCString expr $ \expCstr ->

alloca $ \ocstr -> do

throwAFError =<< af_array_to_string ocstr expCstr aptr prec trans

peekCString =<< peek ocstr

-- | Retrieve size of ArrayFire data type

getSizeOf

:: forall a . AFType a

=> Proxy a

-- ^ Witness of Haskell type that mirrors ArrayFire type.

-> Int

-- ^ Size of ArrayFire type

getSizeOf proxy =

unsafePerformIO . mask_ . alloca $ \csize -> do

throwAFError =<< af_get_size_of csize (afType proxy)

fromIntegral <$> peek csize