mxArray_base Class Reference

#include "mxarray.h"

Inherited by mxArray_matlab, and mxArray_octave_value.

Public Member Functions
	mxArray_base ()=delete
virtual	~mxArray_base ()=default
virtual int	add_field (const char *key)=0
virtual char *	array_to_string () const =0
virtual mxArray *	as_mxArray () const
virtual octave_value	as_octave_value () const =0
virtual mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const =0
virtual mxArray_base *	dup () const =0
virtual mxArray *	get_cell (mwIndex) const
virtual mxClassID	get_class_id () const =0
virtual const char *	get_class_name () const =0
virtual mxComplexDouble *	get_complex_doubles () const =0
virtual mxComplexSingle *	get_complex_singles () const =0
virtual void *	get_data () const =0
virtual mwSize *	get_dimensions () const =0
virtual mxDouble *	get_doubles () const =0
virtual std::size_t	get_element_size () 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 () const =0
virtual mxInt16 *	get_int16s () const =0
virtual mxInt32 *	get_int32s () const =0
virtual mxInt64 *	get_int64s () const =0
virtual mxInt8 *	get_int8s () const =0
virtual mwIndex *	get_ir () const =0
virtual mwIndex *	get_jc () const =0
virtual mwSize	get_m () const =0
virtual mwSize	get_n () const =0
virtual mwSize	get_number_of_dimensions () const =0
virtual mwSize	get_number_of_elements () const =0
virtual int	get_number_of_fields () const =0
virtual mwSize	get_nzmax () const =0
virtual mxArray *	get_property (mwIndex, const char *) const
virtual double	get_scalar () const =0
virtual mxSingle *	get_singles () const =0
virtual int	get_string (char *buf, mwSize buflen) const =0
virtual mxUint16 *	get_uint16s () const =0
virtual mxUint32 *	get_uint32s () const =0
virtual mxUint64 *	get_uint64s () const =0
virtual mxUint8 *	get_uint8s () const =0
virtual int	is_char () const =0
virtual int	is_class (const char *name_arg) const
virtual int	is_complex () const =0
virtual int	is_double () const =0
virtual int	is_function_handle () const =0
virtual int	is_int16 () const =0
virtual int	is_int32 () const =0
virtual int	is_int64 () const =0
virtual int	is_int8 () const =0
virtual int	is_logical () const =0
virtual int	is_logical_scalar () const
virtual int	is_logical_scalar_true () const =0
virtual int	is_numeric () const =0
virtual bool	is_octave_value () const
virtual bool	is_scalar () const =0
virtual int	is_single () const =0
virtual int	is_sparse () const =0
virtual int	is_struct () const =0
virtual int	is_uint16 () const =0
virtual int	is_uint32 () const =0
virtual int	is_uint64 () const =0
virtual int	is_uint8 () const =0
virtual int	iscell () const =0
virtual int	isempty () const =0
virtual mxArray *	mutate () const
virtual bool	mutation_needed () 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 int	set_complex_doubles (mxComplexDouble *data)=0
virtual int	set_complex_singles (mxComplexSingle *data)=0
virtual void	set_data (void *pr)=0
virtual int	set_dimensions (mwSize *dims_arg, mwSize ndims_arg)=0
virtual int	set_doubles (mxDouble *data)=0
virtual void	set_field_by_number (mwIndex index, int key_num, mxArray *val)=0
virtual void	set_imag_data (void *pi)=0
virtual int	set_int16s (mxInt16 *data)=0
virtual int	set_int32s (mxInt32 *data)=0
virtual int	set_int64s (mxInt64 *data)=0
virtual int	set_int8s (mxInt8 *data)=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 *)
virtual int	set_singles (mxSingle *data)=0
virtual int	set_uint16s (mxUint16 *data)=0
virtual int	set_uint32s (mxUint32 *data)=0
virtual int	set_uint64s (mxUint64 *data)=0
virtual int	set_uint8s (mxUint8 *data)=0

Protected Member Functions
	mxArray_base (bool interleaved)
OCTAVE_NORETURN void	err_invalid_type (const char *op) const
std::size_t	get_numeric_element_size (std::size_t size) const

Protected Attributes
bool	m_interleaved

Detailed Description

Definition at line 89 of file mxarray.h.

Constructor & Destructor Documentation

mxArray_base() [1/2]

mxArray_base::mxArray_base ( bool  interleaved )

protected

Definition at line 379 of file mex.cc.

mxArray_base() [2/2]

mxArray_base::mxArray_base ( )

delete

~mxArray_base()

virtual mxArray_base::~mxArray_base ( )

virtualdefault

Member Function Documentation

add_field()

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

pure virtual

array_to_string()

virtual char* mxArray_base::array_to_string ( ) const

pure virtual

Referenced by mxArray::array_to_string().

as_mxArray()

virtual mxArray* mxArray_base::as_mxArray ( void  ) const

inlinevirtual

Definition at line 103 of file mxarray.h.

Referenced by mxArray::dup().

as_octave_value()

virtual octave_value mxArray_base::as_octave_value ( ) const

pure virtual

Referenced by mxArray::as_octave_value().

calc_single_subscript()

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

pure virtual

Referenced by mxArray::calc_single_subscript().

dup()

virtual mxArray_base* mxArray_base::dup ( ) const

pure virtual

Referenced by mxArray::dup().

err_invalid_type()

OCTAVE_NORETURN void mxArray_base::err_invalid_type ( const char *  op ) const

inlineprotected

Definition at line 302 of file mxarray.h.

References error().

get_cell()

virtual mxArray* mxArray_base::get_cell ( mwIndex  ) const

inlinevirtual

Definition at line 207 of file mxarray.h.

get_class_id()

virtual mxClassID mxArray_base::get_class_id ( ) const

pure virtual

Referenced by mxArray::get_class_id().

get_class_name()

virtual const char* mxArray_base::get_class_name ( ) const

pure virtual

Referenced by mxArray::get_class_name().

get_complex_doubles()

virtual mxComplexDouble* mxArray_base::get_complex_doubles ( ) const

pure virtual

get_complex_singles()

virtual mxComplexSingle* mxArray_base::get_complex_singles ( ) const

pure virtual

get_data()

virtual void* mxArray_base::get_data ( ) const

pure virtual

get_dimensions()

virtual mwSize* mxArray_base::get_dimensions ( ) const

pure virtual

Referenced by mxArray::get_dimensions().

get_doubles()

virtual mxDouble* mxArray_base::get_doubles ( ) const

pure virtual

get_element_size()

virtual std::size_t mxArray_base::get_element_size ( ) const

pure virtual

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

get_field_name_by_number()

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

pure virtual

get_field_number()

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

pure virtual

get_imag_data()

virtual void* mxArray_base::get_imag_data ( ) const

pure virtual

get_int16s()

virtual mxInt16* mxArray_base::get_int16s ( ) const

pure virtual

get_int32s()

virtual mxInt32* mxArray_base::get_int32s ( ) const

pure virtual

get_int64s()

virtual mxInt64* mxArray_base::get_int64s ( ) const

pure virtual

get_int8s()

virtual mxInt8* mxArray_base::get_int8s ( ) const

pure virtual

get_ir()

virtual mwIndex* mxArray_base::get_ir ( ) const

pure virtual

get_jc()

virtual mwIndex* mxArray_base::get_jc ( ) const

pure virtual

get_m()

virtual mwSize mxArray_base::get_m ( ) const

pure virtual

Referenced by mxArray::get_m().

get_n()

virtual mwSize mxArray_base::get_n ( ) const

pure virtual

Referenced by mxArray::get_n().

get_number_of_dimensions()

virtual mwSize mxArray_base::get_number_of_dimensions ( ) const

pure virtual

Referenced by mxArray::get_number_of_dimensions().

get_number_of_elements()

virtual mwSize mxArray_base::get_number_of_elements ( ) const

pure virtual

Referenced by mxArray::get_number_of_elements().

get_number_of_fields()

virtual int mxArray_base::get_number_of_fields ( ) const

pure virtual

Referenced by mxArray::get_number_of_fields().

get_numeric_element_size()

std::size_t mxArray_base::get_numeric_element_size ( std::size_t  size ) const

inlineprotected

Definition at line 295 of file mxarray.h.

get_nzmax()

virtual mwSize mxArray_base::get_nzmax ( ) const

pure virtual

Referenced by mxArray::get_nzmax().

get_property()

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

inlinevirtual

Definition at line 196 of file mxarray.h.

Referenced by mxArray::get_property().

get_scalar()

virtual double mxArray_base::get_scalar ( ) const

pure virtual

Referenced by mxArray::get_scalar().

get_singles()

virtual mxSingle* mxArray_base::get_singles ( ) const

pure virtual

get_string()

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

pure virtual

Referenced by mxArray::get_string().

get_uint16s()

virtual mxUint16* mxArray_base::get_uint16s ( ) const

pure virtual

get_uint32s()

virtual mxUint32* mxArray_base::get_uint32s ( ) const

pure virtual

get_uint64s()

virtual mxUint64* mxArray_base::get_uint64s ( ) const

pure virtual

get_uint8s()

virtual mxUint8* mxArray_base::get_uint8s ( ) const

pure virtual

is_char()

virtual int mxArray_base::is_char ( ) const

pure virtual

Referenced by mxArray::is_char().

is_class()

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

inlinevirtual

Definition at line 113 of file mxarray.h.

References strcmp().

Referenced by mxArray::is_class().

is_complex()

virtual int mxArray_base::is_complex ( ) const

pure virtual

Referenced by mxArray::is_complex().

is_double()

virtual int mxArray_base::is_double ( ) const

pure virtual

Referenced by mxArray::is_double().

is_function_handle()

virtual int mxArray_base::is_function_handle ( ) const

pure virtual

Referenced by mxArray::is_function_handle().

is_int16()

virtual int mxArray_base::is_int16 ( ) const

pure virtual

Referenced by mxArray::is_int16().

is_int32()

virtual int mxArray_base::is_int32 ( ) const

pure virtual

Referenced by mxArray::is_int32().

is_int64()

virtual int mxArray_base::is_int64 ( ) const

pure virtual

Referenced by mxArray::is_int64().

is_int8()

virtual int mxArray_base::is_int8 ( ) const

pure virtual

Referenced by mxArray::is_int8().

is_logical()

virtual int mxArray_base::is_logical ( ) const

pure virtual

Referenced by mxArray::is_logical().

is_logical_scalar()

virtual int mxArray_base::is_logical_scalar ( ) const

inlinevirtual

Definition at line 157 of file mxarray.h.

Referenced by mxArray::is_logical_scalar().

is_logical_scalar_true()

virtual int mxArray_base::is_logical_scalar_true ( ) const

pure virtual

Referenced by mxArray::is_logical_scalar_true().

is_numeric()

virtual int mxArray_base::is_numeric ( ) const

pure virtual

Referenced by mxArray::is_numeric().

is_octave_value()

virtual bool mxArray_base::is_octave_value ( void  ) const

inlinevirtual

Definition at line 107 of file mxarray.h.

Referenced by mxArray::is_octave_value().

is_scalar()

virtual bool mxArray_base::is_scalar ( ) const

pure virtual

Referenced by mxArray::is_scalar().

is_single()

virtual int mxArray_base::is_single ( ) const

pure virtual

Referenced by mxArray::is_single().

is_sparse()

virtual int mxArray_base::is_sparse ( ) const

pure virtual

Referenced by mxArray::is_sparse().

is_struct()

virtual int mxArray_base::is_struct ( ) const

pure virtual

Referenced by mxArray::is_struct().

is_uint16()

virtual int mxArray_base::is_uint16 ( ) const

pure virtual

Referenced by mxArray::is_uint16().

is_uint32()

virtual int mxArray_base::is_uint32 ( ) const

pure virtual

Referenced by mxArray::is_uint32().

is_uint64()

virtual int mxArray_base::is_uint64 ( ) const

pure virtual

Referenced by mxArray::is_uint64().

is_uint8()

virtual int mxArray_base::is_uint8 ( ) const

pure virtual

Referenced by mxArray::is_uint8().

iscell()

virtual int mxArray_base::iscell ( ) const

pure virtual

Referenced by mxArray::iscell().

isempty()

virtual int mxArray_base::isempty ( ) const

pure virtual

mutate()

virtual mxArray* mxArray_base::mutate ( void  ) const

inlinevirtual

Definition at line 289 of file mxarray.h.

Referenced by mxArray::mutate().

mutation_needed()

virtual bool mxArray_base::mutation_needed ( void  ) const

inlinevirtual

Definition at line 287 of file mxarray.h.

Referenced by mxArray::mutation_needed().

remove_field()

virtual void mxArray_base::remove_field ( int  key_num )

pure virtual

set_cell()

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

pure virtual

set_class_name()

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

pure virtual

set_complex_doubles()

virtual int mxArray_base::set_complex_doubles ( mxComplexDouble *  data )

pure virtual

set_complex_singles()

virtual int mxArray_base::set_complex_singles ( mxComplexSingle *  data )

pure virtual

set_data()

virtual void mxArray_base::set_data ( void *  pr )

pure virtual

set_dimensions()

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

pure virtual

set_doubles()

virtual int mxArray_base::set_doubles ( mxDouble *  data )

pure virtual

set_field_by_number()

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

pure virtual

set_imag_data()

virtual void mxArray_base::set_imag_data ( void *  pi )

pure virtual

set_int16s()

virtual int mxArray_base::set_int16s ( mxInt16 *  data )

pure virtual

set_int32s()

virtual int mxArray_base::set_int32s ( mxInt32 *  data )

pure virtual

set_int64s()

virtual int mxArray_base::set_int64s ( mxInt64 *  data )

pure virtual

set_int8s()

virtual int mxArray_base::set_int8s ( mxInt8 *  data )

pure virtual

set_ir()

virtual void mxArray_base::set_ir ( mwIndex *  ir )

pure virtual

set_jc()

virtual void mxArray_base::set_jc ( mwIndex *  jc )

pure virtual

set_m()

virtual void mxArray_base::set_m ( mwSize  m )

pure virtual

set_n()

virtual void mxArray_base::set_n ( mwSize  n )

pure virtual

set_nzmax()

virtual void mxArray_base::set_nzmax ( mwSize  nzmax )

pure virtual

set_property()

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

inlinevirtual

Definition at line 201 of file mxarray.h.

Referenced by mxArray::set_property().

set_singles()

virtual int mxArray_base::set_singles ( mxSingle *  data )

pure virtual

set_uint16s()

virtual int mxArray_base::set_uint16s ( mxUint16 *  data )

pure virtual

set_uint32s()

virtual int mxArray_base::set_uint32s ( mxUint32 *  data )

pure virtual

set_uint64s()

virtual int mxArray_base::set_uint64s ( mxUint64 *  data )

pure virtual

set_uint8s()

virtual int mxArray_base::set_uint8s ( mxUint8 *  data )

pure virtual

Member Data Documentation

m_interleaved

bool mxArray_base::m_interleaved

protected

Definition at line 310 of file mxarray.h.

---

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

• libinterp/corefcn/mxarray.h
• libinterp/corefcn/mex.cc