GNU Octave  4.4.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
mxArray_cell Class Reference
Inheritance diagram for mxArray_cell:
Collaboration diagram for mxArray_cell:

Public Member Functions

 mxArray_cell (mwSize ndims_arg, const mwSize *dims_arg)
 
 mxArray_cell (const dim_vector &dv)
 
 mxArray_cell (mwSize m, mwSize n)
 
 ~mxArray_cell (void)
 
int add_field (const char *)
 
char * array_to_string (void) const
 
virtual mxArrayas_mxArray (void) const
 
octave_value as_octave_value (void) const
 
mwIndex calc_single_subscript (mwSize nsubs, mwIndex *subs) const
 
mxArray_basedup (void) const
 
mxArrayget_cell (mwIndex idx) const
 
mxClassID get_class_id (void) const
 
const char * get_class_name (void) const
 
void * get_data (void) const
 
mwSizeget_dimensions (void) const
 
size_t get_element_size (void) const
 
mxArrayget_field_by_number (mwIndex, int) const
 
const char * get_field_name_by_number (int) const
 
int get_field_number (const char *) const
 
void * get_imag_data (void) const
 
mwIndexget_ir (void) const
 
mwIndexget_jc (void) const
 
mwSize get_m (void) const
 
mwSize get_n (void) const
 
mwSize get_number_of_dimensions (void) const
 
mwSize get_number_of_elements (void) const
 
int get_number_of_fields (void) const
 
mwSize get_nzmax (void) const
 
virtual mxArrayget_property (mwIndex, const char *) const
 
double get_scalar (void) const
 
int get_string (char *, mwSize) const
 
int is_char (void) const
 
virtual int is_class (const char *name_arg) const
 
int is_complex (void) const
 
int is_double (void) const
 
int is_function_handle (void) const
 
int is_int16 (void) const
 
int is_int32 (void) const
 
int is_int64 (void) const
 
int is_int8 (void) const
 
int is_logical (void) const
 
virtual int is_logical_scalar (void) const
 
int is_logical_scalar_true (void) const
 
int is_numeric (void) const
 
virtual bool is_octave_value (void) const
 
bool is_scalar (void) const
 
int is_single (void) const
 
int is_sparse (void) const
 
int is_struct (void) const
 
int is_uint16 (void) const
 
int is_uint32 (void) const
 
int is_uint64 (void) const
 
int is_uint8 (void) const
 
int iscell (void) const
 
int isempty (void) const
 
virtual mxArraymutate (void) const
 
virtual bool mutation_needed (void) const
 
mxArray_celloperator= (const mxArray_cell &)
 
void remove_field (int)
 
void set_cell (mwIndex idx, mxArray *val)
 
void set_class_name (const char *name_arg)
 
void set_data (void *data_arg)
 
int set_dimensions (mwSize *dims_arg, mwSize ndims_arg)
 
void set_field_by_number (mwIndex, int, mxArray *)
 
void set_imag_data (void *)
 
void set_ir (mwIndex *)
 
void set_jc (mwIndex *)
 
void set_m (mwSize m)
 
void set_n (mwSize n)
 
void set_nzmax (mwSize)
 
virtual void set_property (mwIndex, const char *, const mxArray *)
 

Protected Member Functions

dim_vector dims_to_dim_vector (void) const
 
void invalid_type_error (void) const
 

Private Member Functions

 mxArray_cell (const mxArray_cell &val)
 

Private Attributes

mxArray ** data
 

Detailed Description

Definition at line 1924 of file mex.cc.

Constructor & Destructor Documentation

◆ mxArray_cell() [1/4]

mxArray_cell::mxArray_cell ( mwSize  ndims_arg,
const mwSize dims_arg 
)
inline

Definition at line 1928 of file mex.cc.

Referenced by dup().

◆ mxArray_cell() [2/4]

mxArray_cell::mxArray_cell ( const dim_vector dv)
inline

Definition at line 1933 of file mex.cc.

◆ mxArray_cell() [3/4]

mxArray_cell::mxArray_cell ( mwSize  m,
mwSize  n 
)
inline

Definition at line 1938 of file mex.cc.

◆ mxArray_cell() [4/4]

mxArray_cell::mxArray_cell ( const mxArray_cell val)
inlineprivate

Definition at line 1945 of file mex.cc.

References data, mxArray::dup(), mxArray_matlab::get_number_of_elements(), i, and val.

◆ ~mxArray_cell()

mxArray_cell::~mxArray_cell ( void  )
inline

Definition at line 1968 of file mex.cc.

References data, mxArray_matlab::get_number_of_elements(), i, and mxFree().

Member Function Documentation

◆ add_field()

int mxArray_matlab::add_field ( const char *  )
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 961 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ array_to_string()

char* mxArray_matlab::array_to_string ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 1002 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ as_mxArray()

virtual mxArray* mxArray_base::as_mxArray ( void  ) const
inlinevirtualinherited

Reimplemented in mxArray_octave_value.

Definition at line 140 of file mxarray.in.h.

Referenced by mxArray::dup().

◆ as_octave_value()

octave_value mxArray_cell::as_octave_value ( void  ) const
inlinevirtual

◆ calc_single_subscript()

mwIndex mxArray_matlab::calc_single_subscript ( mwSize  nsubs,
mwIndex subs 
) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 1007 of file mex.cc.

References calc_single_subscript_internal(), mxArray_matlab::dims, mxArray_matlab::ndims, and subs.

◆ dims_to_dim_vector()

dim_vector mxArray_matlab::dims_to_dim_vector ( void  ) const
inlineprotectedinherited

◆ dup()

mxArray_base* mxArray_cell::dup ( void  ) const
inlinevirtual

Implements mxArray_base.

Definition at line 1966 of file mex.cc.

References mxArray_cell().

◆ get_cell()

mxArray* mxArray_cell::get_cell ( mwIndex  idx) const
inlinevirtual

Reimplemented from mxArray_matlab.

Definition at line 1978 of file mex.cc.

References data, and mxArray_matlab::get_number_of_elements().

◆ get_class_id()

mxClassID mxArray_matlab::get_class_id ( void  ) const
inlinevirtualinherited

◆ get_class_name()

const char* mxArray_matlab::get_class_name ( void  ) const
inlinevirtualinherited

◆ get_data()

void* mxArray_cell::get_data ( void  ) const
inlinevirtual

Reimplemented from mxArray_matlab.

Definition at line 1985 of file mex.cc.

References data.

◆ get_dimensions()

mwSize* mxArray_matlab::get_dimensions ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 811 of file mex.cc.

References mxArray_matlab::dims.

Referenced by mxArray_matlab::dims_to_dim_vector(), and mxArray_number::mxArray_number().

◆ get_element_size()

◆ get_field_by_number()

mxArray* mxArray_matlab::get_field_by_number ( mwIndex  ,
int   
) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 971 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_field_name_by_number()

const char* mxArray_matlab::get_field_name_by_number ( int  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 987 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_field_number()

int mxArray_matlab::get_field_number ( const char *  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 992 of file mex.cc.

◆ get_imag_data()

void* mxArray_matlab::get_imag_data ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse, and mxArray_number.

Definition at line 916 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_ir()

mwIndex* mxArray_matlab::get_ir ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 931 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_jc()

mwIndex* mxArray_matlab::get_jc ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 936 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_m()

mwSize mxArray_matlab::get_m ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 799 of file mex.cc.

References mxArray_matlab::dims.

Referenced by mxArray_sparse::as_octave_value().

◆ get_n()

mwSize mxArray_matlab::get_n ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 801 of file mex.cc.

References mxArray_matlab::dims, i, and mxArray_matlab::ndims.

Referenced by mxArray_sparse::as_octave_value().

◆ get_number_of_dimensions()

mwSize mxArray_matlab::get_number_of_dimensions ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 813 of file mex.cc.

References mxArray_matlab::ndims.

Referenced by mxArray_matlab::dims_to_dim_vector().

◆ get_number_of_elements()

◆ get_number_of_fields()

int mxArray_matlab::get_number_of_fields ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 982 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_nzmax()

mwSize mxArray_matlab::get_nzmax ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 941 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_property()

virtual mxArray* mxArray_base::get_property ( mwIndex  ,
const char *   
) const
inlinevirtualinherited

Reimplemented in mxArray_octave_value.

Definition at line 233 of file mxarray.in.h.

Referenced by mxArray::get_property().

◆ get_scalar()

double mxArray_matlab::get_scalar ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 906 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ get_string()

int mxArray_matlab::get_string ( char *  ,
mwSize   
) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 997 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ invalid_type_error()

void mxArray_base::invalid_type_error ( void  ) const
inlineprotectedinherited

Definition at line 307 of file mxarray.in.h.

References error().

◆ is_char()

int mxArray_matlab::is_char ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 752 of file mex.cc.

References mxCHAR_CLASS.

◆ is_class()

virtual int mxArray_base::is_class ( const char *  name_arg) const
inlinevirtualinherited

Definition at line 150 of file mxarray.in.h.

References mxArray_base::get_class_name(), retval, and octave::string::strcmp().

Referenced by mxArray::is_class().

◆ is_complex()

int mxArray_matlab::is_complex ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse, and mxArray_number.

Definition at line 754 of file mex.cc.

◆ is_double()

int mxArray_matlab::is_double ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 756 of file mex.cc.

References mxDOUBLE_CLASS.

◆ is_function_handle()

int mxArray_matlab::is_function_handle ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 758 of file mex.cc.

References mxFUNCTION_CLASS.

◆ is_int16()

int mxArray_matlab::is_int16 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 760 of file mex.cc.

References mxINT16_CLASS.

◆ is_int32()

int mxArray_matlab::is_int32 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 762 of file mex.cc.

References mxINT32_CLASS.

◆ is_int64()

int mxArray_matlab::is_int64 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 764 of file mex.cc.

References mxINT64_CLASS.

◆ is_int8()

int mxArray_matlab::is_int8 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 766 of file mex.cc.

References mxINT8_CLASS.

◆ is_logical()

int mxArray_matlab::is_logical ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 768 of file mex.cc.

References mxLOGICAL_CLASS.

◆ is_logical_scalar()

virtual int mxArray_base::is_logical_scalar ( void  ) const
inlinevirtualinherited

◆ is_logical_scalar_true()

int mxArray_matlab::is_logical_scalar_true ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 793 of file mex.cc.

References mxArray_matlab::get_data(), and mxArray_base::is_logical_scalar().

◆ is_numeric()

int mxArray_matlab::is_numeric ( void  ) const
inlinevirtualinherited

◆ is_octave_value()

virtual bool mxArray_base::is_octave_value ( void  ) const
inlinevirtualinherited

Reimplemented in mxArray_octave_value.

Definition at line 144 of file mxarray.in.h.

Referenced by mxArray::is_octave_value(), and mxArray::maybe_mutate().

◆ is_scalar()

bool mxArray_matlab::is_scalar ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 857 of file mex.cc.

References mxArray_matlab::dims, and mxArray_matlab::ndims.

◆ is_single()

int mxArray_matlab::is_single ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 779 of file mex.cc.

References mxSINGLE_CLASS.

◆ is_sparse()

int mxArray_matlab::is_sparse ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 781 of file mex.cc.

◆ is_struct()

int mxArray_matlab::is_struct ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 783 of file mex.cc.

References mxSTRUCT_CLASS.

◆ is_uint16()

int mxArray_matlab::is_uint16 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 785 of file mex.cc.

References mxUINT16_CLASS.

◆ is_uint32()

int mxArray_matlab::is_uint32 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 787 of file mex.cc.

References mxUINT32_CLASS.

◆ is_uint64()

int mxArray_matlab::is_uint64 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 789 of file mex.cc.

References mxUINT64_CLASS.

◆ is_uint8()

int mxArray_matlab::is_uint8 ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 791 of file mex.cc.

References mxUINT8_CLASS.

◆ iscell()

int mxArray_matlab::iscell ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 750 of file mex.cc.

References mxCELL_CLASS.

◆ isempty()

int mxArray_matlab::isempty ( void  ) const
inlinevirtualinherited

Implements mxArray_base.

Definition at line 855 of file mex.cc.

References mxArray_matlab::get_number_of_elements().

◆ mutate()

virtual mxArray* mxArray_base::mutate ( void  ) const
inlinevirtualinherited

Reimplemented in mxArray_octave_value.

Definition at line 298 of file mxarray.in.h.

Referenced by mxArray::maybe_mutate(), and mxArray::mutate().

◆ mutation_needed()

virtual bool mxArray_base::mutation_needed ( void  ) const
inlinevirtualinherited

Reimplemented in mxArray_octave_value.

Definition at line 296 of file mxarray.in.h.

Referenced by mxArray::mutation_needed().

◆ operator=()

mxArray_cell& mxArray_cell::operator= ( const mxArray_cell )

◆ remove_field()

void mxArray_matlab::remove_field ( int  )
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 966 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ set_cell()

void mxArray_cell::set_cell ( mwIndex  idx,
mxArray val 
)
virtual

Reimplemented from mxArray_matlab.

Definition at line 2484 of file mex.cc.

References data, mxArray_matlab::get_number_of_elements(), maybe_unmark_array(), and val.

◆ set_class_name()

void mxArray_matlab::set_class_name ( const char *  name_arg)
inlinevirtualinherited

Implements mxArray_base.

Definition at line 889 of file mex.cc.

References mxArray_matlab::class_name, mxArray::malloc(), mxFree(), and strlen().

◆ set_data()

void mxArray_cell::set_data ( void *  data_arg)
inlinevirtual

Reimplemented from mxArray_matlab.

Definition at line 1987 of file mex.cc.

References data.

◆ set_dimensions()

int mxArray_matlab::set_dimensions ( mwSize dims_arg,
mwSize  ndims_arg 
)
inlinevirtualinherited

Implements mxArray_base.

Definition at line 819 of file mex.cc.

References mxArray_matlab::dims, i, mxArray::malloc(), mxFree(), and mxArray_matlab::ndims.

◆ set_field_by_number()

void mxArray_matlab::set_field_by_number ( mwIndex  ,
int  ,
mxArray  
)
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 976 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ set_imag_data()

void mxArray_matlab::set_imag_data ( void *  )
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse, and mxArray_number.

Definition at line 926 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ set_ir()

void mxArray_matlab::set_ir ( mwIndex )
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 946 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ set_jc()

void mxArray_matlab::set_jc ( mwIndex )
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 951 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ set_m()

void mxArray_matlab::set_m ( mwSize  m)
inlinevirtualinherited

Implements mxArray_base.

Definition at line 815 of file mex.cc.

References mxArray_matlab::dims.

◆ set_n()

void mxArray_matlab::set_n ( mwSize  n)
inlinevirtualinherited

Implements mxArray_base.

Definition at line 817 of file mex.cc.

References mxArray_matlab::dims.

◆ set_nzmax()

void mxArray_matlab::set_nzmax ( mwSize  )
inlinevirtualinherited

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 956 of file mex.cc.

References mxArray_matlab::err_invalid_type().

◆ set_property()

virtual void mxArray_base::set_property ( mwIndex  ,
const char *  ,
const mxArray  
)
inlinevirtualinherited

Reimplemented in mxArray_octave_value.

Definition at line 238 of file mxarray.in.h.

References mxArray_base::err_invalid_type().

Referenced by mxArray::set_property().

Member Data Documentation

◆ data

mxArray** mxArray_cell::data
private

The documentation for this class was generated from the following file: