GNU Octave  3.8.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Macros | Functions
mexproto.h File Reference
#include <stdlib.h>
#include "mxarray.h"
Include dependency graph for mexproto.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define MXARRAY_TYPEDEFS_ONLY
#define mxAssert(expr, msg)
#define mxAssertS(expr, msg)
#define OCTINTERP_API

Functions

int mexAtExit (void(*f)(void))
int mexCallMATLAB (int nargout, mxArray *argout[], int nargin, mxArray *argin[], const char *fname)
void mexErrMsgIdAndTxt (const char *id, const char *s,...)
void mexErrMsgTxt (const char *s)
int mexEvalString (const char *s)
const charmexFunctionName (void)
const mxArraymexGet (double handle, const char *property)
mxArraymexGetVariable (const char *space, const char *name)
const mxArraymexGetVariablePtr (const char *space, const char *name)
int mexIsGlobal (const mxArray *ptr)
int mexIsLocked (void)
void mexLock (void)
void mexMakeArrayPersistent (mxArray *ptr)
void mexMakeMemoryPersistent (void *ptr)
int mexPrintf (const char *fmt,...)
int mexPutVariable (const char *space, const char *name, const mxArray *ptr)
int mexSet (double handle, const char *property, mxArray *val)
void mexSetTrapFlag (int flag)
void mexUnlock (void)
void mexWarnMsgIdAndTxt (const char *id, const char *s,...)
void mexWarnMsgTxt (const char *s)
int mxAddField (mxArray *ptr, const char *key)
charmxArrayToString (const mxArray *ptr)
mwIndex mxCalcSingleSubscript (const mxArray *ptr, mwSize nsubs, mwIndex *subs)
voidmxCalloc (size_t n, size_t size)
mxArraymxCreateCellArray (mwSize ndims, const mwSize *dims)
mxArraymxCreateCellMatrix (mwSize m, mwSize n)
mxArraymxCreateCharArray (mwSize ndims, const mwSize *dims)
mxArraymxCreateCharMatrixFromStrings (mwSize m, const char **str)
mxArraymxCreateDoubleMatrix (mwSize nr, mwSize nc, mxComplexity flag)
mxArraymxCreateDoubleScalar (double val)
mxArraymxCreateLogicalArray (mwSize ndims, const mwSize *dims)
mxArraymxCreateLogicalMatrix (mwSize m, mwSize n)
mxArraymxCreateLogicalScalar (mxLogical val)
mxArraymxCreateNumericArray (mwSize ndims, const mwSize *dims, mxClassID class_id, mxComplexity flag)
mxArraymxCreateNumericMatrix (mwSize m, mwSize n, mxClassID class_id, mxComplexity flag)
mxArraymxCreateSparse (mwSize m, mwSize n, mwSize nzmax, mxComplexity flag)
mxArraymxCreateSparseLogicalMatrix (mwSize m, mwSize n, mwSize nzmax)
mxArraymxCreateString (const char *str)
mxArraymxCreateStructArray (mwSize ndims, const mwSize *dims, int num_keys, const char **keys)
mxArraymxCreateStructMatrix (mwSize rows, mwSize cols, int num_keys, const char **keys)
void mxDestroyArray (mxArray *v)
mxArraymxDuplicateArray (const mxArray *v)
void mxFree (void *ptr)
mxArraymxGetCell (const mxArray *ptr, mwIndex idx)
mxCharmxGetChars (const mxArray *ptr)
mxClassID mxGetClassID (const mxArray *ptr)
const charmxGetClassName (const mxArray *ptr)
voidmxGetData (const mxArray *ptr)
mwSizemxGetDimensions (const mxArray *ptr)
size_t mxGetElementSize (const mxArray *ptr)
double mxGetEps (void)
mxArraymxGetField (const mxArray *ptr, mwIndex index, const char *key)
mxArraymxGetFieldByNumber (const mxArray *ptr, mwIndex index, int key_num)
const charmxGetFieldNameByNumber (const mxArray *ptr, int key_num)
int mxGetFieldNumber (const mxArray *ptr, const char *key)
voidmxGetImagData (const mxArray *ptr)
double mxGetInf (void)
mwIndexmxGetIr (const mxArray *ptr)
mwIndexmxGetJc (const mxArray *ptr)
mxLogicalmxGetLogicals (const mxArray *ptr)
size_t mxGetM (const mxArray *ptr)
size_t mxGetN (const mxArray *ptr)
double mxGetNaN (void)
mwSize mxGetNumberOfDimensions (const mxArray *ptr)
size_t mxGetNumberOfElements (const mxArray *ptr)
int mxGetNumberOfFields (const mxArray *ptr)
mwSize mxGetNzmax (const mxArray *ptr)
doublemxGetPi (const mxArray *ptr)
doublemxGetPr (const mxArray *ptr)
double mxGetScalar (const mxArray *ptr)
int mxGetString (const mxArray *ptr, char *buf, mwSize buflen)
int mxIsCell (const mxArray *ptr)
int mxIsChar (const mxArray *ptr)
int mxIsClass (const mxArray *ptr, const char *name)
int mxIsComplex (const mxArray *ptr)
int mxIsDouble (const mxArray *ptr)
int mxIsEmpty (const mxArray *ptr)
int mxIsFinite (double v)
int mxIsFromGlobalWS (const mxArray *ptr)
int mxIsFunctionHandle (const mxArray *ptr)
int mxIsInf (double v)
int mxIsInt16 (const mxArray *ptr)
int mxIsInt32 (const mxArray *ptr)
int mxIsInt64 (const mxArray *ptr)
int mxIsInt8 (const mxArray *ptr)
int mxIsLogical (const mxArray *ptr)
int mxIsLogicalScalar (const mxArray *ptr)
int mxIsLogicalScalarTrue (const mxArray *ptr)
int mxIsNaN (double v)
int mxIsNumeric (const mxArray *ptr)
int mxIsSingle (const mxArray *ptr)
int mxIsSparse (const mxArray *ptr)
int mxIsStruct (const mxArray *ptr)
int mxIsUint16 (const mxArray *ptr)
int mxIsUint32 (const mxArray *ptr)
int mxIsUint64 (const mxArray *ptr)
int mxIsUint8 (const mxArray *ptr)
voidmxMalloc (size_t n)
voidmxRealloc (void *ptr, size_t size)
void mxRemoveField (mxArray *ptr, int key_num)
void mxSetCell (mxArray *ptr, mwIndex idx, mxArray *val)
void mxSetClassName (mxArray *ptr, const char *name)
void mxSetData (mxArray *ptr, void *data)
void mxSetDimensions (mxArray *ptr, const mwSize *dims, mwSize ndims)
void mxSetField (mxArray *ptr, mwIndex index, const char *key, mxArray *val)
void mxSetFieldByNumber (mxArray *ptr, mwIndex index, int key_num, mxArray *val)
void mxSetImagData (mxArray *ptr, void *pi)
void mxSetIr (mxArray *ptr, mwIndex *ir)
void mxSetJc (mxArray *ptr, mwIndex *jc)
void mxSetM (mxArray *ptr, mwSize M)
void mxSetN (mxArray *ptr, mwSize N)
void mxSetNzmax (mxArray *ptr, mwSize nzmax)
void mxSetPi (mxArray *ptr, double *pi)
void mxSetPr (mxArray *ptr, double *pr)

Macro Definition Documentation

#define MXARRAY_TYPEDEFS_ONLY

Definition at line 70 of file mexproto.h.

#define mxAssert (   expr,
  msg 
)

Definition at line 300 of file mexproto.h.

#define mxAssertS (   expr,
  msg 
)

Definition at line 301 of file mexproto.h.

#define OCTINTERP_API

Definition at line 66 of file mexproto.h.

Function Documentation

int mexAtExit ( void(*)(void f)

Definition at line 3365 of file mex.cc.

References octave_mex_function::atexit(), mex::current_mex_function(), and f.

int mexCallMATLAB ( int  nargout,
mxArray argout[],
int  nargin,
mxArray argin[],
const char fname 
)
void mexErrMsgIdAndTxt ( const char id,
const char s,
  ... 
)

Definition at line 3188 of file mex.cc.

References mex::abort(), error(), mexFunctionName(), OCTAVE_LOCAL_BUFFER, and verror_with_id().

void mexErrMsgTxt ( const char s)

Definition at line 3173 of file mex.cc.

References mex::abort(), error(), and mexFunctionName().

Referenced by mexGetVariable(), and mexPutVariable().

int mexEvalString ( const char s)

Definition at line 3152 of file mex.cc.

References error_state, and eval_string().

const char* mexFunctionName ( void  )
const mxArray* mexGet ( double  handle,
const char property 
)
mxArray* mexGetVariable ( const char space,
const char name 
)
const mxArray* mexGetVariablePtr ( const char space,
const char name 
)

Definition at line 3297 of file mex.cc.

References mexGetVariable().

int mexIsGlobal ( const mxArray ptr)

Definition at line 3391 of file mex.cc.

References mxIsFromGlobalWS().

int mexIsLocked ( void  )

Definition at line 3397 of file mex.cc.

References mexFunctionName(), and mislocked().

void mexLock ( void  )

Definition at line 3414 of file mex.cc.

References mexFunctionName(), and mlock().

void mexMakeArrayPersistent ( mxArray ptr)

Definition at line 3353 of file mex.cc.

References maybe_unmark_array().

void mexMakeMemoryPersistent ( void ptr)

Definition at line 3359 of file mex.cc.

References maybe_unmark().

int mexPrintf ( const char fmt,
  ... 
)

Definition at line 3237 of file mex.cc.

References octave_stdout, and octave_vformat().

int mexPutVariable ( const char space,
const char name,
const mxArray ptr 
)
int mexSet ( double  handle,
const char property,
mxArray val 
)

Definition at line 3430 of file mex.cc.

References mxArray::as_octave_value(), and set_property_in_handle().

void mexSetTrapFlag ( int  flag)

Definition at line 3145 of file mex.cc.

References mex::trap_feval_error.

void mexUnlock ( void  )

Definition at line 3439 of file mex.cc.

References mexFunctionName(), and munlock().

void mexWarnMsgIdAndTxt ( const char id,
const char s,
  ... 
)

Definition at line 3218 of file mex.cc.

References mexFunctionName(), OCTAVE_LOCAL_BUFFER, and vwarning_with_id().

void mexWarnMsgTxt ( const char s)

Definition at line 3212 of file mex.cc.

References warning().

int mxAddField ( mxArray ptr,
const char key 
)

Definition at line 2916 of file mex.cc.

References mxArray::add_field().

char* mxArrayToString ( const mxArray ptr)

Definition at line 2978 of file mex.cc.

References mxArray::array_to_string().

mwIndex mxCalcSingleSubscript ( const mxArray ptr,
mwSize  nsubs,
mwIndex subs 
)

Definition at line 2984 of file mex.cc.

References mxArray::calc_single_subscript().

void* mxCalloc ( size_t  n,
size_t  size 
)

Definition at line 2432 of file mex.cc.

References mex::calloc().

mxArray* mxCreateCellArray ( mwSize  ndims,
const mwSize dims 
)

Definition at line 2467 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateCellMatrix ( mwSize  m,
mwSize  n 
)

Definition at line 2473 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateCharArray ( mwSize  ndims,
const mwSize dims 
)

Definition at line 2479 of file mex.cc.

References maybe_mark_array(), and mxCHAR_CLASS.

mxArray* mxCreateCharMatrixFromStrings ( mwSize  m,
const char **  str 
)

Definition at line 2485 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateDoubleMatrix ( mwSize  nr,
mwSize  nc,
mxComplexity  flag 
)

Definition at line 2491 of file mex.cc.

References maybe_mark_array(), and mxDOUBLE_CLASS.

mxArray* mxCreateDoubleScalar ( double  val)

Definition at line 2497 of file mex.cc.

References maybe_mark_array(), and mxDOUBLE_CLASS.

mxArray* mxCreateLogicalArray ( mwSize  ndims,
const mwSize dims 
)

Definition at line 2503 of file mex.cc.

References maybe_mark_array(), and mxLOGICAL_CLASS.

mxArray* mxCreateLogicalMatrix ( mwSize  m,
mwSize  n 
)

Definition at line 2509 of file mex.cc.

References maybe_mark_array(), and mxLOGICAL_CLASS.

mxArray* mxCreateLogicalScalar ( mxLogical  val)

Definition at line 2515 of file mex.cc.

References maybe_mark_array(), and mxLOGICAL_CLASS.

mxArray* mxCreateNumericArray ( mwSize  ndims,
const mwSize dims,
mxClassID  class_id,
mxComplexity  flag 
)

Definition at line 2521 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateNumericMatrix ( mwSize  m,
mwSize  n,
mxClassID  class_id,
mxComplexity  flag 
)

Definition at line 2528 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateSparse ( mwSize  m,
mwSize  n,
mwSize  nzmax,
mxComplexity  flag 
)

Definition at line 2535 of file mex.cc.

References maybe_mark_array(), and mxDOUBLE_CLASS.

mxArray* mxCreateSparseLogicalMatrix ( mwSize  m,
mwSize  n,
mwSize  nzmax 
)

Definition at line 2541 of file mex.cc.

References maybe_mark_array(), and mxLOGICAL_CLASS.

mxArray* mxCreateString ( const char str)

Definition at line 2547 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateStructArray ( mwSize  ndims,
const mwSize dims,
int  num_keys,
const char **  keys 
)

Definition at line 2553 of file mex.cc.

References maybe_mark_array().

mxArray* mxCreateStructMatrix ( mwSize  rows,
mwSize  cols,
int  num_keys,
const char **  keys 
)

Definition at line 2560 of file mex.cc.

References maybe_mark_array().

void mxDestroyArray ( mxArray v)

Definition at line 2574 of file mex.cc.

References mex::free_value().

mxArray* mxDuplicateArray ( const mxArray v)

Definition at line 2567 of file mex.cc.

References mxArray::dup(), and maybe_mark_array().

void mxFree ( void ptr)
mxArray* mxGetCell ( const mxArray ptr,
mwIndex  idx 
)

Definition at line 2866 of file mex.cc.

References mxArray::get_cell().

mxChar* mxGetChars ( const mxArray ptr)

Definition at line 2797 of file mex.cc.

References mxArray::get_data().

mxClassID mxGetClassID ( const mxArray ptr)

Definition at line 2847 of file mex.cc.

References mxArray::get_class_id().

const char* mxGetClassName ( const mxArray ptr)

Definition at line 2853 of file mex.cc.

References mxArray::get_class_name().

void* mxGetData ( const mxArray ptr)

Definition at line 2809 of file mex.cc.

References mxArray::get_data().

mwSize* mxGetDimensions ( const mxArray ptr)

Definition at line 2739 of file mex.cc.

References mxArray::get_dimensions().

size_t mxGetElementSize ( const mxArray ptr)

Definition at line 2990 of file mex.cc.

References mxArray::get_element_size().

double mxGetEps ( void  )

Definition at line 2413 of file mex.cc.

mxArray* mxGetField ( const mxArray ptr,
mwIndex  index,
const char key 
)

Definition at line 2928 of file mex.cc.

References mxGetFieldByNumber(), and mxGetFieldNumber().

mxArray* mxGetFieldByNumber ( const mxArray ptr,
mwIndex  index,
int  key_num 
)

Definition at line 2935 of file mex.cc.

References mxArray::get_field_by_number().

Referenced by mxGetField().

const char* mxGetFieldNameByNumber ( const mxArray ptr,
int  key_num 
)

Definition at line 2960 of file mex.cc.

References mxArray::get_field_name_by_number().

int mxGetFieldNumber ( const mxArray ptr,
const char key 
)

Definition at line 2966 of file mex.cc.

References mxArray::get_field_number().

Referenced by mxGetField(), and mxSetField().

void* mxGetImagData ( const mxArray ptr)

Definition at line 2815 of file mex.cc.

References mxArray::get_imag_data().

double mxGetInf ( void  )

Definition at line 2419 of file mex.cc.

References lo_ieee_inf_value().

mwIndex* mxGetIr ( const mxArray ptr)

Definition at line 2879 of file mex.cc.

References mxArray::get_ir().

mwIndex* mxGetJc ( const mxArray ptr)

Definition at line 2885 of file mex.cc.

References mxArray::get_jc().

mxLogical* mxGetLogicals ( const mxArray ptr)

Definition at line 2803 of file mex.cc.

References mxArray::get_data().

size_t mxGetM ( const mxArray ptr)

Definition at line 2727 of file mex.cc.

References mxArray::get_m().

size_t mxGetN ( const mxArray ptr)

Definition at line 2733 of file mex.cc.

References mxArray::get_n().

double mxGetNaN ( void  )

Definition at line 2425 of file mex.cc.

References lo_ieee_nan_value().

mwSize mxGetNumberOfDimensions ( const mxArray ptr)

Definition at line 2745 of file mex.cc.

References mxArray::get_number_of_dimensions().

size_t mxGetNumberOfElements ( const mxArray ptr)

Definition at line 2751 of file mex.cc.

References mxArray::get_number_of_elements().

int mxGetNumberOfFields ( const mxArray ptr)

Definition at line 2954 of file mex.cc.

References mxArray::get_number_of_fields().

mwSize mxGetNzmax ( const mxArray ptr)

Definition at line 2891 of file mex.cc.

References mxArray::get_nzmax().

double* mxGetPi ( const mxArray ptr)

Definition at line 2785 of file mex.cc.

References mxArray::get_imag_data().

double* mxGetPr ( const mxArray ptr)

Definition at line 2779 of file mex.cc.

References mxArray::get_data().

double mxGetScalar ( const mxArray ptr)

Definition at line 2791 of file mex.cc.

References mxArray::get_scalar().

int mxGetString ( const mxArray ptr,
char buf,
mwSize  buflen 
)

Definition at line 2972 of file mex.cc.

References mxArray::get_string().

int mxIsCell ( const mxArray ptr)

Definition at line 2582 of file mex.cc.

References mxArray::is_cell().

int mxIsChar ( const mxArray ptr)

Definition at line 2588 of file mex.cc.

References mxArray::is_char().

int mxIsClass ( const mxArray ptr,
const char name 
)

Definition at line 2594 of file mex.cc.

References mxArray::is_class().

int mxIsComplex ( const mxArray ptr)

Definition at line 2600 of file mex.cc.

References mxArray::is_complex().

int mxIsDouble ( const mxArray ptr)

Definition at line 2606 of file mex.cc.

References mxArray::is_double().

int mxIsEmpty ( const mxArray ptr)

Definition at line 2711 of file mex.cc.

References mxArray::is_empty().

int mxIsFinite ( double  v)

Definition at line 2395 of file mex.cc.

References lo_ieee_finite.

int mxIsFromGlobalWS ( const mxArray ptr)

Definition at line 2718 of file mex.cc.

Referenced by mexIsGlobal().

int mxIsFunctionHandle ( const mxArray ptr)

Definition at line 2612 of file mex.cc.

References mxArray::is_function_handle().

int mxIsInf ( double  v)

Definition at line 2401 of file mex.cc.

References lo_ieee_isinf.

int mxIsInt16 ( const mxArray ptr)

Definition at line 2618 of file mex.cc.

References mxArray::is_int16().

int mxIsInt32 ( const mxArray ptr)

Definition at line 2624 of file mex.cc.

References mxArray::is_int32().

int mxIsInt64 ( const mxArray ptr)

Definition at line 2630 of file mex.cc.

References mxArray::is_int64().

int mxIsInt8 ( const mxArray ptr)

Definition at line 2636 of file mex.cc.

References mxArray::is_int8().

int mxIsLogical ( const mxArray ptr)

Definition at line 2642 of file mex.cc.

References mxArray::is_logical().

int mxIsLogicalScalar ( const mxArray ptr)

Definition at line 2697 of file mex.cc.

References mxArray::is_logical_scalar().

int mxIsLogicalScalarTrue ( const mxArray ptr)

Definition at line 2704 of file mex.cc.

References mxArray::is_logical_scalar_true().

int mxIsNaN ( double  v)

Definition at line 2407 of file mex.cc.

References lo_ieee_isnan.

int mxIsNumeric ( const mxArray ptr)

Definition at line 2648 of file mex.cc.

References mxArray::is_numeric().

int mxIsSingle ( const mxArray ptr)

Definition at line 2654 of file mex.cc.

References mxArray::is_single().

int mxIsSparse ( const mxArray ptr)

Definition at line 2660 of file mex.cc.

References mxArray::is_sparse().

int mxIsStruct ( const mxArray ptr)

Definition at line 2666 of file mex.cc.

References mxArray::is_struct().

int mxIsUint16 ( const mxArray ptr)

Definition at line 2672 of file mex.cc.

References mxArray::is_uint16().

int mxIsUint32 ( const mxArray ptr)

Definition at line 2678 of file mex.cc.

References mxArray::is_uint32().

int mxIsUint64 ( const mxArray ptr)

Definition at line 2684 of file mex.cc.

References mxArray::is_uint64().

int mxIsUint8 ( const mxArray ptr)

Definition at line 2690 of file mex.cc.

References mxArray::is_uint8().

void* mxMalloc ( size_t  n)

Definition at line 2438 of file mex.cc.

References mex::malloc().

void* mxRealloc ( void ptr,
size_t  size 
)

Definition at line 2444 of file mex.cc.

References mex::realloc().

Referenced by mxArray_struct::add_field().

void mxRemoveField ( mxArray ptr,
int  key_num 
)

Definition at line 2922 of file mex.cc.

References mxArray::remove_field().

void mxSetCell ( mxArray ptr,
mwIndex  idx,
mxArray val 
)

Definition at line 2872 of file mex.cc.

References mxArray::set_cell().

void mxSetClassName ( mxArray ptr,
const char name 
)

Definition at line 2859 of file mex.cc.

References mxArray::set_class_name().

void mxSetData ( mxArray ptr,
void data 
)

Definition at line 2834 of file mex.cc.

References maybe_unmark(), and mxArray::set_data().

void mxSetDimensions ( mxArray ptr,
const mwSize dims,
mwSize  ndims 
)

Definition at line 2770 of file mex.cc.

References maybe_unmark(), and mxArray::set_dimensions().

void mxSetField ( mxArray ptr,
mwIndex  index,
const char key,
mxArray val 
)

Definition at line 2941 of file mex.cc.

References mxGetFieldNumber(), and mxSetFieldByNumber().

void mxSetFieldByNumber ( mxArray ptr,
mwIndex  index,
int  key_num,
mxArray val 
)

Definition at line 2948 of file mex.cc.

References mxArray::set_field_by_number().

Referenced by mxSetField().

void mxSetImagData ( mxArray ptr,
void pi 
)

Definition at line 2840 of file mex.cc.

References maybe_unmark(), and mxArray::set_imag_data().

void mxSetIr ( mxArray ptr,
mwIndex ir 
)

Definition at line 2897 of file mex.cc.

References maybe_unmark(), and mxArray::set_ir().

void mxSetJc ( mxArray ptr,
mwIndex jc 
)

Definition at line 2903 of file mex.cc.

References maybe_unmark(), and mxArray::set_jc().

void mxSetM ( mxArray ptr,
mwSize  M 
)

Definition at line 2758 of file mex.cc.

References mxArray::set_m().

void mxSetN ( mxArray ptr,
mwSize  N 
)

Definition at line 2764 of file mex.cc.

References mxArray::set_n().

void mxSetNzmax ( mxArray ptr,
mwSize  nzmax 
)

Definition at line 2909 of file mex.cc.

References mxArray::set_nzmax().

void mxSetPi ( mxArray ptr,
double pi 
)

Definition at line 2828 of file mex.cc.

References maybe_unmark(), and mxArray::set_imag_data().

void mxSetPr ( mxArray ptr,
double pr 
)

Definition at line 2822 of file mex.cc.

References maybe_unmark(), and mxArray::set_data().