mxArray_struct Class Reference

Inheritance diagram for mxArray_struct:

Collaboration diagram for mxArray_struct:

List of all members.

Public Member Functions
	mxArray_struct (mwSize ndims_arg, const mwSize *dims_arg, int num_keys_arg, const char **keys)
	mxArray_struct (const dim_vector &dv, int num_keys_arg, const char **keys)
	mxArray_struct (mwSize m, mwSize n, int num_keys_arg, const char **keys)
	~mxArray_struct (void)
int	add_field (const char *key)
char *	array_to_string (void) const
mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const
mxArray_struct *	dup (void) const
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 index, int key_num) const
const char *	get_field_name_by_number (int key_num) const
int	get_field_number (const char *key) 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
void	init (const char **keys)
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 key_num)
void	set_cell (mwIndex, mxArray *)
void	set_class_name (const char *name_arg)
void	set_data (void *data_arg)
void	set_dimensions (mwSize *dims_arg, mwSize ndims_arg)
void	set_field_by_number (mwIndex index, int key_num, mxArray *val)
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
octave_value	as_octave_value (void) const
dim_vector	dims_to_dim_vector (void) const
void	error (const char *msg) const
Private Member Functions
	mxArray_struct (const mxArray_struct &val)
mxArray_struct &	operator= (const mxArray_struct &val)
Private Attributes
mxArray **	data
char **	fields
int	nfields

---

Detailed Description

Definition at line 1682 of file mex.cc.

---

Constructor & Destructor Documentation

mxArray_struct::mxArray_struct	(	mwSize	ndims_arg,
		const mwSize *	dims_arg,
		int	num_keys_arg,
		const char **	keys
	)			[inline]

Definition at line 1686 of file mex.cc.

References init().

Referenced by dup().

mxArray_struct::mxArray_struct	(	const dim_vector &	dv,
		int	num_keys_arg,
		const char **	keys
	)			[inline]

Definition at line 1695 of file mex.cc.

References init().

mxArray_struct::mxArray_struct	(	mwSize	m,
		mwSize	n,
		int	num_keys_arg,
		const char **	keys
	)			[inline]

Definition at line 1703 of file mex.cc.

References init().

mxArray_struct::~mxArray_struct

(

void

)

[inline]

Definition at line 1719 of file mex.cc.

References data, fields, mxArray_matlab::get_number_of_elements(), mxFree(), and nfields.

mxArray_struct::mxArray_struct

(

const mxArray_struct &

val

)

[inline, private]

Definition at line 1902 of file mex.cc.

References data, fields, mxArray_matlab::get_number_of_elements(), nfields, and strsave().

---

Member Function Documentation

int mxArray_struct::add_field

(

const char *

key

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1734 of file mex.cc.

References data, fields, mxArray_matlab::get_number_of_elements(), mxFree(), mxRealloc(), nfields, strsave(), and valid_key().

char* mxArray_matlab::array_to_string

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 1035 of file mex.cc.

References mxArray_matlab::invalid_type_error().

octave_value mxArray_struct::as_octave_value

(

void

)

const [inline, protected, virtual]

Implements mxArray_base.

Definition at line 1868 of file mex.cc.

References octave_map::assign(), data, mxArray_matlab::dims_to_dim_vector(), fields, Array< T >::fortran_vec(), mxArray_matlab::get_number_of_elements(), and nfields.

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

Implements mxArray_base.

Definition at line 1041 of file mex.cc.

References calc_single_subscript_internal(), mxArray_matlab::dims, and mxArray_matlab::ndims.

dim_vector mxArray_matlab::dims_to_dim_vector

(

void

)

const [inline, protected, inherited]

Definition at line 1081 of file mex.cc.

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

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

mxArray_struct* mxArray_struct::dup

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 1717 of file mex.cc.

References mxArray_struct().

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(), mxArray_matlab::invalid_type_error(), and mxArray_base::invalid_type_error().

mxArray* mxArray_matlab::get_cell

(

mwIndex

)

const [inline, inherited]

Reimplemented from mxArray_base.

Reimplemented in mxArray_cell.

Definition at line 918 of file mex.cc.

References mxArray_matlab::invalid_type_error().

mxClassID mxArray_matlab::get_class_id

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 886 of file mex.cc.

References mxArray_matlab::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, inherited]

Implements mxArray_base.

Definition at line 888 of file mex.cc.

void* mxArray_struct::get_data

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1862 of file mex.cc.

References data.

mwSize* mxArray_matlab::get_dimensions

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 860 of file mex.cc.

References mxArray_matlab::dims.

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

size_t mxArray_matlab::get_element_size

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 1046 of file mex.cc.

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

mxArray* mxArray_struct::get_field_by_number	(	mwIndex	index,
		int	key_num
	)			const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1831 of file mex.cc.

References data, and nfields.

const char* mxArray_struct::get_field_name_by_number

(

int

key_num

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1841 of file mex.cc.

References fields, and nfields.

int mxArray_struct::get_field_number

(

const char *

key

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1846 of file mex.cc.

References fields, and nfields.

void* mxArray_matlab::get_imag_data

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_number, and mxArray_sparse.

Definition at line 941 of file mex.cc.

References mxArray_matlab::invalid_type_error().

mwIndex* mxArray_matlab::get_ir

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 957 of file mex.cc.

References mxArray_matlab::invalid_type_error().

mwIndex* mxArray_matlab::get_jc

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 963 of file mex.cc.

References mxArray_matlab::invalid_type_error().

mwSize mxArray_matlab::get_m

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 848 of file mex.cc.

References mxArray_matlab::dims.

Referenced by mxArray_sparse::as_octave_value().

mwSize mxArray_matlab::get_n

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 850 of file mex.cc.

References mxArray_matlab::dims, and mxArray_matlab::ndims.

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

mwSize mxArray_matlab::get_number_of_dimensions

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 862 of file mex.cc.

References mxArray_matlab::ndims.

Referenced by mxArray_matlab::dims_to_dim_vector().

mwSize mxArray_matlab::get_number_of_elements

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 874 of file mex.cc.

References mxArray_matlab::dims, and mxArray_matlab::ndims.

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

int mxArray_struct::get_number_of_fields

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1839 of file mex.cc.

References nfields.

mwSize mxArray_matlab::get_nzmax

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 969 of file mex.cc.

References mxArray_matlab::invalid_type_error().

double mxArray_matlab::get_scalar

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 929 of file mex.cc.

References mxArray_matlab::invalid_type_error().

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

Implements mxArray_base.

Reimplemented in mxArray_number.

Definition at line 1029 of file mex.cc.

References mxArray_matlab::invalid_type_error().

void mxArray_struct::init

(

const char **

keys

)

[inline]

Definition at line 1711 of file mex.cc.

References fields, nfields, and strsave().

Referenced by mxArray_struct().

int mxArray_matlab::is_cell

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 799 of file mex.cc.

int mxArray_matlab::is_char

(

void

)

const [inline, virtual, inherited]

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, inherited]

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, inherited]

Implements mxArray_base.

Definition at line 805 of file mex.cc.

int mxArray_matlab::is_empty

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 884 of file mex.cc.

References mxArray_matlab::get_number_of_elements().

int mxArray_matlab::is_function_handle

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 807 of file mex.cc.

int mxArray_matlab::is_int16

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 809 of file mex.cc.

int mxArray_matlab::is_int32

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 811 of file mex.cc.

int mxArray_matlab::is_int64

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 813 of file mex.cc.

int mxArray_matlab::is_int8

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 815 of file mex.cc.

int mxArray_matlab::is_logical

(

void

)

const [inline, virtual, inherited]

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 mxArray_matlab::is_logical_scalar_true(), and mxArray_octave_value::is_logical_scalar_true().

int mxArray_matlab::is_logical_scalar_true

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 842 of file mex.cc.

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

int mxArray_matlab::is_numeric

(

void

)

const [inline, virtual, inherited]

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, inherited]

Implements mxArray_base.

Definition at line 828 of file mex.cc.

int mxArray_matlab::is_sparse

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 830 of file mex.cc.

int mxArray_matlab::is_struct

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 832 of file mex.cc.

int mxArray_matlab::is_uint16

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 834 of file mex.cc.

int mxArray_matlab::is_uint32

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 836 of file mex.cc.

int mxArray_matlab::is_uint64

(

void

)

const [inline, virtual, inherited]

Implements mxArray_base.

Definition at line 838 of file mex.cc.

int mxArray_matlab::is_uint8

(

void

)

const [inline, virtual, inherited]

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_struct& mxArray_struct::operator=

(

const mxArray_struct &

val

)

[private]

void mxArray_struct::remove_field

(

int

key_num

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1783 of file mex.cc.

References data, fields, mxArray_matlab::get_number_of_elements(), mxFree(), and nfields.

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

Implements mxArray_base.

Reimplemented in mxArray_cell.

Definition at line 924 of file mex.cc.

References mxArray_matlab::invalid_type_error().

void mxArray_matlab::set_class_name

(

const char *

name_arg

)

[inline, virtual, inherited]

Implements mxArray_base.

Definition at line 911 of file mex.cc.

References mxArray_matlab::class_name, and mxFree().

void mxArray_struct::set_data

(

void *

data_arg

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1864 of file mex.cc.

References data.

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

Implements mxArray_base.

Definition at line 868 of file mex.cc.

References mxArray_matlab::dims, and mxArray_matlab::ndims.

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

Reimplemented from mxArray_matlab.

Definition at line 2476 of file mex.cc.

References data, maybe_unmark_array(), and nfields.

void mxArray_matlab::set_imag_data

(

void *

)

[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_number, and mxArray_sparse.

Definition at line 952 of file mex.cc.

References mxArray_matlab::invalid_type_error().

void mxArray_matlab::set_ir

(

mwIndex *

)

[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 975 of file mex.cc.

References mxArray_matlab::invalid_type_error().

void mxArray_matlab::set_jc

(

mwIndex *

)

[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 980 of file mex.cc.

References mxArray_matlab::invalid_type_error().

void mxArray_matlab::set_m

(

mwSize

m

)

[inline, virtual, inherited]

Implements mxArray_base.

Definition at line 864 of file mex.cc.

References mxArray_matlab::dims.

void mxArray_matlab::set_n

(

mwSize

n

)

[inline, virtual, inherited]

Implements mxArray_base.

Definition at line 866 of file mex.cc.

References mxArray_matlab::dims.

void mxArray_matlab::set_nzmax

(

mwSize

)

[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_sparse.

Definition at line 985 of file mex.cc.

References mxArray_matlab::invalid_type_error().

---

Member Data Documentation

mxArray** mxArray_struct::data [private]

Definition at line 1900 of file mex.cc.

Referenced by add_field(), as_octave_value(), get_data(), get_field_by_number(), mxArray_struct(), remove_field(), set_data(), set_field_by_number(), and ~mxArray_struct().

char** mxArray_struct::fields [private]

Definition at line 1898 of file mex.cc.

Referenced by add_field(), as_octave_value(), get_field_name_by_number(), get_field_number(), init(), mxArray_struct(), remove_field(), and ~mxArray_struct().

int mxArray_struct::nfields [private]

Definition at line 1896 of file mex.cc.

Referenced by add_field(), as_octave_value(), get_field_by_number(), get_field_name_by_number(), get_field_number(), get_number_of_fields(), init(), mxArray_struct(), remove_field(), set_field_by_number(), and ~mxArray_struct().

---

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

• src/mex.cc