#include <stdlib.h>
#include <stddef.h>
#include "tmwtypes.h"
#include <assert.h>

Macros
#define	matrix_h

#define	MX_API_VER 0x07040000
	Version 7.4.0. More...

#define	MATHWORKS_MATRIX_DETAIL_PUBLISHED_FWD_DECLS_HPP

#define	mxMAXNAM TMW_NAME_LENGTH_MAX
	Maximum mxArray name length. More...


we can't see these definitions, which are stored in `package.h`, so we duplicate them here.
#define	MATRIX_DLL_EXPORT_SYM

#define	MATRIX_DLL_IMPORT_SYM


Define symbol access for symbols exported from the `libmwmatrix` dll.
#define	LIBMMWMATRIX_PUBLISHED_API

#define	LIBMMWMATRIX_PUBLISHED_API_EXTERN_C extern LIBMMWMATRIX_PUBLISHED_API


mxAssert(int expression, char *error_message) Similar to ANSI C's `assert()` macro, the mxAssert macro checks the value of an assertion, continuing execution only if the assertion holds. If `'expression'` evaluates to be true, then the mxAssert does nothing. If, however, `'expression'` is false, then mxAssert prints an error message to the MATLAB Command Window, consisting of the failed assertion's expression, the file name and line number where the failed assertion occurred, and the string `'error_message'`. `'error_message'` allows the user to specify a more understandable description of why the assertion failed. (Use an empty string if no extra description should follow the failed assertion message.) After a failed assertion, control returns to the MATLAB command line. mxAssertS, (the `S` for Simple), takes the same inputs as mxAssert. It does not print the text of the failed assertion, only the file and line where the assertion failed, and the explanatory `error_message`. Note that script MEX will turn off these assertions when building optimized MEX-functions, so they should be used for debugging purposes only.
#define	mxassert_h

#define	mxAssert(test, message) assert(test)

#define	mxAssertS(test, message) assert(test)


PUBLISHED APIs with changes in MATLAB 7.3
#define	mxSetProperty mxSetProperty_730

#define	mxGetProperty mxGetProperty_730

#define	mxSetField mxSetField_730

#define	mxSetFieldByNumber mxSetFieldByNumber_730

#define	mxGetFieldByNumber mxGetFieldByNumber_730

#define	mxGetField mxGetField_730

#define	mxCreateStructMatrix mxCreateStructMatrix_730

#define	mxCreateCellMatrix mxCreateCellMatrix_730

#define	mxCreateCharMatrixFromStrings mxCreateCharMatrixFromStrings_730

#define	mxGetString mxGetString_730

#define	mxGetNumberOfDimensions mxGetNumberOfDimensions_730

#define	mxGetDimensions mxGetDimensions_730

#define	mxSetDimensions mxSetDimensions_730

#define	mxSetIr mxSetIr_730

#define	mxGetIr mxGetIr_730

#define	mxSetJc mxSetJc_730

#define	mxGetJc mxGetJc_730

#define	mxCreateStructArray mxCreateStructArray_730

#define	mxCreateCharArray mxCreateCharArray_730

#define	mxCreateNumericArray mxCreateNumericArray_730

#define	mxCreateCellArray mxCreateCellArray_730

#define	mxCreateLogicalArray mxCreateLogicalArray_730

#define	mxGetCell mxGetCell_730

#define	mxSetCell mxSetCell_730

#define	mxSetNzmax mxSetNzmax_730

#define	mxSetN mxSetN_730

#define	mxSetM mxSetM_730

#define	mxGetNzmax mxGetNzmax_730

#define	mxCreateDoubleMatrix mxCreateDoubleMatrix_730

#define	mxCreateNumericMatrix mxCreateNumericMatrix_730

#define	mxCreateLogicalMatrix mxCreateLogicalMatrix_730

#define	mxCreateSparse mxCreateSparse_730

#define	mxCreateSparseLogicalMatrix mxCreateSparseLogicalMatrix_730

#define	mxGetNChars mxGetNChars_730

#define	mxCreateStringFromNChars mxCreateStringFromNChars_730

#define	mxCalcSingleSubscript mxCalcSingleSubscript_730

#define	mxGetDimensions_fcn mxGetDimensions_730

Typedefs
typedef struct mxArray_tag	mxArray
	Forward declaration for mxArray. More...

typedef void(*	mxFunctionPtr) (int nlhs, mxArray plhs[], int nrhs, mxArray prhs[])
	Type representing the signature for MEX functions. More...

typedef bool	mxLogical
	Logical type. More...

typedef CHAR16_T	mxChar
	Typedef required for Unicode support in MATLAB. More...

Enumerations
enum	mxClassID { mxUNKNOWN_CLASS = 0, mxCELL_CLASS, mxSTRUCT_CLASS, mxLOGICAL_CLASS, mxCHAR_CLASS, mxVOID_CLASS, mxDOUBLE_CLASS, mxSINGLE_CLASS, mxINT8_CLASS, mxUINT8_CLASS, mxINT16_CLASS, mxUINT16_CLASS, mxINT32_CLASS, mxUINT32_CLASS, mxINT64_CLASS, mxUINT64_CLASS, mxFUNCTION_CLASS, mxOPAQUE_CLASS, mxOBJECT_CLASS, mxINDEX_CLASS = mxUINT32_CLASS, mxSPARSE_CLASS = mxVOID_CLASS }
	Enumeration corresponding to all the valid mxArray types. More...

enum	mxComplexity { mxREAL, mxCOMPLEX }
	Indicates whether floating-point mxArray's are real or complex. More...

Functions
LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void *	mxMalloc (size_t n)
	allocate memory, notifying registered listener More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void *	mxCalloc (size_t n, size_t sz)
	clear allocated memory, notifying registered listener. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxFree (void *ptr)
	free memory, notifying registered listener. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void *	mxRealloc (void *ptr, size_t sz)
	reallocate memory, notifying registered listener. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const char *	mxGetFieldNameByNumber (const mxArray *pa, int n)
	Return pointer to the nth field name. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxClassID	mxGetClassID (const mxArray *pa)
	Return the class (catergory) of data that the array holds. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void *	mxGetData (const mxArray *pa)
	Get pointer to data. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetData (mxArray pa, void newdata)
	Set pointer to data. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsNumeric (const mxArray *pa)
	Determine whether the specified array contains numeric (as opposed to cell or struct) data. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsCell (const mxArray *pa)
	Determine whether the given array is a cell array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsLogical (const mxArray *pa)
	Determine whether the given array's logical flag is on. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsScalar (const mxArray *pa)
	Determine whether the given array's scalar flag is on. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsChar (const mxArray *pa)
	Determine whether the given array contains character data. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsStruct (const mxArray *pa)
	Determine whether the given array is a structure array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsOpaque (const mxArray *pa)
	Determine whether the given array is an opaque array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsFunctionHandle (const mxArray *pa)
	Returns true if specified array is a function object. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsObject (const mxArray *pa)
	Is array user defined MATLAB v5 object. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void *	mxGetImagData (const mxArray *pa)
	Get imaginary data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetImagData (mxArray pa, void newdata)
	Set imaginary data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsComplex (const mxArray *pa)
	Determine whether the given array contains complex data. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsSparse (const mxArray *pa)
	Determine whether the given array is a sparse (as opposed to full). More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsDouble (const mxArray *pa)
	Determine whether the specified array represents its data as double-precision floating-point numbers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsSingle (const mxArray *pa)
	Determine whether the specified array represents its data as single-precision floating-point numbers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsInt8 (const mxArray *pa)
	Determine whether the specified array represents its data as signed 8-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsUint8 (const mxArray *pa)
	Determine whether the specified array represents its data as unsigned 8-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsInt16 (const mxArray *pa)
	Determine whether the specified array represents its data as signed 16-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsUint16 (const mxArray *pa)
	Determine whether the specified array represents its data as unsigned 16-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsInt32 (const mxArray *pa)
	Determine whether the specified array represents its data as signed 32-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsUint32 (const mxArray *pa)
	Determine whether the specified array represents its data as unsigned 32-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsInt64 (const mxArray *pa)
	Determine whether the specified array represents its data as signed 64-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsUint64 (const mxArray *pa)
	Determine whether the specified array represents its data as unsigned 64-bit integers. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxGetNumberOfElements (const mxArray *pa)
	Get number of elements in array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double *	mxGetPr (const mxArray *pa)
	Get real data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetPr (mxArray pa, double pr)
	Set real data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double *	mxGetPi (const mxArray *pa)
	Get imaginary data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetPi (mxArray pa, double pi)
	Set imaginary data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxChar *	mxGetChars (const mxArray *pa)
	Get string array data. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetUserBits (const mxArray *pa)
	Get 8 bits of user data stored in the mxArray header. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetUserBits (mxArray *pa, int value)
	Set 8 bits of user data stored in the mxArray header. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double	mxGetScalar (const mxArray *pa)
	Get the real component of the specified array's first data element. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsFromGlobalWS (const mxArray *pa)
	Inform Watcom compilers that scalar double return values will be in the FPU register. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetFromGlobalWS (mxArray *pa, bool global)
	Set the `isFromGlobalWorkspace` bit. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxGetN (const mxArray *pa)
	Get column dimension. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsEmpty (const mxArray *pa)
	Is array empty. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetFieldNumber (const mxArray pa, const char name)
	Get the index to the named field. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxGetElementSize (const mxArray *pa)
	Get array data element size. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetNumberOfFields (const mxArray *pa)
	Get number of structure fields in array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const char *	mxGetClassName (const mxArray *pa)
	Return the name of an array's class. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsClass (const mxArray pa, const char name)
	Determine whether an array is a member of the specified class. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateUninitNumericMatrix (size_t m, size_t n, mxClassID classid, mxComplexity flag)
	Create an uninitialized numeric matrix. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateUninitNumericArray (size_t ndim, size_t *dims, mxClassID classid, mxComplexity flag)
	Create an uninitialized numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxDestroyArray (mxArray *pa)
	mxArray destructor More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxLogical *	mxGetLogicals (const mxArray *pa)
	Get a properly typed pointer to the elements of a logical array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateLogicalScalar (bool value)
	Create a logical scalar mxArray having the specified value. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsLogicalScalar (const mxArray *pa)
	Returns true if we have a valid logical scalar mxArray. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsLogicalScalarTrue (const mxArray *pa)
	Returns true if the logical scalar value is true. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateDoubleScalar (double value)
	Create a double-precision scalar mxArray initialized to the value specified. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C char *	mxArrayToString (const mxArray *pa)
	Create a `NULL` terminated C-string from an mxArray of type `mxCHAR_CLASS` Supports multibyte character sets. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C char *	mxArrayToUTF8String (mxArray const *pa)
	Create a `NULL` terminated C-string from an mxArray of type `mxCHAR_CLASS` The C-style string is in UTF-8 encoding. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateString (const char *str)
	Create a `1-by-n` string array initialized to `NULL` terminated string where `n` is the length of the string. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxDuplicateArray (const mxArray *pa)
	Make a deep copy of an array, return a pointer to the copy. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxSetClassName (mxArray pa, const char classname)
	Set `classname` of an unvalidated object array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxAddField (mxArray pa, const char fieldname)
	Add a field to a structure array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxRemoveField (mxArray *pa, int field)
	Remove a field from a structure array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double	mxGetEps (void)
	Function for obtaining MATLAB's concept of `EPS`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double	mxGetInf (void)
	Function for obtaining MATLAB's concept of `INF` (Used in MEX-File callback). More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double	mxGetNaN (void)
	Function for obtaining MATLAB's concept of `NaN` (Used in MEX-File callback). More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsFinite (double x)
	Inform Watcom compilers that scalar double return values will be in the FPU register. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsInf (double x)
	test for infinity in a machine-independent manner More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool	mxIsNaN (double x)
	test for `NaN` in a machine-independent manner More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxGetNumberOfDimensions_730 (const mxArray *pa)
	Get number of dimensions in array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetNumberOfDimensions_700 (const mxArray *pa)
	Get number of dimensions in array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const size_t *	mxGetDimensions_730 (const mxArray *pa)
	Get pointer to dimension array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const int *	mxGetDimensions_700 (const mxArray *pa)
	Get pointer to dimension array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxGetM (const mxArray *pa)
	Get row dimension. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t *	mxGetIr_730 (const mxArray *pa)
	Get row data pointer for sparse numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int *	mxGetIr_700 (const mxArray *pa)
	Get row dimension. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t *	mxGetJc_730 (const mxArray *pa)
	Get column data pointer for sparse numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int *	mxGetJc_700 (const mxArray *pa)
	Get column data pointer for sparse numeric array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxGetNzmax_730 (const mxArray *pa)
	Get maximum nonzero elements for sparse numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetNzmax_700 (const mxArray *pa)
	Get maximum nonzero elements for sparse numeric array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetNzmax_730 (mxArray *pa, size_t nzmax)
	Set maximum nonzero elements for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetNzmax_700 (mxArray *pa, int nzmax)
	Set maximum nonzero elements for numeric array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetFieldByNumber_730 (const mxArray *pa, size_t i, int fieldnum)
	Return a pointer to the contents of the named field for the ith element (zero based). More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetFieldByNumber_700 (const mxArray *pa, int i, int fieldnum)
	Return a pointer to the contents of the named field for the ith element (zero based). More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetCell_730 (const mxArray *pa, size_t i)
	Get a pointer to the specified cell element. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetCell_700 (const mxArray *pa, int i)
	Get a pointer to the specified cell element. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetM_730 (mxArray *pa, size_t m)
	Set row dimension. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetM_700 (mxArray *pa, int m)
	Set row dimension. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetIr_730 (mxArray pa, size_t newir)
	Set row data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetIr_700 (mxArray pa, int newir)
	Set row data pointer for numeric array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetJc_730 (mxArray pa, size_t newjc)
	Set column data pointer for numeric array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetJc_700 (mxArray pa, int newjc)
	Set column data pointer for numeric array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t	mxCalcSingleSubscript_730 (const mxArray pa, size_t nsubs, const size_t subs)
	Return the offset (in number of elements) from the beginning of the array to a given subscript. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxCalcSingleSubscript_700 (const mxArray pa, int nsubs, const int subs)
	Return the offset (in number of elements) from the beginning of the array to a given subscript. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetCell_730 (mxArray pa, size_t i, mxArray value)
	Set an element in a cell array to the specified value. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetCell_700 (mxArray pa, int i, mxArray value)
	Set an element in a cell array to the specified value. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetFieldByNumber_730 (mxArray pa, size_t i, int fieldnum, mxArray value)
	Sets `pa`[i][fieldnum]=value. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetFieldByNumber_700 (mxArray pa, int i, int fieldnum, mxArray value)
	Sets `pa`[i][fieldnum]=value. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetField_730 (const mxArray pa, size_t i, const char fieldname)
	Return a pointer to the contents of the named field for the ith element (zero based). More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetField_700 (const mxArray pa, int i, const char fieldname)
	Return a pointer to the contents of the named field for the ith element (zero based). More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetField_730 (mxArray pa, size_t i, const char fieldname, mxArray *value)
	Sets the contents of the named field for the ith element (zero based). More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetField_700 (mxArray pa, int i, const char fieldname, mxArray *value)
	Sets the contents of the named field for the ith element (zero based). More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetProperty_730 (const mxArray pa, const size_t i, const char propname)
	mxGetProperty returns the value of a property for a given object and index. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxGetProperty_700 (const mxArray pa, const int i, const char propname)
	mxGetProperty returns the value of a property for a given object and index. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetProperty_730 (mxArray pa, size_t i, const char propname, const mxArray *value)
	mxSetProperty sets the value of a property for a given object and index. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetProperty_700 (mxArray pa, int i, const char propname, const mxArray *value)
	mxSetProperty sets the value of a property for a given object and index. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateNumericMatrix_730 (size_t m, size_t n, mxClassID classid, mxComplexity flag)
	Create a numeric matrix and initialize all its data elements to 0. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateNumericMatrix_700 (int m, int n, mxClassID classid, mxComplexity flag)
	Create a numeric matrix and initialize all its data elements to 0. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetN_730 (mxArray *pa, size_t n)
	Set column dimension. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxSetN_700 (mxArray *pa, int n)
	Set column dimension. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxSetDimensions_730 (mxArray pa, const size_t pdims, size_t ndims)
	Set dimension array and number of dimensions. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxSetDimensions_700 (mxArray pa, const int pdims, int ndims)
	Set dimension array and number of dimensions. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateNumericArray_730 (size_t ndim, const size_t *dims, mxClassID classid, mxComplexity flag)
	Create a numeric array and initialize all its data elements to 0. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateNumericArray_700 (int ndim, const int *dims, mxClassID classid, mxComplexity flag)
	Create a numeric array and initialize all its data elements to 0. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCharArray_730 (size_t ndim, const size_t *dims)
	Create an N-Dimensional array to hold string data; initialize all elements to 0. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCharArray_700 (int ndim, const int *dims)
	Create an N-Dimensional array to hold string data; initialize all elements to 0. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateDoubleMatrix_730 (size_t m, size_t n, mxComplexity flag)
	Create a two-dimensional array to hold double-precision floating-point data; initialize each data element to 0. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateDoubleMatrix_700 (int m, int n, mxComplexity flag)
	Create a two-dimensional array to hold double-precision floating-point data; initialize each data element to 0. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateLogicalArray_730 (size_t ndim, const size_t *dims)
	Create a logical array and initialize its data elements to false. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateLogicalArray_700 (int ndim, const int *dims)
	Create a logical array and initialize its data elements to false. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateLogicalMatrix_730 (size_t m, size_t n)
	Create a two-dimensional array to hold logical data and initializes each data element to false. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateLogicalMatrix_700 (int m, int n)
	Create a two-dimensional array to hold logical data and initializes each data element to false. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateSparse_730 (size_t m, size_t n, size_t nzmax, mxComplexity flag)
	Create a 2-Dimensional sparse array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateSparse_700 (int m, int n, int nzmax, mxComplexity flag)
	Create a 2-Dimensional sparse array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateSparseLogicalMatrix_730 (size_t m, size_t n, size_t nzmax)
	Create a 2-D sparse logical array. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateSparseLogicalMatrix_700 (int m, int n, int nzmax)
	Create a 2-D sparse logical array. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxGetNChars_730 (const mxArray pa, char buf, size_t nChars)
	Copies characters from a MATLAB array to a char array This function will attempt to perform null termination if it is possible. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void	mxGetNChars_700 (const mxArray pa, char buf, int nChars)
	Copies characters from a MATLAB array to a char array This function will attempt to perform null termination if it is possible. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetString_730 (const mxArray pa, char buf, size_t buflen)
	Converts a string array to a C-style string. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int	mxGetString_700 (const mxArray pa, char buf, int buflen)
	Converts a string array to a C-style string. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateStringFromNChars_730 (const char *str, size_t n)
	Create a `1-by-n` string array initialized to `str`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateStringFromNChars_700 (const char *str, int n)
	Create a `1-by-n` string array initialized to `str`. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCharMatrixFromStrings_730 (size_t m, const char **str)
	Create a string array initialized to the strings in `str`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCharMatrixFromStrings_700 (int m, const char **str)
	Create a string array initialized to the strings in `str`. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCellMatrix_730 (size_t m, size_t n)
	Create a 2-Dimensional cell array, with each cell initialized to `NULL`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCellMatrix_700 (int m, int n)
	Create a 2-Dimensional cell array, with each cell initialized to `NULL`. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCellArray_730 (size_t ndim, const size_t *dims)
	Create an N-Dimensional cell array, with each cell initialized to `NULL`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateCellArray_700 (int ndim, const int *dims)
	Create an N-Dimensional cell array, with each cell initialized to `NULL`. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateStructMatrix_730 (size_t m, size_t n, int nfields, const char **fieldnames)
	Create a 2-Dimensional structure array having the specified fields; initialize all values to `NULL`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateStructMatrix_700 (int m, int n, int nfields, const char **fieldnames)
	Create a 2-Dimensional structure array having the specified fields; initialize all values to `NULL`. More...


LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateStructArray_730 (size_t ndim, const size_t dims, int nfields, const char *fieldnames)
	Create an N-Dimensional structure array having the specified fields; initialize all values to `NULL`. More...

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray *	mxCreateStructArray_700 (int ndim, const int dims, int nfields, const char *fieldnames)
	Create an N-Dimensional structure array having the specified fields; initialize all values to `NULL`. More...

Macro Definition Documentation

◆ LIBMMWMATRIX_PUBLISHED_API

#define LIBMMWMATRIX_PUBLISHED_API

Definition at line 65 of file matrix.h.

◆ LIBMMWMATRIX_PUBLISHED_API_EXTERN_C

#define LIBMMWMATRIX_PUBLISHED_API_EXTERN_C extern LIBMMWMATRIX_PUBLISHED_API

Definition at line 72 of file matrix.h.

◆ MATHWORKS_MATRIX_DETAIL_PUBLISHED_FWD_DECLS_HPP

#define MATHWORKS_MATRIX_DETAIL_PUBLISHED_FWD_DECLS_HPP

Definition at line 252 of file matrix.h.

◆ MATRIX_DLL_EXPORT_SYM

#define MATRIX_DLL_EXPORT_SYM

Definition at line 40 of file matrix.h.

◆ MATRIX_DLL_IMPORT_SYM

#define MATRIX_DLL_IMPORT_SYM

Definition at line 41 of file matrix.h.

◆ matrix_h

#define matrix_h

Definition at line 22 of file matrix.h.

◆ MX_API_VER

#define MX_API_VER 0x07040000

Version 7.4.0.

Definition at line 79 of file matrix.h.

◆ mxAssert

#define mxAssert	(	test,
		message
	)	assert(test)

Definition at line 1406 of file matrix.h.

◆ mxassert_h

#define mxassert_h

Definition at line 1394 of file matrix.h.

◆ mxAssertS

#define mxAssertS	(	test,
		message
	)	assert(test)

Definition at line 1407 of file matrix.h.

◆ mxCalcSingleSubscript

#define mxCalcSingleSubscript mxCalcSingleSubscript_730

Definition at line 1534 of file matrix.h.

◆ mxCreateCellArray

#define mxCreateCellArray mxCreateCellArray_730

Definition at line 1489 of file matrix.h.

◆ mxCreateCellMatrix

#define mxCreateCellMatrix mxCreateCellMatrix_730

Definition at line 1450 of file matrix.h.

◆ mxCreateCharArray

#define mxCreateCharArray mxCreateCharArray_730

Definition at line 1483 of file matrix.h.

◆ mxCreateCharMatrixFromStrings

#define mxCreateCharMatrixFromStrings mxCreateCharMatrixFromStrings_730

Definition at line 1453 of file matrix.h.

◆ mxCreateDoubleMatrix

#define mxCreateDoubleMatrix mxCreateDoubleMatrix_730

Definition at line 1513 of file matrix.h.

◆ mxCreateLogicalArray

#define mxCreateLogicalArray mxCreateLogicalArray_730

Definition at line 1492 of file matrix.h.

◆ mxCreateLogicalMatrix

#define mxCreateLogicalMatrix mxCreateLogicalMatrix_730

Definition at line 1519 of file matrix.h.

◆ mxCreateNumericArray

#define mxCreateNumericArray mxCreateNumericArray_730

Definition at line 1486 of file matrix.h.

◆ mxCreateNumericMatrix

#define mxCreateNumericMatrix mxCreateNumericMatrix_730

Definition at line 1516 of file matrix.h.

◆ mxCreateSparse

#define mxCreateSparse mxCreateSparse_730

Definition at line 1522 of file matrix.h.

◆ mxCreateSparseLogicalMatrix

#define mxCreateSparseLogicalMatrix mxCreateSparseLogicalMatrix_730

Definition at line 1525 of file matrix.h.

◆ mxCreateStringFromNChars

#define mxCreateStringFromNChars mxCreateStringFromNChars_730

Definition at line 1531 of file matrix.h.

◆ mxCreateStructArray

#define mxCreateStructArray mxCreateStructArray_730

Definition at line 1480 of file matrix.h.

◆ mxCreateStructMatrix

#define mxCreateStructMatrix mxCreateStructMatrix_730

Definition at line 1447 of file matrix.h.

◆ mxGetCell

#define mxGetCell mxGetCell_730

Definition at line 1495 of file matrix.h.

◆ mxGetDimensions

#define mxGetDimensions mxGetDimensions_730

Definition at line 1462 of file matrix.h.

◆ mxGetDimensions_fcn

#define mxGetDimensions_fcn mxGetDimensions_730

Definition at line 1537 of file matrix.h.

◆ mxGetField

#define mxGetField mxGetField_730

Definition at line 1444 of file matrix.h.

◆ mxGetFieldByNumber

#define mxGetFieldByNumber mxGetFieldByNumber_730

Definition at line 1441 of file matrix.h.

◆ mxGetIr

#define mxGetIr mxGetIr_730

Definition at line 1471 of file matrix.h.

◆ mxGetJc

#define mxGetJc mxGetJc_730

Definition at line 1477 of file matrix.h.

◆ mxGetNChars

#define mxGetNChars mxGetNChars_730

Definition at line 1528 of file matrix.h.

◆ mxGetNumberOfDimensions

#define mxGetNumberOfDimensions mxGetNumberOfDimensions_730

Definition at line 1459 of file matrix.h.

◆ mxGetNzmax

#define mxGetNzmax mxGetNzmax_730

Definition at line 1510 of file matrix.h.

◆ mxGetProperty

#define mxGetProperty mxGetProperty_730

Definition at line 1432 of file matrix.h.

◆ mxGetString

#define mxGetString mxGetString_730

Definition at line 1456 of file matrix.h.

◆ mxMAXNAM

#define mxMAXNAM TMW_NAME_LENGTH_MAX

Maximum mxArray name length.

Definition at line 274 of file matrix.h.

◆ mxSetCell

#define mxSetCell mxSetCell_730

Definition at line 1498 of file matrix.h.

◆ mxSetDimensions

#define mxSetDimensions mxSetDimensions_730

Definition at line 1465 of file matrix.h.

◆ mxSetField

#define mxSetField mxSetField_730

Definition at line 1435 of file matrix.h.

◆ mxSetFieldByNumber

#define mxSetFieldByNumber mxSetFieldByNumber_730

Definition at line 1438 of file matrix.h.

◆ mxSetIr

#define mxSetIr mxSetIr_730

Definition at line 1468 of file matrix.h.

◆ mxSetJc

#define mxSetJc mxSetJc_730

Definition at line 1474 of file matrix.h.

◆ mxSetM

#define mxSetM mxSetM_730

Definition at line 1507 of file matrix.h.

◆ mxSetN

#define mxSetN mxSetN_730

Definition at line 1504 of file matrix.h.

◆ mxSetNzmax

#define mxSetNzmax mxSetNzmax_730

Definition at line 1501 of file matrix.h.

◆ mxSetProperty

#define mxSetProperty mxSetProperty_730

Definition at line 1429 of file matrix.h.

Typedef Documentation

◆ mxArray

typedef struct mxArray_tag mxArray

Forward declaration for mxArray.

Definition at line 259 of file matrix.h.

◆ mxChar

typedef CHAR16_T mxChar

Typedef required for Unicode support in MATLAB.

Definition at line 284 of file matrix.h.

◆ mxFunctionPtr

typedef void(* mxFunctionPtr) (int nlhs, mxArray *plhs[], int nrhs, mxArray *prhs[])

Type representing the signature for MEX functions.

Parameters

nlhs	number of expected outputs
plhs	array of pointers to output arguments
nrhs	number of inputs
prhs	array of pointers to input arguments

Definition at line 269 of file matrix.h.

◆ mxLogical

typedef bool mxLogical

Logical type.

Definition at line 279 of file matrix.h.

Enumeration Type Documentation

◆ mxClassID

enum mxClassID

Enumeration corresponding to all the valid mxArray types.

Enumerator
mxUNKNOWN_CLASS	Undetermined class. You cannot specify this category for an mxArray; however, if mxGetClassID cannot identify the class, it returns this value.
mxCELL_CLASS	Identifies a cell mxArray.
mxSTRUCT_CLASS	Identifies a structure mxArray.
mxLOGICAL_CLASS	Identifies a logical mxArray, an mxArray of mxLogical data.
mxCHAR_CLASS	Identifies a string mxArray, an mxArray whose data is represented as mxChar.
mxVOID_CLASS	Reserved.
mxDOUBLE_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxSINGLE_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxINT8_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxUINT8_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxINT16_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxUINT16_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxINT32_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxUINT32_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxINT64_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxUINT64_CLASS	Identifies a numeric mxArray whose data is stored as the type specified in the MATLAB Primitive Types table.
mxFUNCTION_CLASS	Identifies a function handle mxArray.
mxOPAQUE_CLASS
mxOBJECT_CLASS	keep the last real item in the list
mxINDEX_CLASS
mxSPARSE_CLASS	TEMPORARY AND NASTY HACK UNTIL `mxSPARSE_CLASS` IS COMPLETELY ELIMINATED. Deprecated: OBSOLETE! DO NOT USE

Definition at line 289 of file matrix.h.

◆ mxComplexity

enum mxComplexity

Indicates whether floating-point mxArray's are real or complex.

Enumerator
mxREAL	Identifies an mxArray with no imaginary components.
mxCOMPLEX	Identifies an mxArray with imaginary components.

Definition at line 323 of file matrix.h.

Function Documentation

◆ mxAddField()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxAddField	(	mxArray *	pa,
		const char *	fieldname
	)

Add a field to a structure array.

Parameters

pa	pointer to array
fieldname

Returns: field number on success or -1 if inputs are invalid or an out of memory condition occurs.

◆ mxArrayToString()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C char* mxArrayToString ( const mxArray * pa )

Create a NULL terminated C-string from an mxArray of type mxCHAR_CLASS Supports multibyte character sets.

The resulting string must be freed with mxFree. Returns NULL on out of memory or non-character arrays.

Parameters

pa	pointer to array

◆ mxArrayToUTF8String()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C char* mxArrayToUTF8String ( mxArray const * pa )

Create a NULL terminated C-string from an mxArray of type mxCHAR_CLASS The C-style string is in UTF-8 encoding.

The resulting string must be freed with mxFree. Returns NULL on out of memory or non-character arrays.

Parameters

pa	pointer to array

◆ mxCalcSingleSubscript_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxCalcSingleSubscript_700	(	const mxArray *	pa,
		int	nsubs,
		const int *	subs
	)

Return the offset (in number of elements) from the beginning of the array to a given subscript.

Parameters

pa	pointer to array
nsubs
subs

◆ mxCalcSingleSubscript_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxCalcSingleSubscript_730	(	const mxArray *	pa,
		size_t	nsubs,
		const size_t *	subs
	)

Return the offset (in number of elements) from the beginning of the array to a given subscript.

Parameters

pa	pointer to array
nsubs
subs

◆ mxCalloc()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void* mxCalloc	(	size_t	n,
		size_t	sz
	)

clear allocated memory, notifying registered listener.

Parameters

n	number of objects
sz	size of objects

◆ mxCreateCellArray_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCellArray_700	(	int	ndim,
		const int *	dims
	)

Create an N-Dimensional cell array, with each cell initialized to NULL.

Parameters

ndim
dims

◆ mxCreateCellArray_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCellArray_730	(	size_t	ndim,
		const size_t *	dims
	)

Create an N-Dimensional cell array, with each cell initialized to NULL.

Parameters

ndim
dims

◆ mxCreateCellMatrix_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCellMatrix_700	(	int	m,
		int	n
	)

Create a 2-Dimensional cell array, with each cell initialized to NULL.

Parameters

m
n

◆ mxCreateCellMatrix_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCellMatrix_730	(	size_t	m,
		size_t	n
	)

Create a 2-Dimensional cell array, with each cell initialized to NULL.

Parameters

m
n

◆ mxCreateCharArray_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCharArray_700	(	int	ndim,
		const int *	dims
	)

Create an N-Dimensional array to hold string data; initialize all elements to 0.

Parameters

ndim
dims

◆ mxCreateCharArray_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCharArray_730	(	size_t	ndim,
		const size_t *	dims
	)

Create an N-Dimensional array to hold string data; initialize all elements to 0.

Parameters

ndim
dims

◆ mxCreateCharMatrixFromStrings_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCharMatrixFromStrings_700	(	int	m,
		const char **	str
	)

Create a string array initialized to the strings in str.

Parameters

m
str

◆ mxCreateCharMatrixFromStrings_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateCharMatrixFromStrings_730	(	size_t	m,
		const char **	str
	)

Create a string array initialized to the strings in str.

Parameters

m
str

◆ mxCreateDoubleMatrix_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateDoubleMatrix_700	(	int	m,
		int	n,
		mxComplexity	flag
	)

Create a two-dimensional array to hold double-precision floating-point data; initialize each data element to 0.

Parameters

m
n
flag

◆ mxCreateDoubleMatrix_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateDoubleMatrix_730	(	size_t	m,
		size_t	n,
		mxComplexity	flag
	)

Create a two-dimensional array to hold double-precision floating-point data; initialize each data element to 0.

Parameters

m
n
flag

◆ mxCreateDoubleScalar()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateDoubleScalar ( double value )

Create a double-precision scalar mxArray initialized to the value specified.

Parameters

value

◆ mxCreateLogicalArray_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateLogicalArray_700	(	int	ndim,
		const int *	dims
	)

Create a logical array and initialize its data elements to false.

Parameters

ndim
dims

◆ mxCreateLogicalArray_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateLogicalArray_730	(	size_t	ndim,
		const size_t *	dims
	)

Create a logical array and initialize its data elements to false.

Parameters

ndim
dims

◆ mxCreateLogicalMatrix_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateLogicalMatrix_700	(	int	m,
		int	n
	)

Create a two-dimensional array to hold logical data and initializes each data element to false.

Parameters

m
n

◆ mxCreateLogicalMatrix_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateLogicalMatrix_730	(	size_t	m,
		size_t	n
	)

Create a two-dimensional array to hold logical data and initializes each data element to false.

Parameters

m
n

◆ mxCreateLogicalScalar()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateLogicalScalar ( bool value )

Create a logical scalar mxArray having the specified value.

Parameters

value

◆ mxCreateNumericArray_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateNumericArray_700	(	int	ndim,
		const int *	dims,
		mxClassID	classid,
		mxComplexity	flag
	)

Create a numeric array and initialize all its data elements to 0.

Parameters

ndim
dims
classid
flag	Similar to mxCreateNumericMatrix, in a standalone application, out-of-memory will mean a `NULL` pointer is returned.

◆ mxCreateNumericArray_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateNumericArray_730	(	size_t	ndim,
		const size_t *	dims,
		mxClassID	classid,
		mxComplexity	flag
	)

Create a numeric array and initialize all its data elements to 0.

Parameters

ndim
dims
classid
flag	Similar to mxCreateNumericMatrix, in a standalone application, out-of-memory will mean a `NULL` pointer is returned.

◆ mxCreateNumericMatrix_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateNumericMatrix_700	(	int	m,
		int	n,
		mxClassID	classid,
		mxComplexity	flag
	)

Create a numeric matrix and initialize all its data elements to 0.

In standalone mode, out-of-memory will mean a NULL pointer is returned.

Parameters

m
n
classid
flag

◆ mxCreateNumericMatrix_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateNumericMatrix_730	(	size_t	m,
		size_t	n,
		mxClassID	classid,
		mxComplexity	flag
	)

Create a numeric matrix and initialize all its data elements to 0.

In standalone mode, out-of-memory will mean a NULL pointer is returned.

Parameters

m
n
classid
flag

◆ mxCreateSparse_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateSparse_700	(	int	m,
		int	n,
		int	nzmax,
		mxComplexity	flag
	)

Create a 2-Dimensional sparse array.

Parameters

m
n
nzmax
flag	Z = mxCreateSparse(m,n,nzmax,cmplx_flag);

An m-by-n, real or complex, sparse matrix with room for nzmax nonzeros. Use this to allocate storage for a sparse matrix.

It allocates the structure, allocates the pr, pi, ir and jc arrays, and sets all the fields, which may be changed later.

Avoids the question of malloc(0) by replacing nzmax=0 with nzmax=1. Also sets Z->pr[0] = 0.0 so that the scalar sparse(0.0) acts like 0.0.

Notice that the value of m is almost irrelevant. It is only stored in the mxSetM field of the matrix structure. It does not affect the amount of storage required by sparse matrices, or the amount of time required by sparse algorithms. Consequently, m can be "infinite". The result is a semi-infinite matrix with a finite number of columns and a finite, but unspecified, number of nonzero rows.

◆ mxCreateSparse_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateSparse_730	(	size_t	m,
		size_t	n,
		size_t	nzmax,
		mxComplexity	flag
	)

Create a 2-Dimensional sparse array.

Parameters

m
n
nzmax
flag	Z = mxCreateSparse(m,n,nzmax,cmplx_flag);

An m-by-n, real or complex, sparse matrix with room for nzmax nonzeros. Use this to allocate storage for a sparse matrix.

It allocates the structure, allocates the pr, pi, ir and jc arrays, and sets all the fields, which may be changed later.

Avoids the question of malloc(0) by replacing nzmax=0 with nzmax=1. Also sets Z->pr[0] = 0.0 so that the scalar sparse(0.0) acts like 0.0.

Notice that the value of m is almost irrelevant. It is only stored in the mxSetM field of the matrix structure. It does not affect the amount of storage required by sparse matrices, or the amount of time required by sparse algorithms. Consequently, m can be "infinite". The result is a semi-infinite matrix with a finite number of columns and a finite, but unspecified, number of nonzero rows.

◆ mxCreateSparseLogicalMatrix_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateSparseLogicalMatrix_700	(	int	m,
		int	n,
		int	nzmax
	)

Create a 2-D sparse logical array.

Parameters

m
n
nzmax

◆ mxCreateSparseLogicalMatrix_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateSparseLogicalMatrix_730	(	size_t	m,
		size_t	n,
		size_t	nzmax
	)

Create a 2-D sparse logical array.

Parameters

m
n
nzmax

◆ mxCreateString()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateString ( const char * str )

Create a 1-by-n string array initialized to NULL terminated string where n is the length of the string.

Parameters

str

◆ mxCreateStringFromNChars_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateStringFromNChars_700	(	const char *	str,
		int	n
	)

Create a 1-by-n string array initialized to str.

The supplied string is presumed to be in the local codepage encoding. The character data format in the mxArray will be UTF-16.

Parameters

str
n

◆ mxCreateStringFromNChars_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateStringFromNChars_730	(	const char *	str,
		size_t	n
	)

Create a 1-by-n string array initialized to str.

The supplied string is presumed to be in the local codepage encoding. The character data format in the mxArray will be UTF-16.

Parameters

str
n

◆ mxCreateStructArray_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateStructArray_700	(	int	ndim,
		const int *	dims,
		int	nfields,
		const char **	fieldnames
	)

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

Parameters

ndim
dims
nfields
fieldnames

◆ mxCreateStructArray_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateStructArray_730	(	size_t	ndim,
		const size_t *	dims,
		int	nfields,
		const char **	fieldnames
	)

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

Parameters

ndim
dims
nfields
fieldnames

◆ mxCreateStructMatrix_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateStructMatrix_700	(	int	m,
		int	n,
		int	nfields,
		const char **	fieldnames
	)

Create a 2-Dimensional structure array having the specified fields; initialize all values to NULL.

Parameters

m
n
nfields
fieldnames

◆ mxCreateStructMatrix_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateStructMatrix_730	(	size_t	m,
		size_t	n,
		int	nfields,
		const char **	fieldnames
	)

Create a 2-Dimensional structure array having the specified fields; initialize all values to NULL.

Parameters

m
n
nfields
fieldnames

◆ mxCreateUninitNumericArray()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateUninitNumericArray	(	size_t	ndim,
		size_t *	dims,
		mxClassID	classid,
		mxComplexity	flag
	)

Create an uninitialized numeric array.

The resulting array must be freed with mxDestroyArray.

Parameters

ndim
dims
classid
flag

◆ mxCreateUninitNumericMatrix()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxCreateUninitNumericMatrix	(	size_t	m,
		size_t	n,
		mxClassID	classid,
		mxComplexity	flag
	)

Create an uninitialized numeric matrix.

The resulting array must be freed with mxDestroyArray.

Parameters

m
n
classid
flag

◆ mxDestroyArray()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxDestroyArray ( mxArray * pa )

mxArray destructor

Parameters

pa	pointer to array

◆ mxDuplicateArray()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxDuplicateArray ( const mxArray * pa )

Make a deep copy of an array, return a pointer to the copy.

Parameters

pa	pointer to array

◆ mxFree()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxFree ( void * ptr )

free memory, notifying registered listener.

Parameters

ptr	pointer to memory to be freed

◆ mxGetCell_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetCell_700	(	const mxArray *	pa,
		int	i
	)

Get a pointer to the specified cell element.

Parameters

pa	pointer to array
i

◆ mxGetCell_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetCell_730	(	const mxArray *	pa,
		size_t	i
	)

Get a pointer to the specified cell element.

Parameters

pa	pointer to array
i

◆ mxGetChars()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxChar* mxGetChars ( const mxArray * pa )

Get string array data.

Parameters

pa	pointer to array

◆ mxGetClassID()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxClassID mxGetClassID ( const mxArray * pa )

Return the class (catergory) of data that the array holds.

Parameters

pa	pointer to array

◆ mxGetClassName()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const char* mxGetClassName ( const mxArray * pa )

Return the name of an array's class.

Parameters

pa	pointer to array

◆ mxGetData()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void* mxGetData ( const mxArray * pa )

Get pointer to data.

Parameters

pa	pointer to array

◆ mxGetDimensions_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const int* mxGetDimensions_700 ( const mxArray * pa )

Get pointer to dimension array.

Parameters

pa	pointer to array

◆ mxGetDimensions_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const size_t* mxGetDimensions_730 ( const mxArray * pa )

Get pointer to dimension array.

Parameters

pa	pointer to array

◆ mxGetElementSize()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxGetElementSize ( const mxArray * pa )

Get array data element size.

Parameters

pa	pointer to array

◆ mxGetEps()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double mxGetEps ( void )

Function for obtaining MATLAB's concept of EPS.

◆ mxGetField_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetField_700	(	const mxArray *	pa,
		int	i,
		const char *	fieldname
	)

Return a pointer to the contents of the named field for the ith element (zero based).

Returns NULL on no such field or if the field itself is NULL

Parameters

pa	pointer to array
i
fieldname

◆ mxGetField_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetField_730	(	const mxArray *	pa,
		size_t	i,
		const char *	fieldname
	)

Return a pointer to the contents of the named field for the ith element (zero based).

Returns NULL on no such field or if the field itself is NULL

Parameters

pa	pointer to array
i
fieldname

◆ mxGetFieldByNumber_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetFieldByNumber_700	(	const mxArray *	pa,
		int	i,
		int	fieldnum
	)

Return a pointer to the contents of the named field for the ith element (zero based).

Parameters

pa	pointer to array
i
fieldnum

◆ mxGetFieldByNumber_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetFieldByNumber_730	(	const mxArray *	pa,
		size_t	i,
		int	fieldnum
	)

Return a pointer to the contents of the named field for the ith element (zero based).

Parameters

pa	pointer to array
i
fieldnum

◆ mxGetFieldNameByNumber()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C const char* mxGetFieldNameByNumber	(	const mxArray *	pa,
		int	n
	)

Return pointer to the nth field name.

Parameters

pa	pointer to array
n

◆ mxGetFieldNumber()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetFieldNumber	(	const mxArray *	pa,
		const char *	name
	)

Get the index to the named field.

Parameters

pa	pointer to array
name

◆ mxGetImagData()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void* mxGetImagData ( const mxArray * pa )

Get imaginary data pointer for numeric array.

Parameters

pa	pointer to array

◆ mxGetInf()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double mxGetInf ( void )

Function for obtaining MATLAB's concept of INF (Used in MEX-File callback).

◆ mxGetIr_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int* mxGetIr_700 ( const mxArray * pa )

Get row dimension.

Parameters

pa	pointer to array

◆ mxGetIr_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t* mxGetIr_730 ( const mxArray * pa )

Get row data pointer for sparse numeric array.

Parameters

pa	pointer to array

◆ mxGetJc_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int* mxGetJc_700 ( const mxArray * pa )

Get column data pointer for sparse numeric array.

Parameters

pa	pointer to array

◆ mxGetJc_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t* mxGetJc_730 ( const mxArray * pa )

Get column data pointer for sparse numeric array.

Parameters

pa	pointer to array

◆ mxGetLogicals()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxLogical* mxGetLogicals ( const mxArray * pa )

Get a properly typed pointer to the elements of a logical array.

Parameters

pa	pointer to array

◆ mxGetM()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxGetM ( const mxArray * pa )

Get row dimension.

Parameters

pa	pointer to array

◆ mxGetN()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxGetN ( const mxArray * pa )

Get column dimension.

Parameters

pa	pointer to array

◆ mxGetNaN()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double mxGetNaN ( void )

Function for obtaining MATLAB's concept of NaN (Used in MEX-File callback).

◆ mxGetNChars_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxGetNChars_700	(	const mxArray *	pa,
		char *	buf,
		int	nChars
	)

Copies characters from a MATLAB array to a char array This function will attempt to perform null termination if it is possible.

Parameters

pa	pointer to array
buf
nChars	is the number of bytes in the output buffer

◆ mxGetNChars_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxGetNChars_730	(	const mxArray *	pa,
		char *	buf,
		size_t	nChars
	)

Copies characters from a MATLAB array to a char array This function will attempt to perform null termination if it is possible.

Parameters

pa	pointer to array
buf
nChars	is the number of bytes in the output buffer

◆ mxGetNumberOfDimensions_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetNumberOfDimensions_700 ( const mxArray * pa )

Get number of dimensions in array.

Parameters

pa	pointer to array

◆ mxGetNumberOfDimensions_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxGetNumberOfDimensions_730 ( const mxArray * pa )

Get number of dimensions in array.

Parameters

pa	pointer to array

◆ mxGetNumberOfElements()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxGetNumberOfElements ( const mxArray * pa )

Get number of elements in array.

Parameters

pa	pointer to array

◆ mxGetNumberOfFields()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetNumberOfFields ( const mxArray * pa )

Get number of structure fields in array.

Returns: 0 if mxArray is non-struct.

Parameters

pa	pointer to array

◆ mxGetNzmax_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetNzmax_700 ( const mxArray * pa )

Get maximum nonzero elements for sparse numeric array.

Parameters

pa	pointer to array

◆ mxGetNzmax_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C size_t mxGetNzmax_730 ( const mxArray * pa )

Get maximum nonzero elements for sparse numeric array.

Parameters

pa	pointer to array

◆ mxGetPi()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double* mxGetPi ( const mxArray * pa )

Get imaginary data pointer for numeric array.

Parameters

pa	pointer to array

◆ mxGetPr()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double* mxGetPr ( const mxArray * pa )

Get real data pointer for numeric array.

Parameters

pa	pointer to array

◆ mxGetProperty_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetProperty_700	(	const mxArray *	pa,
		const int	i,
		const char *	propname
	)

mxGetProperty returns the value of a property for a given object and index.

The property must be public.

Parameters

pa	pointer to array
i
propname	If the given property name doesn't exist, isn't public, or the object isn't the right type, then mxGetProperty returns `NULL`.

◆ mxGetProperty_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C mxArray* mxGetProperty_730	(	const mxArray *	pa,
		const size_t	i,
		const char *	propname
	)

mxGetProperty returns the value of a property for a given object and index.

The property must be public.

Parameters

pa	pointer to array
i
propname	If the given property name doesn't exist, isn't public, or the object isn't the right type, then mxGetProperty returns `NULL`.

◆ mxGetScalar()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C double mxGetScalar ( const mxArray * pa )

Get the real component of the specified array's first data element.

Parameters

pa	pointer to array

◆ mxGetString_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetString_700	(	const mxArray *	pa,
		char *	buf,
		int	buflen
	)

Converts a string array to a C-style string.

The C-style string is in the local codepage encoding. If the conversion for the entire Unicode string cannot fit into the supplied character buffer, then the conversion includes the last whole codepoint that will fit into the buffer. The string is thus truncated at the greatest possible whole codepoint and does not split code- points.

Parameters

pa	pointer to array
buf
buflen

◆ mxGetString_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetString_730	(	const mxArray *	pa,
		char *	buf,
		size_t	buflen
	)

Converts a string array to a C-style string.

The C-style string is in the local codepage encoding. If the conversion for the entire Unicode string cannot fit into the supplied character buffer, then the conversion includes the last whole codepoint that will fit into the buffer. The string is thus truncated at the greatest possible whole codepoint and does not split code- points.

Parameters

pa	pointer to array
buf
buflen

◆ mxGetUserBits()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxGetUserBits ( const mxArray * pa )

Get 8 bits of user data stored in the mxArray header.

NOTE: This state of these bits are not guaranteed to be preserved after API function calls.

Parameters

pa	pointer to array

◆ mxIsCell()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsCell ( const mxArray * pa )

Determine whether the given array is a cell array.

Parameters

pa	pointer to array

◆ mxIsChar()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsChar ( const mxArray * pa )

Determine whether the given array contains character data.

Parameters

pa	pointer to array

◆ mxIsClass()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsClass	(	const mxArray *	pa,
		const char *	name
	)

Determine whether an array is a member of the specified class.

Parameters

pa	pointer to array
name

◆ mxIsComplex()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsComplex ( const mxArray * pa )

Determine whether the given array contains complex data.

Parameters

pa	pointer to array

◆ mxIsDouble()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsDouble ( const mxArray * pa )

Determine whether the specified array represents its data as double-precision floating-point numbers.

Parameters

pa	pointer to array

◆ mxIsEmpty()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsEmpty ( const mxArray * pa )

Is array empty.

Parameters

pa	pointer to array

◆ mxIsFinite()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsFinite ( double x )

Inform Watcom compilers that scalar double return values will be in the FPU register.

test for finiteness in a machine-independent manner

Parameters

x	value to test

◆ mxIsFromGlobalWS()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsFromGlobalWS ( const mxArray * pa )

Inform Watcom compilers that scalar double return values will be in the FPU register.

Is the isFromGlobalWorkspace bit set?

Parameters

pa	pointer to array

◆ mxIsFunctionHandle()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsFunctionHandle ( const mxArray * pa )

Returns true if specified array is a function object.

◆ mxIsInf()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsInf ( double x )

test for infinity in a machine-independent manner

Parameters

x	value to test

◆ mxIsInt16()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsInt16 ( const mxArray * pa )

Determine whether the specified array represents its data as signed 16-bit integers.

Parameters

pa	pointer to array

◆ mxIsInt32()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsInt32 ( const mxArray * pa )

Determine whether the specified array represents its data as signed 32-bit integers.

Parameters

pa	pointer to array

◆ mxIsInt64()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsInt64 ( const mxArray * pa )

Determine whether the specified array represents its data as signed 64-bit integers.

Parameters

pa	pointer to array

◆ mxIsInt8()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsInt8 ( const mxArray * pa )

Determine whether the specified array represents its data as signed 8-bit integers.

Parameters

pa	pointer to array

◆ mxIsLogical()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsLogical ( const mxArray * pa )

Determine whether the given array's logical flag is on.

Parameters

pa	pointer to array

◆ mxIsLogicalScalar()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsLogicalScalar ( const mxArray * pa )

Returns true if we have a valid logical scalar mxArray.

Parameters

pa	pointer to array

◆ mxIsLogicalScalarTrue()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsLogicalScalarTrue ( const mxArray * pa )

Returns true if the logical scalar value is true.

Parameters

pa	pointer to array

◆ mxIsNaN()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsNaN ( double x )

test for NaN in a machine-independent manner

Parameters

x	value to test

◆ mxIsNumeric()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsNumeric ( const mxArray * pa )

Determine whether the specified array contains numeric (as opposed to cell or struct) data.

Parameters

pa	pointer to array

◆ mxIsObject()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsObject ( const mxArray * pa )

Is array user defined MATLAB v5 object.

Deprecated:: This function is deprecated and is preserved only for backward compatibility. DO NOT USE if possible.

Parameters

pa	pointer to array

◆ mxIsOpaque()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsOpaque ( const mxArray * pa )

Determine whether the given array is an opaque array.

Parameters

pa	pointer to array

◆ mxIsScalar()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsScalar ( const mxArray * pa )

Determine whether the given array's scalar flag is on.

Parameters

pa	pointer to array

◆ mxIsSingle()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsSingle ( const mxArray * pa )

Determine whether the specified array represents its data as single-precision floating-point numbers.

Parameters

pa	pointer to array

◆ mxIsSparse()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsSparse ( const mxArray * pa )

Determine whether the given array is a sparse (as opposed to full).

Parameters

pa	pointer to array

◆ mxIsStruct()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsStruct ( const mxArray * pa )

Determine whether the given array is a structure array.

Parameters

pa	pointer to array

◆ mxIsUint16()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsUint16 ( const mxArray * pa )

Determine whether the specified array represents its data as unsigned 16-bit integers.

Parameters

pa	pointer to array

◆ mxIsUint32()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsUint32 ( const mxArray * pa )

Determine whether the specified array represents its data as unsigned 32-bit integers.

Parameters

pa	pointer to array

◆ mxIsUint64()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsUint64 ( const mxArray * pa )

Determine whether the specified array represents its data as unsigned 64-bit integers.

Parameters

pa	pointer to array

◆ mxIsUint8()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C bool mxIsUint8 ( const mxArray * pa )

Determine whether the specified array represents its data as unsigned 8-bit integers.

Parameters

pa	pointer to array

◆ mxMalloc()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void* mxMalloc ( size_t n )

allocate memory, notifying registered listener

Parameters

n	number of bytes

◆ mxRealloc()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void* mxRealloc	(	void *	ptr,
		size_t	sz
	)

reallocate memory, notifying registered listener.

Parameters

ptr	pointer to memory
sz	new size

◆ mxRemoveField()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxRemoveField	(	mxArray *	pa,
		int	field
	)

Remove a field from a structure array.

Does nothing if no such field exists. Does not destroy the field itself.

Parameters

pa	pointer to array
field

◆ mxSetCell_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetCell_700	(	mxArray *	pa,
		int	i,
		mxArray *	value
	)

Set an element in a cell array to the specified value.

Parameters

pa	pointer to array
i
value

◆ mxSetCell_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetCell_730	(	mxArray *	pa,
		size_t	i,
		mxArray *	value
	)

Set an element in a cell array to the specified value.

Parameters

pa	pointer to array
i
value

◆ mxSetClassName()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxSetClassName	(	mxArray *	pa,
		const char *	classname
	)

Set classname of an unvalidated object array.

It is illegal to call this function on a previously validated object array.

Parameters

pa	pointer to array
classname

Returns: 0 for success, 1 for failure.

◆ mxSetData()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetData	(	mxArray *	pa,
		void *	newdata
	)

Set pointer to data.

Parameters

pa	pointer to array
newdata	pointer to data

◆ mxSetDimensions_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxSetDimensions_700	(	mxArray *	pa,
		const int *	pdims,
		int	ndims
	)

Set dimension array and number of dimensions.

Parameters

pa	pointer to array
pdims
ndims

Returns: 0 on success and 1 if there was not enough memory available to reallocate the dimensions array.

◆ mxSetDimensions_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C int mxSetDimensions_730	(	mxArray *	pa,
		const size_t *	pdims,
		size_t	ndims
	)

Set dimension array and number of dimensions.

Parameters

pa	pointer to array
pdims
ndims

Returns: 0 on success and 1 if there was not enough memory available to reallocate the dimensions array.

◆ mxSetField_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetField_700	(	mxArray *	pa,
		int	i,
		const char *	fieldname,
		mxArray *	value
	)

Sets the contents of the named field for the ith element (zero based).

The input value is stored in the input array pa - no copy is made.

Parameters

pa	pointer to array
i
fieldname
value

◆ mxSetField_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetField_730	(	mxArray *	pa,
		size_t	i,
		const char *	fieldname,
		mxArray *	value
	)

Sets the contents of the named field for the ith element (zero based).

The input value is stored in the input array pa - no copy is made.

Parameters

pa	pointer to array
i
fieldname
value

◆ mxSetFieldByNumber_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetFieldByNumber_700	(	mxArray *	pa,
		int	i,
		int	fieldnum,
		mxArray *	value
	)

Sets pa[i][fieldnum]=value.

Parameters

pa	pointer to array
i
fieldnum
value

◆ mxSetFieldByNumber_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetFieldByNumber_730	(	mxArray *	pa,
		size_t	i,
		int	fieldnum,
		mxArray *	value
	)

Sets pa[i][fieldnum]=value.

Parameters

pa	pointer to array
i
fieldnum
value

◆ mxSetFromGlobalWS()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetFromGlobalWS	(	mxArray *	pa,
		bool	global
	)

Set the isFromGlobalWorkspace bit.

Parameters

pa	pointer to array
global

◆ mxSetImagData()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetImagData	(	mxArray *	pa,
		void *	newdata
	)

Set imaginary data pointer for numeric array.

Parameters

pa	pointer to array
newdata	imaginary data array pointer

◆ mxSetIr_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetIr_700	(	mxArray *	pa,
		int *	newir
	)

Set row data pointer for numeric array.

Parameters

pa	pointer to array
newir

◆ mxSetIr_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetIr_730	(	mxArray *	pa,
		size_t *	newir
	)

Set row data pointer for numeric array.

Parameters

pa	pointer to array
newir

◆ mxSetJc_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetJc_700	(	mxArray *	pa,
		int *	newjc
	)

Set column data pointer for numeric array.

Parameters

pa	pointer to array
newjc

◆ mxSetJc_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetJc_730	(	mxArray *	pa,
		size_t *	newjc
	)

Set column data pointer for numeric array.

Parameters

pa	pointer to array
newjc

◆ mxSetM_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetM_700	(	mxArray *	pa,
		int	m
	)

Set row dimension.

Parameters

pa	pointer to array
m

◆ mxSetM_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetM_730	(	mxArray *	pa,
		size_t	m
	)

Set row dimension.

Parameters

pa	pointer to array
m

◆ mxSetN_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetN_700	(	mxArray *	pa,
		int	n
	)

Set column dimension.

Parameters

pa	pointer to array
n

◆ mxSetN_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetN_730	(	mxArray *	pa,
		size_t	n
	)

Set column dimension.

Parameters

pa	pointer to array
n

◆ mxSetNzmax_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetNzmax_700	(	mxArray *	pa,
		int	nzmax
	)

Set maximum nonzero elements for numeric array.

Parameters

pa	pointer to array
nzmax

◆ mxSetNzmax_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetNzmax_730	(	mxArray *	pa,
		size_t	nzmax
	)

Set maximum nonzero elements for numeric array.

Parameters

pa	pointer to array
nzmax

◆ mxSetPi()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetPi	(	mxArray *	pa,
		double *	pi
	)

Set imaginary data pointer for numeric array.

Parameters

pa	pointer to array
pi	imaginary data array pointer

◆ mxSetPr()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetPr	(	mxArray *	pa,
		double *	pr
	)

Set real data pointer for numeric array.

Parameters

pa	pointer to array
pr	real data array pointer

◆ mxSetProperty_700()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetProperty_700	(	mxArray *	pa,
		int	i,
		const char *	propname,
		const mxArray *	value
	)

mxSetProperty sets the value of a property for a given object and index.

The property must be public.

Parameters

pa	pointer to array
i
propname
value

◆ mxSetProperty_730()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetProperty_730	(	mxArray *	pa,
		size_t	i,
		const char *	propname,
		const mxArray *	value
	)

mxSetProperty sets the value of a property for a given object and index.

The property must be public.

Parameters

pa	pointer to array
i
propname
value

◆ mxSetUserBits()

LIBMMWMATRIX_PUBLISHED_API_EXTERN_C void mxSetUserBits	(	mxArray *	pa,
		int	value
	)

Set 8 bits of user data stored in the mxArray header.

NOTE: This state of these bits are not guaranteed to be preserved after API function calls.

Parameters

pa	pointer to array
value	8-bit user value to store

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

◆ LIBMMWMATRIX_PUBLISHED_API

◆ LIBMMWMATRIX_PUBLISHED_API_EXTERN_C

◆ MATHWORKS_MATRIX_DETAIL_PUBLISHED_FWD_DECLS_HPP

◆ MATRIX_DLL_EXPORT_SYM

◆ MATRIX_DLL_IMPORT_SYM

◆ matrix_h

◆ MX_API_VER

◆ mxAssert

◆ mxassert_h

◆ mxAssertS

◆ mxCalcSingleSubscript

◆ mxCreateCellArray

◆ mxCreateCellMatrix

◆ mxCreateCharArray

◆ mxCreateCharMatrixFromStrings

◆ mxCreateDoubleMatrix

◆ mxCreateLogicalArray

◆ mxCreateLogicalMatrix

◆ mxCreateNumericArray

◆ mxCreateNumericMatrix

◆ mxCreateSparse

◆ mxCreateSparseLogicalMatrix

◆ mxCreateStringFromNChars

◆ mxCreateStructArray

◆ mxCreateStructMatrix

◆ mxGetCell

◆ mxGetDimensions

◆ mxGetDimensions_fcn

◆ mxGetField

◆ mxGetFieldByNumber

◆ mxGetIr

◆ mxGetJc

◆ mxGetNChars

◆ mxGetNumberOfDimensions

◆ mxGetNzmax

◆ mxGetProperty

◆ mxGetString

◆ mxMAXNAM

◆ mxSetCell

◆ mxSetDimensions

◆ mxSetField

◆ mxSetFieldByNumber

◆ mxSetIr

◆ mxSetJc

◆ mxSetM

◆ mxSetN

◆ mxSetNzmax

◆ mxSetProperty

Typedef Documentation

◆ mxArray

◆ mxChar

◆ mxFunctionPtr

◆ mxLogical

Enumeration Type Documentation

◆ mxClassID

◆ mxComplexity

Function Documentation

◆ mxAddField()

◆ mxArrayToString()

◆ mxArrayToUTF8String()

◆ mxCalcSingleSubscript_700()

◆ mxCalcSingleSubscript_730()

◆ mxCalloc()

◆ mxCreateCellArray_700()

◆ mxCreateCellArray_730()

◆ mxCreateCellMatrix_700()

◆ mxCreateCellMatrix_730()

◆ mxCreateCharArray_700()

◆ mxCreateCharArray_730()

◆ mxCreateCharMatrixFromStrings_700()

◆ mxCreateCharMatrixFromStrings_730()

◆ mxCreateDoubleMatrix_700()

◆ mxCreateDoubleMatrix_730()

◆ mxCreateDoubleScalar()

◆ mxCreateLogicalArray_700()