mxarray.h File Reference

#include "octave-config.h"
#include <cstring>
#include "error.h"

Include dependency graph for mxarray.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	mxArray
class	mxArray_base

Macros
#define	DO_MUTABLE_METHOD(RET_T, METHOD_CALL)
#define	DO_VOID_MUTABLE_METHOD(METHOD_CALL)

Typedefs
typedef int	mwIndex
typedef int	mwSignedIndex
typedef int	mwSize
typedef char	mxChar
typedef unsigned char	mxLogical

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, 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 }
enum	mxComplexity { mxREAL = 0, mxCOMPLEX = 1, mxREAL = 0, mxCOMPLEX = 1 }

Macro Definition Documentation

#define DO_MUTABLE_METHOD	(		RET_T,
			METHOD_CALL
	)

Value:

RET_T retval = rep->METHOD_CALL;              \
                                                \
  if (rep->mutation_needed ())                  \
    {                                           \
      maybe_mutate ();                          \
      retval = rep->METHOD_CALL;                \
    }                                           \
                                                \
  return retval

Definition at line 104 of file mxarray.h.

Referenced by mxArray::add_field(), mxArray::get_cell(), mxArray::get_data(), mxArray::get_field_by_number(), mxArray::get_field_name_by_number(), mxArray::get_field_number(), mxArray::get_imag_data(), mxArray::get_ir(), mxArray::get_jc(), and mxArray::set_dimensions().

#define DO_VOID_MUTABLE_METHOD

(

METHOD_CALL

)

Value:

rep->METHOD_CALL;                             \
                                                \
  if (rep->mutation_needed ())                  \
    {                                           \
      maybe_mutate ();                          \
      rep->METHOD_CALL;                         \
    }

Definition at line 115 of file mxarray.h.

Referenced by mxArray::remove_field(), mxArray::set_cell(), mxArray::set_class_name(), mxArray::set_data(), mxArray::set_field_by_number(), mxArray::set_imag_data(), mxArray::set_ir(), mxArray::set_jc(), mxArray::set_m(), mxArray::set_n(), and mxArray::set_nzmax().

Typedef Documentation

typedef int mwIndex

Definition at line 94 of file mxarray.h.

typedef int mwSignedIndex

Definition at line 95 of file mxarray.h.

typedef int mwSize

Definition at line 93 of file mxarray.h.

typedef char mxChar

Definition at line 83 of file mxarray.h.

typedef unsigned char mxLogical

Definition at line 85 of file mxarray.h.

Enumeration Type Documentation

enum mxClassID

Enumerator
mxUNKNOWN_CLASS
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
mxUNKNOWN_CLASS
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

Definition at line 52 of file mxarray.h.

enum mxComplexity

Enumerator
mxREAL
mxCOMPLEX
mxREAL
mxCOMPLEX

Definition at line 74 of file mxarray.h.