Foreign.Matlab.Array

Array access, including cell arrays and structures.

Functions here are primarily thin wrappers to the underlying Matlab functions, and the same memory-management semantics hold. In particular, created arrays must be freed, copyMXArray and freeMXArray are deep operations, other set operations do not make copies.

Array manipulation

anyMXArray :: MXArray a -> MAnyArray

(Un)cast an array to a generic type.

type MNullArray = MXArray MNull

A NULL (empty) array

castMNull :: MAnyArray -> MIO (Maybe MNullArray)

Safely cast a generic array to a NULL array, or return Nothing if the array is not NULL

mxArrayClass :: MXArray a -> IO MXClass

Return the representation of the type of the elements of an array

mxArrayIsComplex :: MXArray a -> IO Bool

mxArraySize :: MXArray a -> MIO MSize

Get the size (dimensions) of an array

mxArraySetSize :: MXArray a -> MSize -> IO ()

Set dimension array and number of dimensions

mxArrayLength :: MXArray a -> MIO Int

freeMXArray :: MXArray a -> MIO ()

Destroy an array and all of its contents.

copyMXArray :: MXArray a -> MIO (MXArray a)

Make a deep copy of an array

mIndexOffset :: MXArray a -> MIndex -> MIO Int

Convert an array subscript into an offset

Array element access

class MXArrayComponent a where

The class of standardly typeable array elements

Minimal complete definition

createMXArray, mxArrayGetOffset, mxArraySetOffset

Methods

createMXArray :: MSize -> MIO (MXArray a)

Create an array and initialize all its data elements to some default value, usually 0 or []

isMXScalar :: MXArray a -> MIO Bool

Determine if an array is singleton. Equivalent to

 liftM (all (1 ==)) . mxArraySize

mxArrayGetOffset :: MXArray a -> Int -> MIO a

mxArraySetOffset :: MXArray a -> Int -> a -> MIO ()

mxArrayGetOffsetList :: MXArray a -> Int -> Int -> MIO [a]

mxArraySetOffsetList :: MXArray a -> Int -> [a] -> MIO ()

mxScalarGet :: MXArray a -> MIO a

Get the value of the first data element in an array or, more specifically, the value that the array will be interpreted as in scalar context

createMXScalar :: a -> MIO (MXArray a)

Create a singleton (scalar) array having the specified value

createColVector :: [a] -> MIO (MXArray a)

Create a column vector from the given list.

createRowVector :: [a] -> MIO (MXArray a)

Create a row vector from the given list.

Instances

MXArrayComponent MStruct

MXArrayComponent MCell

MXArrayComponent MUint64

MXArrayComponent MUint32

MXArrayComponent MUint16

MXArrayComponent MUint8

MXArrayComponent MInt64

MXArrayComponent MInt32

MXArrayComponent MInt16

MXArrayComponent MInt8

MXArrayComponent MSingle

MXArrayComponent MDouble

MXArrayComponent MLogical

MXArrayComponent MChar

(RealFloat a, MNumeric a, MXArrayData mx a) => MXArrayComponent (MComplex a)

Complex array access.

castMXArray :: forall a. MXArrayComponent a => MAnyArray -> MIO (Maybe (MXArray a))

Safely cast a generic array to a type, or return Nothing if the array does not have the proper type

array element access

mxArrayGet :: MXArrayComponent a => MXArray a -> MIndex -> MIO a

Get the value of the specified array element. Does not check bounds.

mxArraySet :: MXArrayComponent a => MXArray a -> MIndex -> a -> MIO ()

Set an element in an array to the specified value. Does not check bounds.

array list access

mxArrayGetList :: MXArrayComponent a => MXArray a -> MIndex -> Int -> MIO [a]

mxArrayGetList a i n gets the sequential list of n items from array a starting at index i. Does not check bounds.

mxArraySetList :: MXArrayComponent a => MXArray a -> MIndex -> [a] -> MIO ()

mxArraySetList a i l sets the sequential items in array a starting at index i to l. Does not check bounds.

mxArrayGetAll :: MXArrayComponent a => MXArray a -> IO [a]

Get a flat list of all elements in the array.

mxArraySetAll :: MXArrayComponent a => MXArray a -> [a] -> IO ()

Set a flat list of all elements in the array.

Struct access

Structs in Matlab are always arrays, and so can be accessed using most array accessors. |However, the modification functions such as mxArraySet are not implemented because they could disrupt field data in the entire struct array, and so some specialized functions are necessary.

type MStructArray = MXArray MStruct

A (array of) structs

createStruct :: MSize -> [String] -> MIO MStructArray

Create an N-Dimensional structure array having the specified fields; initialize all values to MNullArray

mStructFields :: MStructArray -> MIO [String]

Get the names of the fields

mStructGet :: MStructArray -> MIndex -> String -> MIO MAnyArray

Return the contents of the named field for the given element. Returns MNullArray on no such field or if the field itself is NULL

mStructSet :: MStructArray -> MIndex -> String -> MXArray a -> MIO ()

Sets the contents of the named field for the given element. The input is stored in the array -- no copy is made.

mStructSetFields :: MStructArray -> MIndex -> [MXArray a] -> MIO ()

Set the fields of a struct index to the given value list. The list corresponds to the field list and must match in size.

mStructAddField :: MStructArray -> String -> MIO ()

Add a field to a structure array.

mStructRemoveField :: MStructArray -> String -> MIO ()

Remove a field from a structure array. Does nothing if no such field exists.

Object access

Some structs are also validated (blessed) user objects.

mObjectGetClass :: MStructArray -> IO (Maybe String)

Determine if a struct array is a user defined object, and return its class name, if any.

mObjectSetClass :: MStructArray -> String -> IO ()

Set classname of an unvalidated object array. It is illegal to call this function on a previously validated object array.