GNU Octave  4.0.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
Public Member Functions | Protected Member Functions | List of all members
mxArray_base Class Referenceabstract

#include "mxarray.h"

Inheritance diagram for mxArray_base:
Inheritance graph
[legend]

Public Member Functions

virtual ~mxArray_base (void)
 
virtual ~mxArray_base (void)
 
virtual int add_field (const char *key)=0
 
virtual int add_field (const char *key)=0
 
virtual chararray_to_string (void) const =0
 
virtual chararray_to_string (void) const =0
 
virtual mxArrayas_mxArray (void) const
 
virtual mxArrayas_mxArray (void) const
 
virtual octave_value as_octave_value (void) const =0
 
virtual octave_value as_octave_value (void) const =0
 
virtual mwIndex calc_single_subscript (mwSize nsubs, mwIndex *subs) const =0
 
virtual mwIndex calc_single_subscript (mwSize nsubs, mwIndex *subs) const =0
 
virtual mxArray_basedup (void) const =0
 
virtual mxArray_basedup (void) const =0
 
virtual mxArrayget_cell (mwIndex) const
 
virtual mxArrayget_cell (mwIndex) const
 
virtual mxClassID get_class_id (void) const =0
 
virtual mxClassID get_class_id (void) const =0
 
virtual const charget_class_name (void) const =0
 
virtual const charget_class_name (void) const =0
 
virtual void * get_data (void) const =0
 
virtual void * get_data (void) const =0
 
virtual mwSizeget_dimensions (void) const =0
 
virtual mwSizeget_dimensions (void) const =0
 
virtual size_t get_element_size (void) const =0
 
virtual size_t get_element_size (void) const =0
 
virtual mxArrayget_field_by_number (mwIndex index, int key_num) const =0
 
virtual mxArrayget_field_by_number (mwIndex index, int key_num) const =0
 
virtual const charget_field_name_by_number (int key_num) const =0
 
virtual const charget_field_name_by_number (int key_num) const =0
 
virtual int get_field_number (const char *key) const =0
 
virtual int get_field_number (const char *key) const =0
 
virtual void * get_imag_data (void) const =0
 
virtual void * get_imag_data (void) const =0
 
virtual mwIndexget_ir (void) const =0
 
virtual mwIndexget_ir (void) const =0
 
virtual mwIndexget_jc (void) const =0
 
virtual mwIndexget_jc (void) const =0
 
virtual mwSize get_m (void) const =0
 
virtual mwSize get_m (void) const =0
 
virtual mwSize get_n (void) const =0
 
virtual mwSize get_n (void) const =0
 
virtual mwSize get_number_of_dimensions (void) const =0
 
virtual mwSize get_number_of_dimensions (void) const =0
 
virtual mwSize get_number_of_elements (void) const =0
 
virtual mwSize get_number_of_elements (void) const =0
 
virtual int get_number_of_fields (void) const =0
 
virtual int get_number_of_fields (void) const =0
 
virtual mwSize get_nzmax (void) const =0
 
virtual mwSize get_nzmax (void) const =0
 
virtual double get_scalar (void) const =0
 
virtual double get_scalar (void) const =0
 
virtual int get_string (char *buf, mwSize buflen) const =0
 
virtual int get_string (char *buf, mwSize buflen) const =0
 
virtual int is_cell (void) const =0
 
virtual int is_cell (void) const =0
 
virtual int is_char (void) const =0
 
virtual int is_char (void) const =0
 
virtual int is_class (const char *name_arg) const
 
virtual int is_class (const char *name_arg) const
 
virtual int is_complex (void) const =0
 
virtual int is_complex (void) const =0
 
virtual int is_double (void) const =0
 
virtual int is_double (void) const =0
 
virtual int is_empty (void) const =0
 
virtual int is_empty (void) const =0
 
virtual int is_function_handle (void) const =0
 
virtual int is_function_handle (void) const =0
 
virtual int is_int16 (void) const =0
 
virtual int is_int16 (void) const =0
 
virtual int is_int32 (void) const =0
 
virtual int is_int32 (void) const =0
 
virtual int is_int64 (void) const =0
 
virtual int is_int64 (void) const =0
 
virtual int is_int8 (void) const =0
 
virtual int is_int8 (void) const =0
 
virtual int is_logical (void) const =0
 
virtual int is_logical (void) const =0
 
virtual int is_logical_scalar (void) const
 
virtual int is_logical_scalar (void) const
 
virtual int is_logical_scalar_true (void) const =0
 
virtual int is_logical_scalar_true (void) const =0
 
virtual int is_numeric (void) const =0
 
virtual int is_numeric (void) const =0
 
virtual bool is_octave_value (void) const
 
virtual bool is_octave_value (void) const
 
virtual int is_single (void) const =0
 
virtual int is_single (void) const =0
 
virtual int is_sparse (void) const =0
 
virtual int is_sparse (void) const =0
 
virtual int is_struct (void) const =0
 
virtual int is_struct (void) const =0
 
virtual int is_uint16 (void) const =0
 
virtual int is_uint16 (void) const =0
 
virtual int is_uint32 (void) const =0
 
virtual int is_uint32 (void) const =0
 
virtual int is_uint64 (void) const =0
 
virtual int is_uint64 (void) const =0
 
virtual int is_uint8 (void) const =0
 
virtual int is_uint8 (void) const =0
 
virtual mxArraymutate (void) const
 
virtual mxArraymutate (void) const
 
virtual bool mutation_needed (void) const
 
virtual bool mutation_needed (void) const
 
virtual void remove_field (int key_num)=0
 
virtual void remove_field (int key_num)=0
 
virtual void set_cell (mwIndex idx, mxArray *val)=0
 
virtual void set_cell (mwIndex idx, mxArray *val)=0
 
virtual void set_class_name (const char *name_arg)=0
 
virtual void set_class_name (const char *name_arg)=0
 
virtual void set_data (void *pr)=0
 
virtual void set_data (void *pr)=0
 
virtual void set_dimensions (mwSize *dims_arg, mwSize ndims_arg)=0
 
virtual void set_dimensions (mwSize *dims_arg, mwSize ndims_arg)=0
 
virtual void set_field_by_number (mwIndex index, int key_num, mxArray *val)=0
 
virtual void set_field_by_number (mwIndex index, int key_num, mxArray *val)=0
 
virtual void set_imag_data (void *pi)=0
 
virtual void set_imag_data (void *pi)=0
 
virtual void set_ir (mwIndex *ir)=0
 
virtual void set_ir (mwIndex *ir)=0
 
virtual void set_jc (mwIndex *jc)=0
 
virtual void set_jc (mwIndex *jc)=0
 
virtual void set_m (mwSize m)=0
 
virtual void set_m (mwSize m)=0
 
virtual void set_n (mwSize n)=0
 
virtual void set_n (mwSize n)=0
 
virtual void set_nzmax (mwSize nzmax)=0
 
virtual void set_nzmax (mwSize nzmax)=0
 

Protected Member Functions

 mxArray_base (void)
 
 mxArray_base (void)
 
 mxArray_base (const mxArray_base &)
 
 mxArray_base (const mxArray_base &)
 
void error (const char *msg) const
 
void error (const char *msg) const
 
void invalid_type_error (void) const
 
void invalid_type_error (void) const
 

Detailed Description

Definition at line 124 of file mxarray.h.

Constructor & Destructor Documentation

mxArray_base::mxArray_base ( void  )
inlineprotected

Definition at line 128 of file mxarray.h.

virtual mxArray_base::~mxArray_base ( void  )
inlinevirtual

Definition at line 136 of file mxarray.h.

mxArray_base::mxArray_base ( const mxArray_base )
inlineprotected

Definition at line 280 of file mxarray.h.

mxArray_base::mxArray_base ( void  )
inlineprotected

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

virtual mxArray_base::~mxArray_base ( void  )
inlinevirtual

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

mxArray_base::mxArray_base ( const mxArray_base )
inlineprotected

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

Member Function Documentation

virtual int mxArray_base::add_field ( const char key)
pure virtual
virtual int mxArray_base::add_field ( const char key)
pure virtual
virtual char* mxArray_base::array_to_string ( void  ) const
pure virtual
virtual char* mxArray_base::array_to_string ( void  ) const
pure virtual
virtual mxArray* mxArray_base::as_mxArray ( void  ) const
inlinevirtual

Reimplemented in mxArray_octave_value.

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

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

Reimplemented in mxArray_octave_value.

Definition at line 134 of file mxarray.h.

Referenced by mxArray::dup().

virtual octave_value mxArray_base::as_octave_value ( void  ) const
pure virtual
virtual octave_value mxArray_base::as_octave_value ( void  ) const
pure virtual
virtual mwIndex mxArray_base::calc_single_subscript ( mwSize  nsubs,
mwIndex subs 
) const
pure virtual
virtual mwIndex mxArray_base::calc_single_subscript ( mwSize  nsubs,
mwIndex subs 
) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual mxArray_base* mxArray_base::dup ( void  ) const
pure virtual
virtual mxArray_base* mxArray_base::dup ( void  ) const
pure virtual
void mxArray_base::error ( const char msg) const
protected
void mxArray_base::error ( const char msg) const
protected
virtual mxArray* mxArray_base::get_cell ( mwIndex  ) const
inlinevirtual

Reimplemented in mxArray_cell, mxArray_matlab, and mxArray_octave_value.

Definition at line 219 of file mxarray.h.

References invalid_type_error().

virtual mxArray* mxArray_base::get_cell ( mwIndex  ) const
inlinevirtual

Reimplemented in mxArray_cell, mxArray_matlab, and mxArray_octave_value.

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

References invalid_type_error().

virtual mxClassID mxArray_base::get_class_id ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_class_id().

virtual mxClassID mxArray_base::get_class_id ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual const char* mxArray_base::get_class_name ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_class_name(), and is_class().

virtual const char* mxArray_base::get_class_name ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void* mxArray_base::get_data ( void  ) const
pure virtual
virtual void* mxArray_base::get_data ( void  ) const
pure virtual
virtual mwSize* mxArray_base::get_dimensions ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual mwSize* mxArray_base::get_dimensions ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_dimensions().

virtual size_t mxArray_base::get_element_size ( void  ) const
pure virtual
virtual size_t mxArray_base::get_element_size ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual mxArray* mxArray_base::get_field_by_number ( mwIndex  index,
int  key_num 
) const
pure virtual
virtual mxArray* mxArray_base::get_field_by_number ( mwIndex  index,
int  key_num 
) const
pure virtual
virtual const char* mxArray_base::get_field_name_by_number ( int  key_num) const
pure virtual
virtual const char* mxArray_base::get_field_name_by_number ( int  key_num) const
pure virtual
virtual int mxArray_base::get_field_number ( const char key) const
pure virtual
virtual int mxArray_base::get_field_number ( const char key) const
pure virtual
virtual void* mxArray_base::get_imag_data ( void  ) const
pure virtual
virtual void* mxArray_base::get_imag_data ( void  ) const
pure virtual
virtual mwIndex* mxArray_base::get_ir ( void  ) const
pure virtual
virtual mwIndex* mxArray_base::get_ir ( void  ) const
pure virtual
virtual mwIndex* mxArray_base::get_jc ( void  ) const
pure virtual
virtual mwIndex* mxArray_base::get_jc ( void  ) const
pure virtual
virtual mwSize mxArray_base::get_m ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual mwSize mxArray_base::get_m ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_m().

virtual mwSize mxArray_base::get_n ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual mwSize mxArray_base::get_n ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_n().

virtual mwSize mxArray_base::get_number_of_dimensions ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual mwSize mxArray_base::get_number_of_dimensions ( void  ) const
pure virtual
virtual mwSize mxArray_base::get_number_of_elements ( void  ) const
pure virtual
virtual mwSize mxArray_base::get_number_of_elements ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::get_number_of_fields ( void  ) const
pure virtual
virtual int mxArray_base::get_number_of_fields ( void  ) const
pure virtual
virtual mwSize mxArray_base::get_nzmax ( void  ) const
pure virtual
virtual mwSize mxArray_base::get_nzmax ( void  ) const
pure virtual
virtual double mxArray_base::get_scalar ( void  ) const
pure virtual
virtual double mxArray_base::get_scalar ( void  ) const
pure virtual
virtual int mxArray_base::get_string ( char buf,
mwSize  buflen 
) const
pure virtual
virtual int mxArray_base::get_string ( char buf,
mwSize  buflen 
) const
pure virtual
void mxArray_base::invalid_type_error ( void  ) const
inlineprotected

Definition at line 282 of file mxarray.h.

References error().

Referenced by get_cell().

void mxArray_base::invalid_type_error ( void  ) const
inlineprotected

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

References error().

virtual int mxArray_base::is_cell ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_cell ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_cell().

virtual int mxArray_base::is_char ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_char ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_char().

virtual int mxArray_base::is_class ( const char name_arg) const
inlinevirtual

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

References get_class_name().

virtual int mxArray_base::is_class ( const char name_arg) const
inlinevirtual

Definition at line 144 of file mxarray.h.

References get_class_name().

Referenced by mxArray::is_class().

virtual int mxArray_base::is_complex ( void  ) const
pure virtual
virtual int mxArray_base::is_complex ( void  ) const
pure virtual
virtual int mxArray_base::is_double ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_double ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_double().

virtual int mxArray_base::is_empty ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_empty ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_function_handle ( void  ) const
pure virtual
virtual int mxArray_base::is_function_handle ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_int16 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_int16 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int16().

virtual int mxArray_base::is_int32 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_int32 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int32().

virtual int mxArray_base::is_int64 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_int64 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int64().

virtual int mxArray_base::is_int8 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_int8 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int8().

virtual int mxArray_base::is_logical ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_logical ( void  ) const
pure virtual
virtual int mxArray_base::is_logical_scalar ( void  ) const
inlinevirtual

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

References get_number_of_elements(), and is_logical().

virtual int mxArray_base::is_logical_scalar ( void  ) const
inlinevirtual
virtual int mxArray_base::is_logical_scalar_true ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_logical_scalar_true ( void  ) const
pure virtual
virtual int mxArray_base::is_numeric ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_numeric().

virtual int mxArray_base::is_numeric ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual bool mxArray_base::is_octave_value ( void  ) const
inlinevirtual

Reimplemented in mxArray_octave_value.

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

virtual bool mxArray_base::is_octave_value ( void  ) const
inlinevirtual

Reimplemented in mxArray_octave_value.

Definition at line 138 of file mxarray.h.

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

virtual int mxArray_base::is_single ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_single().

virtual int mxArray_base::is_single ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_sparse ( void  ) const
pure virtual
virtual int mxArray_base::is_sparse ( void  ) const
pure virtual
virtual int mxArray_base::is_struct ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_struct ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_struct().

virtual int mxArray_base::is_uint16 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_uint16 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint16().

virtual int mxArray_base::is_uint32 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_uint32 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint32().

virtual int mxArray_base::is_uint64 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_uint64 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint64().

virtual int mxArray_base::is_uint8 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual int mxArray_base::is_uint8 ( void  ) const
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint8().

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

Reimplemented in mxArray_octave_value.

Definition at line 274 of file mxarray.h.

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

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

Reimplemented in mxArray_octave_value.

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

virtual bool mxArray_base::mutation_needed ( void  ) const
inlinevirtual

Reimplemented in mxArray_octave_value.

Definition at line 272 of file mxarray.h.

Referenced by mxArray::mutation_needed().

virtual bool mxArray_base::mutation_needed ( void  ) const
inlinevirtual

Reimplemented in mxArray_octave_value.

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

virtual void mxArray_base::remove_field ( int  key_num)
pure virtual
virtual void mxArray_base::remove_field ( int  key_num)
pure virtual
virtual void mxArray_base::set_cell ( mwIndex  idx,
mxArray val 
)
pure virtual
virtual void mxArray_base::set_cell ( mwIndex  idx,
mxArray val 
)
pure virtual
virtual void mxArray_base::set_class_name ( const char name_arg)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_class_name ( const char name_arg)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_data ( void *  pr)
pure virtual
virtual void mxArray_base::set_data ( void *  pr)
pure virtual
virtual void mxArray_base::set_dimensions ( mwSize dims_arg,
mwSize  ndims_arg 
)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_dimensions ( mwSize dims_arg,
mwSize  ndims_arg 
)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_field_by_number ( mwIndex  index,
int  key_num,
mxArray val 
)
pure virtual
virtual void mxArray_base::set_field_by_number ( mwIndex  index,
int  key_num,
mxArray val 
)
pure virtual
virtual void mxArray_base::set_imag_data ( void *  pi)
pure virtual
virtual void mxArray_base::set_imag_data ( void *  pi)
pure virtual
virtual void mxArray_base::set_ir ( mwIndex ir)
pure virtual
virtual void mxArray_base::set_ir ( mwIndex ir)
pure virtual
virtual void mxArray_base::set_jc ( mwIndex jc)
pure virtual
virtual void mxArray_base::set_jc ( mwIndex jc)
pure virtual
virtual void mxArray_base::set_m ( mwSize  m)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_m ( mwSize  m)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_n ( mwSize  n)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_n ( mwSize  n)
pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

virtual void mxArray_base::set_nzmax ( mwSize  nzmax)
pure virtual
virtual void mxArray_base::set_nzmax ( mwSize  nzmax)
pure virtual

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