mxArray_matlab Class Reference

Inheritance diagram for mxArray_matlab:

Collaboration diagram for mxArray_matlab:

List of all members.

Public Member Functions
	~mxArray_matlab (void)
int	add_field (const char *)
char *	array_to_string (void) const
mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const
mxArray *	dup (void) const =0
mxArray *	get_cell (mwIndex) const
mxClassID	get_class_id (void) const
const char *	get_class_name (void) const
void *	get_data (void) const
mwSize *	get_dimensions (void) const
size_t	get_element_size (void) const
mxArray *	get_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
mwIndex *	get_ir (void) const
mwIndex *	get_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
double	get_scalar (void) const
int	get_string (char *, mwSize) const
int	is_cell (void) const
int	is_char (void) const
int	is_class (const char *name_arg) const
int	is_complex (void) const
int	is_double (void) const
int	is_empty (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
int	is_logical_scalar (void) const
int	is_logical_scalar_true (void) const
int	is_numeric (void) const
bool	is_octave_value (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
mxArray *	mutate (void) const
bool	mutation_needed (void) const
void	remove_field (int)
void	set_cell (mwIndex, mxArray *)
void	set_class_name (const char *name_arg)
void	set_data (void *)
void	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)
Protected Member Functions
	mxArray_matlab (mxClassID id_arg=mxUNKNOWN_CLASS)
	mxArray_matlab (mxClassID id_arg, mwSize ndims_arg, const mwSize *dims_arg)
	mxArray_matlab (mxClassID id_arg, mwSize m, mwSize n)
	mxArray_matlab (const mxArray_matlab &val)
	mxArray_matlab (mxClassID id_arg, const dim_vector &dv)
octave_value	as_octave_value (void) const =0
dim_vector	dims_to_dim_vector (void) const
void	error (const char *msg) const
Private Member Functions
void	invalid_type_error (void) const
mxArray_matlab &	operator= (const mxArray_matlab &)
Private Attributes
char *	class_name
mwSize *	dims
mxClassID	id
mwSize	ndims

---

Detailed Description

Definition at line 736 of file mex.cc.

---

Constructor & Destructor Documentation

mxArray_matlab::mxArray_matlab

(

mxClassID

id_arg = mxUNKNOWN_CLASS

)

[inline, protected]

Definition at line 740 of file mex.cc.

mxArray_matlab::mxArray_matlab	(	mxClassID	id_arg,
		mwSize	ndims_arg,
		const mwSize *	dims_arg
	)			[inline, protected]

Definition at line 743 of file mex.cc.

References dims, and ndims.

mxArray_matlab::mxArray_matlab	(	mxClassID	id_arg,
		const dim_vector &	dv
	)			[inline, protected]

Definition at line 766 of file mex.cc.

References dims, and ndims.

mxArray_matlab::mxArray_matlab	(	mxClassID	id_arg,
		mwSize	m,
		mwSize	n
	)			[inline, protected]

Definition at line 783 of file mex.cc.

References dims.

mxArray_matlab::~mxArray_matlab

(

void

)

[inline]

Definition at line 793 of file mex.cc.

References class_name, dims, and mxFree().

mxArray_matlab::mxArray_matlab

(

const mxArray_matlab &

val

)

[inline, protected]

Definition at line 1071 of file mex.cc.

References dims, and ndims.

---

Member Function Documentation

int mxArray_matlab::add_field

(

const char *

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 990 of file mex.cc.

References invalid_type_error().

char* mxArray_matlab::array_to_string

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 1035 of file mex.cc.

References invalid_type_error().

octave_value mxArray_base::as_octave_value

(

void

)

const [protected, pure virtual, inherited]

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

mwIndex mxArray_matlab::calc_single_subscript	(	mwSize	nsubs,
		mwIndex *	subs
	)			const [inline, virtual]

Implements mxArray_base.

Definition at line 1041 of file mex.cc.

References calc_single_subscript_internal(), dims, and ndims.

dim_vector mxArray_matlab::dims_to_dim_vector

(

void

)

const [inline, protected]

Definition at line 1081 of file mex.cc.

References d, get_dimensions(), get_number_of_dimensions(), and dim_vector::resize().

Referenced by mxArray_cell::as_octave_value(), mxArray_struct::as_octave_value(), mxArray_sparse::as_octave_value(), and mxArray_number::as_octave_value().

mxArray* mxArray_base::dup

(

void

)

const [pure virtual, inherited]

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

void mxArray_base::error

(

const char *

msg

)

const [inline, protected, inherited]

Definition at line 270 of file mex.cc.

Referenced by mxArray_sparse::as_octave_value(), mxArray_number::int_to_ov(), invalid_type_error(), and mxArray_base::invalid_type_error().

mxArray* mxArray_matlab::get_cell

(

mwIndex

)

const [inline]

Reimplemented from mxArray_base.

Reimplemented in mxArray_cell.

Definition at line 918 of file mex.cc.

References invalid_type_error().

mxClassID mxArray_matlab::get_class_id

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 886 of file mex.cc.

References id.

Referenced by mxArray_sparse::as_octave_value(), mxArray_number::as_octave_value(), and mxArray_number::get_scalar().

const char* mxArray_matlab::get_class_name

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 888 of file mex.cc.

void* mxArray_matlab::get_data

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number, mxArray_sparse, mxArray_struct, and mxArray_cell.

Definition at line 935 of file mex.cc.

References invalid_type_error().

Referenced by is_logical_scalar_true().

mwSize* mxArray_matlab::get_dimensions

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 860 of file mex.cc.

References dims.

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

size_t mxArray_matlab::get_element_size

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 1046 of file mex.cc.

Referenced by mxArray_number::mxArray_number(), and mxArray_sparse::mxArray_sparse().

mxArray* mxArray_matlab::get_field_by_number	(	mwIndex	,
		int
	)			const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1001 of file mex.cc.

References invalid_type_error().

const char* mxArray_matlab::get_field_name_by_number

(

int

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1018 of file mex.cc.

References invalid_type_error().

int mxArray_matlab::get_field_number

(

const char *

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1024 of file mex.cc.

void* mxArray_matlab::get_imag_data

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number, and mxArray_sparse.

Definition at line 941 of file mex.cc.

References invalid_type_error().

mwIndex* mxArray_matlab::get_ir

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 957 of file mex.cc.

References invalid_type_error().

mwIndex* mxArray_matlab::get_jc

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 963 of file mex.cc.

References invalid_type_error().

mwSize mxArray_matlab::get_m

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 848 of file mex.cc.

References dims.

Referenced by mxArray_sparse::as_octave_value().

mwSize mxArray_matlab::get_n

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 850 of file mex.cc.

References dims, and ndims.

Referenced by mxArray_sparse::as_octave_value(), and mxArray_sparse::mxArray_sparse().

mwSize mxArray_matlab::get_number_of_dimensions

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 862 of file mex.cc.

References ndims.

Referenced by dims_to_dim_vector().

mwSize mxArray_matlab::get_number_of_elements

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 874 of file mex.cc.

References dims, and ndims.

Referenced by mxArray_struct::add_field(), mxArray_number::array_to_string(), mxArray_cell::as_octave_value(), mxArray_struct::as_octave_value(), mxArray_number::as_octave_value(), mxArray_cell::get_cell(), mxArray_number::get_string(), mxArray_number::int_to_ov(), is_empty(), mxArray_cell::mxArray_cell(), mxArray_number::mxArray_number(), mxArray_struct::mxArray_struct(), mxArray_struct::remove_field(), mxArray_cell::set_cell(), mxArray_cell::~mxArray_cell(), and mxArray_struct::~mxArray_struct().

int mxArray_matlab::get_number_of_fields

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1012 of file mex.cc.

References invalid_type_error().

mwSize mxArray_matlab::get_nzmax

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 969 of file mex.cc.

References invalid_type_error().

double mxArray_matlab::get_scalar

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 929 of file mex.cc.

References invalid_type_error().

int mxArray_matlab::get_string	(	char *	,
		mwSize
	)			const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 1029 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::invalid_type_error

(

void

)

const [inline, private]

Reimplemented from mxArray_base.

Definition at line 1105 of file mex.cc.

References mxArray_base::error().

Referenced by add_field(), array_to_string(), get_cell(), get_data(), get_field_by_number(), get_field_name_by_number(), get_imag_data(), get_ir(), get_jc(), get_number_of_fields(), get_nzmax(), get_scalar(), get_string(), remove_field(), set_cell(), set_data(), set_field_by_number(), set_imag_data(), set_ir(), set_jc(), and set_nzmax().

int mxArray_matlab::is_cell

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 799 of file mex.cc.

int mxArray_matlab::is_char

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 801 of file mex.cc.

int mxArray_base::is_class

(

const char *

name_arg

)

const [inline, inherited]

Definition at line 128 of file mex.cc.

References mxArray_base::get_class_name().

int mxArray_matlab::is_complex

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number, and mxArray_sparse.

Definition at line 803 of file mex.cc.

int mxArray_matlab::is_double

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 805 of file mex.cc.

int mxArray_matlab::is_empty

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 884 of file mex.cc.

References get_number_of_elements().

int mxArray_matlab::is_function_handle

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 807 of file mex.cc.

int mxArray_matlab::is_int16

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 809 of file mex.cc.

int mxArray_matlab::is_int32

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 811 of file mex.cc.

int mxArray_matlab::is_int64

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 813 of file mex.cc.

int mxArray_matlab::is_int8

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 815 of file mex.cc.

int mxArray_matlab::is_logical

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 817 of file mex.cc.

int mxArray_base::is_logical_scalar

(

void

)

const [inline, inherited]

Definition at line 172 of file mex.cc.

References mxArray_base::get_number_of_elements(), and mxArray_base::is_logical().

Referenced by is_logical_scalar_true(), and mxArray_octave_value::is_logical_scalar_true().

int mxArray_matlab::is_logical_scalar_true

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 842 of file mex.cc.

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

int mxArray_matlab::is_numeric

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 819 of file mex.cc.

bool mxArray_base::is_octave_value

(

void

)

const [inline, inherited]

Reimplemented in mxArray_octave_value.

Definition at line 122 of file mex.cc.

int mxArray_matlab::is_single

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 828 of file mex.cc.

int mxArray_matlab::is_sparse

(

void

)

const [inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 830 of file mex.cc.

int mxArray_matlab::is_struct

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 832 of file mex.cc.

int mxArray_matlab::is_uint16

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 834 of file mex.cc.

int mxArray_matlab::is_uint32

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 836 of file mex.cc.

int mxArray_matlab::is_uint64

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 838 of file mex.cc.

int mxArray_matlab::is_uint8

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 840 of file mex.cc.

mxArray* mxArray_base::mutate

(

void

)

const [inline, inherited]

Reimplemented in mxArray_octave_value.

Definition at line 257 of file mex.cc.

bool mxArray_base::mutation_needed

(

void

)

const [inline, inherited]

Reimplemented in mxArray_octave_value.

Definition at line 255 of file mex.cc.

mxArray_matlab& mxArray_matlab::operator=

(

const mxArray_matlab &

)

[private]

void mxArray_matlab::remove_field

(

int

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 996 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_cell	(	mwIndex	,
		mxArray *
	)			[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_cell.

Definition at line 924 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_class_name

(

const char *

name_arg

)

[inline, virtual]

Implements mxArray_base.

Definition at line 911 of file mex.cc.

References class_name, and mxFree().

void mxArray_matlab::set_data

(

void *

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number, mxArray_sparse, mxArray_struct, and mxArray_cell.

Definition at line 947 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_dimensions	(	mwSize *	dims_arg,
		mwSize	ndims_arg
	)			[inline, virtual]

Implements mxArray_base.

Definition at line 868 of file mex.cc.

References dims, and ndims.

void mxArray_matlab::set_field_by_number	(	mwIndex	,
		int	,
		mxArray *
	)			[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1007 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_imag_data

(

void *

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_number, and mxArray_sparse.

Definition at line 952 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_ir

(

mwIndex *

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 975 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_jc

(

mwIndex *

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 980 of file mex.cc.

References invalid_type_error().

void mxArray_matlab::set_m

(

mwSize

m

)

[inline, virtual]

Implements mxArray_base.

Definition at line 864 of file mex.cc.

References dims.

void mxArray_matlab::set_n

(

mwSize

n

)

[inline, virtual]

Implements mxArray_base.

Definition at line 866 of file mex.cc.

References dims.

void mxArray_matlab::set_nzmax

(

mwSize

)

[inline, virtual]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 985 of file mex.cc.

References invalid_type_error().

---

Member Data Documentation

char* mxArray_matlab::class_name [private]

Definition at line 1098 of file mex.cc.

Referenced by set_class_name(), and ~mxArray_matlab().

mwSize* mxArray_matlab::dims [private]

Definition at line 1103 of file mex.cc.

Referenced by calc_single_subscript(), get_dimensions(), get_m(), get_n(), get_number_of_elements(), mxArray_matlab(), set_dimensions(), set_m(), set_n(), and ~mxArray_matlab().

mxClassID mxArray_matlab::id [private]

Definition at line 1100 of file mex.cc.

Referenced by get_class_id().

mwSize mxArray_matlab::ndims [private]

Definition at line 1102 of file mex.cc.

Referenced by calc_single_subscript(), get_n(), get_number_of_dimensions(), get_number_of_elements(), mxArray_matlab(), and set_dimensions().

---

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

• src/mex.cc