mxArray_base Class Reference

#include "mxarray.in.h"

Inheritance diagram for mxArray_base:

Public Member Functions
virtual	~mxArray_base (void)=default
virtual int	add_field (const char *key)=0
virtual char *	array_to_string (void) const =0
virtual mxArray *	as_mxArray (void) const
virtual octave_value	as_octave_value (void) const =0
virtual mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const =0
virtual mxArray_base *	dup (void) const =0
virtual mxArray *	get_cell (mwIndex) const
virtual mxClassID	get_class_id (void) const =0
virtual const char *	get_class_name (void) const =0
virtual void *	get_data (void) const =0
virtual mwSize *	get_dimensions (void) const =0
virtual size_t	get_element_size (void) const =0
virtual mxArray *	get_field_by_number (mwIndex index, int key_num) const =0
virtual const char *	get_field_name_by_number (int key_num) const =0
virtual int	get_field_number (const char *key) const =0
virtual void *	get_imag_data (void) const =0
virtual mwIndex *	get_ir (void) const =0
virtual mwIndex *	get_jc (void) const =0
virtual mwSize	get_m (void) const =0
virtual mwSize	get_n (void) const =0
virtual mwSize	get_number_of_dimensions (void) const =0
virtual mwSize	get_number_of_elements (void) const =0
virtual int	get_number_of_fields (void) const =0
virtual mwSize	get_nzmax (void) const =0
virtual mxArray *	get_property (mwIndex, const char *) const
virtual double	get_scalar (void) const =0
virtual int	get_string (char *buf, mwSize buflen) const =0
virtual int	is_char (void) const =0
virtual int	is_class (const char *name_arg) const
virtual int	is_complex (void) const =0
virtual int	is_double (void) const =0
virtual int	is_function_handle (void) const =0
virtual int	is_int16 (void) const =0
virtual int	is_int32 (void) const =0
virtual int	is_int64 (void) const =0
virtual int	is_int8 (void) const =0
virtual int	is_logical (void) const =0
virtual int	is_logical_scalar (void) const
virtual int	is_logical_scalar_true (void) const =0
virtual int	is_numeric (void) const =0
virtual bool	is_octave_value (void) const
virtual bool	is_scalar (void) const =0
virtual int	is_single (void) const =0
virtual int	is_sparse (void) const =0
virtual int	is_struct (void) const =0
virtual int	is_uint16 (void) const =0
virtual int	is_uint32 (void) const =0
virtual int	is_uint64 (void) const =0
virtual int	is_uint8 (void) const =0
virtual int	iscell (void) const =0
virtual int	isempty (void) const =0
virtual mxArray *	mutate (void) const
virtual bool	mutation_needed (void) const
virtual void	remove_field (int key_num)=0
virtual void	set_cell (mwIndex idx, mxArray *val)=0
virtual void	set_class_name (const char *name_arg)=0
virtual void	set_data (void *pr)=0
virtual int	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_imag_data (void *pi)=0
virtual void	set_ir (mwIndex *ir)=0
virtual void	set_jc (mwIndex *jc)=0
virtual void	set_m (mwSize m)=0
virtual void	set_n (mwSize n)=0
virtual void	set_nzmax (mwSize nzmax)=0
virtual void	set_property (mwIndex, const char *, const mxArray *)

Protected Member Functions
	mxArray_base (void)
	mxArray_base (const mxArray_base &)
OCTAVE_NORETURN void	err_invalid_type (void) const
void	invalid_type_error (void) const

Detailed Description

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

Constructor & Destructor Documentation

mxArray_base() [1/2]

mxArray_base::mxArray_base ( void  )

inlineprotected

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

~mxArray_base()

virtual mxArray_base::~mxArray_base ( void  )

virtualdefault

mxArray_base() [2/2]

mxArray_base::mxArray_base ( const mxArray_base &  )

inlineprotected

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

Member Function Documentation

add_field()

virtual int mxArray_base::add_field ( const char *  key )

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

array_to_string()

virtual char* mxArray_base::array_to_string ( void  ) const

pure virtual

Implemented in mxArray_number, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::array_to_string().

as_mxArray()

virtual mxArray* mxArray_base::as_mxArray ( void  ) const

inlinevirtual

Reimplemented in mxArray_octave_value.

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

Referenced by mxArray::dup().

as_octave_value()

virtual octave_value mxArray_base::as_octave_value ( void  ) const

pure virtual

Implemented in mxArray_cell, mxArray_struct, mxArray_sparse, mxArray_number, and mxArray_octave_value.

Referenced by mxArray::as_octave_value().

calc_single_subscript()

virtual mwIndex mxArray_base::calc_single_subscript ( mwSize  nsubs, mwIndex *  subs  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::calc_single_subscript().

dup()

virtual mxArray_base* mxArray_base::dup ( void  ) const

pure virtual

Implemented in mxArray_cell, mxArray_struct, mxArray_sparse, mxArray_number, and mxArray_octave_value.

Referenced by mxArray::dup().

err_invalid_type()

OCTAVE_NORETURN void mxArray_base::err_invalid_type ( void  ) const

inlineprotected

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

References error().

Referenced by get_cell(), set_property(), and mxArray_octave_value::set_property().

get_cell()

virtual mxArray* mxArray_base::get_cell ( mwIndex  ) const

inlinevirtual

Reimplemented in mxArray_cell, mxArray_matlab, and mxArray_octave_value.

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

References err_invalid_type().

get_class_id()

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().

get_class_name()

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().

get_data()

virtual void* mxArray_base::get_data ( void  ) const

pure virtual

Implemented in mxArray_cell, mxArray_struct, mxArray_sparse, mxArray_number, mxArray_matlab, and mxArray_octave_value.

get_dimensions()

virtual mwSize* mxArray_base::get_dimensions ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_dimensions().

get_element_size()

virtual size_t mxArray_base::get_element_size ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_element_size().

get_field_by_number()

virtual mxArray* mxArray_base::get_field_by_number ( mwIndex  index, int  key_num  ) const

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

get_field_name_by_number()

virtual const char* mxArray_base::get_field_name_by_number ( int  key_num ) const

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

get_field_number()

virtual int mxArray_base::get_field_number ( const char *  key ) const

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

get_imag_data()

virtual void* mxArray_base::get_imag_data ( void  ) const

pure virtual

Implemented in mxArray_sparse, mxArray_number, mxArray_matlab, and mxArray_octave_value.

get_ir()

virtual mwIndex* mxArray_base::get_ir ( void  ) const

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

get_jc()

virtual mwIndex* mxArray_base::get_jc ( void  ) const

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

get_m()

virtual mwSize mxArray_base::get_m ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_m().

get_n()

virtual mwSize mxArray_base::get_n ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_n().

get_number_of_dimensions()

virtual mwSize mxArray_base::get_number_of_dimensions ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_number_of_dimensions().

get_number_of_elements()

virtual mwSize mxArray_base::get_number_of_elements ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_number_of_elements(), and is_logical_scalar().

get_number_of_fields()

virtual int mxArray_base::get_number_of_fields ( void  ) const

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_number_of_fields().

get_nzmax()

virtual mwSize mxArray_base::get_nzmax ( void  ) const

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_nzmax().

get_property()

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

inlinevirtual

Reimplemented in mxArray_octave_value.

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

Referenced by mxArray::get_property().

get_scalar()

virtual double mxArray_base::get_scalar ( void  ) const

pure virtual

Implemented in mxArray_number, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_scalar().

get_string()

virtual int mxArray_base::get_string ( char *  buf, mwSize  buflen  ) const

pure virtual

Implemented in mxArray_number, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::get_string().

invalid_type_error()

void mxArray_base::invalid_type_error ( void  ) const

inlineprotected

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

References error().

is_char()

virtual int mxArray_base::is_char ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_char().

is_class()

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

inlinevirtual

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

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

Referenced by mxArray::is_class().

is_complex()

virtual int mxArray_base::is_complex ( void  ) const

pure virtual

Implemented in mxArray_sparse, mxArray_number, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_complex().

is_double()

virtual int mxArray_base::is_double ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_double().

is_function_handle()

virtual int mxArray_base::is_function_handle ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_function_handle().

is_int16()

virtual int mxArray_base::is_int16 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int16().

is_int32()

virtual int mxArray_base::is_int32 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int32().

is_int64()

virtual int mxArray_base::is_int64 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int64().

is_int8()

virtual int mxArray_base::is_int8 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_int8().

is_logical()

virtual int mxArray_base::is_logical ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_logical(), and is_logical_scalar().

is_logical_scalar()

virtual int mxArray_base::is_logical_scalar ( void  ) const

inlinevirtual

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

References get_number_of_elements(), and is_logical().

Referenced by mxArray::is_logical_scalar(), mxArray_octave_value::is_logical_scalar_true(), and mxArray_matlab::is_logical_scalar_true().

is_logical_scalar_true()

virtual int mxArray_base::is_logical_scalar_true ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_logical_scalar_true().

is_numeric()

virtual int mxArray_base::is_numeric ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_numeric().

is_octave_value()

virtual bool mxArray_base::is_octave_value ( void  ) const

inlinevirtual

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()

virtual bool mxArray_base::is_scalar ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_scalar().

is_single()

virtual int mxArray_base::is_single ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_single().

is_sparse()

virtual int mxArray_base::is_sparse ( void  ) const

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_sparse().

is_struct()

virtual int mxArray_base::is_struct ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_struct().

is_uint16()

virtual int mxArray_base::is_uint16 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint16().

is_uint32()

virtual int mxArray_base::is_uint32 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint32().

is_uint64()

virtual int mxArray_base::is_uint64 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint64().

is_uint8()

virtual int mxArray_base::is_uint8 ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::is_uint8().

iscell()

virtual int mxArray_base::iscell ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

Referenced by mxArray::iscell().

isempty()

virtual int mxArray_base::isempty ( void  ) const

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

mutate()

virtual mxArray* mxArray_base::mutate ( void  ) const

inlinevirtual

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

inlinevirtual

Reimplemented in mxArray_octave_value.

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

Referenced by mxArray::mutation_needed().

remove_field()

virtual void mxArray_base::remove_field ( int  key_num )

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

set_cell()

virtual void mxArray_base::set_cell ( mwIndex  idx, mxArray *  val  )

pure virtual

Implemented in mxArray_cell, mxArray_matlab, and mxArray_octave_value.

set_class_name()

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

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

set_data()

virtual void mxArray_base::set_data ( void *  pr )

pure virtual

Implemented in mxArray_cell, mxArray_struct, mxArray_sparse, mxArray_number, mxArray_matlab, and mxArray_octave_value.

set_dimensions()

virtual int mxArray_base::set_dimensions ( mwSize *  dims_arg, mwSize  ndims_arg  )

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

set_field_by_number()

virtual void mxArray_base::set_field_by_number ( mwIndex  index, int  key_num, mxArray *  val  )

pure virtual

Implemented in mxArray_struct, mxArray_matlab, and mxArray_octave_value.

set_imag_data()

virtual void mxArray_base::set_imag_data ( void *  pi )

pure virtual

Implemented in mxArray_sparse, mxArray_number, mxArray_matlab, and mxArray_octave_value.

set_ir()

virtual void mxArray_base::set_ir ( mwIndex *  ir )

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

set_jc()

virtual void mxArray_base::set_jc ( mwIndex *  jc )

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

set_m()

virtual void mxArray_base::set_m ( mwSize  m )

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

set_n()

virtual void mxArray_base::set_n ( mwSize  n )

pure virtual

Implemented in mxArray_matlab, and mxArray_octave_value.

set_nzmax()

virtual void mxArray_base::set_nzmax ( mwSize  nzmax )

pure virtual

Implemented in mxArray_sparse, mxArray_matlab, and mxArray_octave_value.

set_property()

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

inlinevirtual

Reimplemented in mxArray_octave_value.

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

References err_invalid_type().

Referenced by mxArray::set_property().

---

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

• libinterp/corefcn/mxarray.in.h