change representation of MStruct to Data.Map.Strict from list of kvs; fixes #17

Author: bbarker

Foreign/Matlab/Array.hsc

@@ -31,7 +31,8 @@ module Foreign.Matlab.Array (
     -- | array list access
     mxArrayGetList, mxArraySetList,
     mxArrayGetAll, mxArraySetAll,
-    mxArrayGetSafe, mxArrayGetFirst, mxArrayGetLast,
+    mxArrayGetOffsetSafe, mxArrayGetFirst, mxArrayGetLast,
+    -- mxArrayGetSafe, --TODO--
     fromListIO, cellFromListsIO,
     isMNull,
 
@@ -51,16 +52,17 @@ module Foreign.Matlab.Array (
     mObjectGetClass, mObjectSetClass
   ) where
 
-import Control.Monad
-import Data.Foldable (toList)
-import Foreign
-import Foreign.C.String
-import Foreign.C.Types
-import Data.Complex
-import Data.Maybe (catMaybes)
-import Foreign.Matlab.Util
-import Foreign.Matlab.Internal
-import Foreign.Matlab.Types
+import           Control.Monad
+import           Data.Foldable (toList)
+import           Foreign
+import           Foreign.C.String
+import           Foreign.C.Types
+import           Data.Complex
+import qualified Data.Map.Strict as DM
+import           Data.Maybe (catMaybes)
+import           Foreign.Matlab.Util
+import           Foreign.Matlab.Internal
+import           Foreign.Matlab.Types
 
 #include <matrix.h>
 
@@ -231,16 +233,16 @@ mxArraySetAll :: MXArrayComponent a => MXArray a -> [a] -> IO ()
 mxArraySetAll a = mxArraySetList a mStart
 
 mxArrayGetFirst :: MXArrayComponent a => MXArray a -> MIO (Either String a)
-mxArrayGetFirst arr = mxArrayGetSafe arr 0
+mxArrayGetFirst arr = mxArrayGetOffsetSafe arr 0
 
 mxArrayGetLast :: MXArrayComponent a => MXArray a -> MIO (Either String a)
 mxArrayGetLast arr = do
   arrLen <- mxArrayLength arr
-  mxArrayGetSafe arr (arrLen - 1)
+  mxArrayGetOffsetSafe arr (arrLen - 1)
 
 -- |Like mxArrayGetOffset but safe.
-mxArrayGetSafe :: forall a. MXArrayComponent a => MXArray a -> Int -> MIO (Either String a)
-mxArrayGetSafe arr ix
+mxArrayGetOffsetSafe :: forall a. MXArrayComponent a => MXArray a -> Int -> MIO (Either String a)
+mxArrayGetOffsetSafe arr ix
   | isMNull arr = pure $ Left "Couldn't get element of null array"
   | otherwise = do
     arrLen <- mxArrayLength arr
@@ -441,7 +443,8 @@ mStructRemoveField a f = withMXArray a $ \a -> do
 
 structGetOffsetFields :: MStructArray -> [String] -> Int -> IO MStruct
 structGetOffsetFields a f o =
-  MStruct =.< withMXArray a (\a -> zipWithM (\f -> ((,) f) .=< (mxGetFieldByNumber a (ii o) >=> mkMXArray)) f [0..])
+  MStruct =.< withMXArray a (\a -> DM.fromList <$> 
+    (zipWithM (\f -> ((,) f) .=< (mxGetFieldByNumber a (ii o) >=> mkMXArray)) f [0..]))
 
 -- |Set the fields of a struct index to the given value list.  The list corresponds to the field list and must match in size.
 mStructSetFields :: MStructArray -> MIndex -> [MXArray a] -> MIO ()
@@ -464,7 +467,7 @@ instance MXArrayComponent MStruct where
     withMXArray a $ \a -> zipWithM_ (\i v -> withMXArray v (mxSetFieldByNumber a 0 i)) [0..] v
     pure a
     where
-      (f,v) = unzip fv
+      (f,v) = unzip $ DM.toList fv
 
 foreign import ccall unsafe mxGetClassName :: MXArrayPtr -> IO CString
 -- |Determine if a struct array is a user defined object, and return its class name, if any.

Foreign/Matlab/Array/IMX.hs

@@ -23,14 +23,15 @@ module Foreign.Matlab.Array.IMX (
     imxStructList
   ) where
 
-import Control.Monad
-import Data.Array.IArray
-import Data.Complex
-import Data.List
-import Foreign.Matlab.Util
-import Foreign.Matlab.Internal
-import Foreign.Matlab.Types
-import Foreign.Matlab.Array
+import           Control.Monad
+import           Data.Array.IArray
+import           Data.Complex
+import           Data.List
+import qualified Data.Map.Strict as DM
+import           Foreign.Matlab.Util
+import           Foreign.Matlab.Internal
+import           Foreign.Matlab.Types
+import           Foreign.Matlab.Array
 
 type IMXArray a = Array MIndex a
 -- |The basic immutable (functional) representation of Matlab data structures, representing a generic 'MXArray'
@@ -153,8 +154,8 @@ imxData a = do
   imxc MXClassStruct False      = do
     s <- mxArraySize a'
     fv <- mxArrayGetAll a'
-    f <- if null fv then mStructFields a' else return (map fst (mStruct (head fv)))
-    listIMXStruct f s =.< mapM imxData (concatMap (map snd . mStruct) fv)
+    f <- if null fv then mStructFields a' else return (map fst (DM.toList $ mStruct (head fv)))
+    listIMXStruct f s =.< mapM imxData (concatMap (map snd . DM.toList . mStruct) fv)
   imxc MXClassLogical False     = IMXLogical    =.< imxa return
   imxc MXClassChar False        = IMXChar       =.< imxa return
   imxc MXClassDouble False      = IMXDouble     =.< imxa return

Foreign/Matlab/Internal.hsc

@@ -27,10 +27,11 @@ module Foreign.Matlab.Internal (
     MWSize, MWIndex, MWSignedIndex
   ) where
 
-import Foreign
-import Foreign.C.Types
+import qualified Data.Map.Strict as DM
+import           Foreign
+import           Foreign.C.Types
 import qualified Data.Char
-import Foreign.Matlab.Util
+import           Foreign.Matlab.Util
 
 #include <matrix.h>
 
@@ -193,7 +194,7 @@ instance MType MCell MCell where
   mxClassOf _ = MXClassCell
 
 -- |A single struct in an array, represented by an (ordered) list of key-value pairs
-newtype MStruct = MStruct { mStruct :: [(String,MAnyArray)] }
+newtype MStruct = MStruct { mStruct :: DM.Map String MAnyArray }
 instance MType MStruct MStruct where
   hs2mx = id
   mx2hs = id

Foreign/Matlab/Types.hs

@@ -41,6 +41,7 @@ module Foreign.Matlab.Types (
     MFun
   ) where
 
+
 import Data.Complex
 import Data.Ix
 import Foreign.Matlab.Internal

attic/Array_interpreter.hs

@@ -0,0 +1,19 @@
+data StructPath =
+    SField String
+  | SIx MIndex
+--  | SList [SField] -- Consider this for later, would require merging and likely runtime errors
+
+data StructTerm =
+
+-- | Convenience tool to automate extraction of MATLAB datastructures.
+mxGetPath :: (MXArrayComponent a, MXArrayComponent b)
+  => [StructPath] -> MXArray a -> MIO (Either String (MXArray b))
+mxGetPath pathCur:pathRest arr = do
+mxGetPath pathCur:[] arr = do
+
+-- TODO - how to dwe deal with the type of non-MXArray vs MXArray in retrievals?
+-- TODO: maye a new class that includes both options?
+
+mxGetPathPart :: (MXArrayComponent a) => StructPath -> MXArray a -> MIO (Either String MAnyArray)
+mxGetPathPart (SField field) arr = do
+mxGetPathPart (SIx ix) arr = do