mxArray_base Class Reference

Inherits mxArray.

Inherited by mxArray_matlab, and mxArray_octave_value.

Collaboration diagram for mxArray_base:

[legend]

List of all members.

Public Member Functions
mxArray *	clone (void) const =0
	~mxArray_base (void)
bool	is_octave_value (void) const
int	is_cell (void) const =0
int	is_char (void) const =0
int	is_class (const char *name_arg) const
int	is_complex (void) const =0
int	is_double (void) const =0
int	is_int16 (void) const =0
int	is_int32 (void) const =0
int	is_int64 (void) const =0
int	is_int8 (void) const =0
int	is_logical (void) const =0
int	is_numeric (void) const =0
int	is_single (void) const =0
int	is_sparse (void) const =0
int	is_struct (void) const =0
int	is_uint16 (void) const =0
int	is_uint32 (void) const =0
int	is_uint64 (void) const =0
int	is_uint8 (void) const =0
int	is_logical_scalar (void) const
int	is_logical_scalar_true (void) const =0
mwSize	get_m (void) const =0
mwSize	get_n (void) const =0
mwSize *	get_dimensions (void) const =0
mwSize	get_number_of_dimensions (void) const =0
void	set_m (mwSize m)=0
void	set_n (mwSize n)=0
void	set_dimensions (mwSize *dims_arg, mwSize ndims_arg)=0
mwSize	get_number_of_elements (void) const =0
int	is_empty (void) const =0
mxClassID	get_class_id (void) const =0
const char *	get_class_name (void) const =0
void	set_class_name (const char *name_arg)=0
mxArray *	get_cell (mwIndex) const
void	set_cell (mwIndex idx, mxArray *val)=0
double	get_scalar (void) const =0
void *	get_data (void) const =0
void *	get_imag_data (void) const =0
void	set_data (void *pr)=0
void	set_imag_data (void *pi)=0
mwIndex *	get_ir (void) const =0
mwIndex *	get_jc (void) const =0
mwSize	get_nzmax (void) const =0
void	set_ir (mwIndex *ir)=0
void	set_jc (mwIndex *jc)=0
void	set_nzmax (mwSize nzmax)=0
int	add_field (const char *key)=0
void	remove_field (int key_num)=0
mxArray *	get_field_by_number (mwIndex index, int key_num) const =0
void	set_field_by_number (mwIndex index, int key_num, mxArray *val)=0
int	get_number_of_fields (void) const =0
const char *	get_field_name_by_number (int key_num) const =0
int	get_field_number (const char *key) const =0
int	get_string (char *buf, mwSize buflen) const =0
char *	array_to_string (void) const =0
mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const =0
size_t	get_element_size (void) const =0
bool	mutation_needed (void) const
mxArray *	mutate (void) const
Protected Member Functions
	mxArray_base (void)
octave_value	as_octave_value (void) const =0
	mxArray_base (const mxArray_base &)
void	invalid_type_error (void) const
void	error (const char *msg) const

---

Constructor & Destructor Documentation

mxArray_base::mxArray_base

(

void

)

[inline, protected]

mxArray_base::~mxArray_base

(

void

)

[inline]

mxArray_base::mxArray_base

(

const mxArray_base &

)

[inline, protected]

---

Member Function Documentation

int mxArray_base::add_field

(

const char *

key

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

char* mxArray_base::array_to_string

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_number.

octave_value mxArray_base::as_octave_value

(

void

)

const [protected, pure virtual]

Reimplemented from mxArray.

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

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

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

mxArray* mxArray_base::clone

(

void

)

const [pure virtual]

Reimplemented from mxArray.

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

void mxArray_base::error

(

const char *

msg

)

const [inline, protected]

mxArray* mxArray_base::get_cell

(

mwIndex

)

const [inline, virtual]

Reimplemented from mxArray.

Reimplemented in mxArray_octave_value, mxArray_matlab, and mxArray_cell.

mxClassID mxArray_base::get_class_id

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

const char* mxArray_base::get_class_name

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

void* mxArray_base::get_data

(

void

)

const [pure virtual]

Reimplemented from mxArray.

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

mwSize* mxArray_base::get_dimensions

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

size_t mxArray_base::get_element_size

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

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

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

const char* mxArray_base::get_field_name_by_number

(

int

key_num

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

int mxArray_base::get_field_number

(

const char *

key

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

void* mxArray_base::get_imag_data

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, mxArray_number, and mxArray_sparse.

mwIndex* mxArray_base::get_ir

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

mwIndex* mxArray_base::get_jc

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

mwSize mxArray_base::get_m

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

mwSize mxArray_base::get_n

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

mwSize mxArray_base::get_number_of_dimensions

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

mwSize mxArray_base::get_number_of_elements

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::get_number_of_fields

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

mwSize mxArray_base::get_nzmax

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

double mxArray_base::get_scalar

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_number.

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

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_number.

void mxArray_base::invalid_type_error

(

void

)

const [inline, protected]

int mxArray_base::is_cell

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_char

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_class

(

const char *

name_arg

)

const [inline, virtual]

Reimplemented from mxArray.

int mxArray_base::is_complex

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, mxArray_number, and mxArray_sparse.

int mxArray_base::is_double

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_empty

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_int16

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_int32

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_int64

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_int8

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_logical

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_logical_scalar

(

void

)

const [inline, virtual]

Reimplemented from mxArray.

int mxArray_base::is_logical_scalar_true

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_numeric

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

bool mxArray_base::is_octave_value

(

void

)

const [inline, virtual]

Reimplemented from mxArray.

Reimplemented in mxArray_octave_value.

int mxArray_base::is_single

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_sparse

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

int mxArray_base::is_struct

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_uint16

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_uint32

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_uint64

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

int mxArray_base::is_uint8

(

void

)

const [pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

mxArray* mxArray_base::mutate

(

void

)

const [inline, virtual]

Reimplemented from mxArray.

Reimplemented in mxArray_octave_value.

bool mxArray_base::mutation_needed

(

void

)

const [inline, virtual]

Reimplemented from mxArray.

Reimplemented in mxArray_octave_value.

void mxArray_base::remove_field

(

int

key_num

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

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

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_cell.

void mxArray_base::set_class_name

(

const char *

name_arg

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

void mxArray_base::set_data

(

void *

pr

)

[pure virtual]

Reimplemented from mxArray.

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

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

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

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

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_struct.

void mxArray_base::set_imag_data

(

void *

pi

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, mxArray_number, and mxArray_sparse.

void mxArray_base::set_ir

(

mwIndex *

ir

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

void mxArray_base::set_jc

(

mwIndex *

jc

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

void mxArray_base::set_m

(

mwSize

m

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

void mxArray_base::set_n

(

mwSize

n

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, and mxArray_matlab.

void mxArray_base::set_nzmax

(

mwSize

nzmax

)

[pure virtual]

Reimplemented from mxArray.

Implemented in mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

---

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

• mex.cc