mxArray Class Reference

#include <mxarray.h>

Inherited by mxArray_base.

Collaboration diagram for mxArray:

[legend]

List of all members.

Public Member Functions
	mxArray (const octave_value &ov)
	mxArray (mxClassID id, mwSize ndims, const mwSize *dims, mxComplexity flag=mxREAL)
	mxArray (mxClassID id, const dim_vector &dv, mxComplexity flag=mxREAL)
	mxArray (mxClassID id, mwSize m, mwSize n, mxComplexity flag=mxREAL)
	mxArray (mxClassID id, double val)
	mxArray (mxClassID id, mxLogical val)
	mxArray (const char *str)
	mxArray (mwSize m, const char **str)
	mxArray (mxClassID id, mwSize m, mwSize n, mwSize nzmax, mxComplexity flag=mxREAL)
	mxArray (mwSize ndims, const mwSize *dims, int num_keys, const char **keys)
	mxArray (const dim_vector &dv, int num_keys, const char **keys)
	mxArray (mwSize m, mwSize n, int num_keys, const char **keys)
	mxArray (mwSize ndims, const mwSize *dims)
	mxArray (const dim_vector &dv)
	mxArray (mwSize m, mwSize n)
virtual mxArray *	clone (void) const
virtual	~mxArray (void)
virtual bool	is_octave_value (void) const
virtual int	is_cell (void) const
virtual int	is_char (void) const
virtual int	is_class (const char *name_arg) const
virtual int	is_complex (void) const
virtual int	is_double (void) const
virtual int	is_int16 (void) const
virtual int	is_int32 (void) const
virtual int	is_int64 (void) const
virtual int	is_int8 (void) const
virtual int	is_logical (void) const
virtual int	is_numeric (void) const
virtual int	is_single (void) const
virtual int	is_sparse (void) const
virtual int	is_struct (void) const
virtual int	is_uint16 (void) const
virtual int	is_uint32 (void) const
virtual int	is_uint64 (void) const
virtual int	is_uint8 (void) const
virtual int	is_logical_scalar (void) const
virtual int	is_logical_scalar_true (void) const
virtual mwSize	get_m (void) const
virtual mwSize	get_n (void) const
virtual mwSize *	get_dimensions (void) const
virtual mwSize	get_number_of_dimensions (void) const
virtual void	set_m (mwSize m)
virtual void	set_n (mwSize n)
virtual void	set_dimensions (mwSize *dims_arg, mwSize ndims_arg)
virtual mwSize	get_number_of_elements (void) const
virtual int	is_empty (void) const
const char *	get_name (void) const
void	set_name (const char *name_arg)
virtual mxClassID	get_class_id (void) const
virtual const char *	get_class_name (void) const
virtual void	set_class_name (const char *name_arg)
virtual mxArray *	get_cell (mwIndex idx) const
virtual void	set_cell (mwIndex idx, mxArray *val)
virtual double	get_scalar (void) const
virtual void *	get_data (void) const
virtual void *	get_imag_data (void) const
virtual void	set_data (void *pr)
virtual void	set_imag_data (void *pi)
virtual mwIndex *	get_ir (void) const
virtual mwIndex *	get_jc (void) const
virtual mwSize	get_nzmax (void) const
virtual void	set_ir (mwIndex *ir)
virtual void	set_jc (mwIndex *jc)
virtual void	set_nzmax (mwSize nzmax)
virtual int	add_field (const char *key)
virtual void	remove_field (int key_num)
virtual mxArray *	get_field_by_number (mwIndex index, int key_num) const
virtual void	set_field_by_number (mwIndex index, int key_num, mxArray *val)
virtual int	get_number_of_fields (void) const
virtual const char *	get_field_name_by_number (int key_num) const
virtual int	get_field_number (const char *key) const
virtual int	get_string (char *buf, mwSize buflen) const
virtual char *	array_to_string (void) const
virtual mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const
virtual size_t	get_element_size (void) const
virtual bool	mutation_needed (void) const
virtual mxArray *	mutate (void) const
Static Public Member Functions
static void *	malloc (size_t n)
static void *	calloc (size_t n, size_t t)
static char *	strsave (const char *str)
static octave_value	as_octave_value (mxArray *ptr)
Protected Member Functions
virtual octave_value	as_octave_value (void) const
	mxArray (const xmxArray &)

---

Constructor & Destructor Documentation

mxArray::mxArray

(

const octave_value &

ov

)

mxArray::mxArray	(	mxClassID	id,
		mwSize	ndims,
		const mwSize *	dims,
		mxComplexity	flag = mxREAL
	)

mxArray::mxArray	(	mxClassID	id,
		const dim_vector &	dv,
		mxComplexity	flag = mxREAL
	)

mxArray::mxArray	(	mxClassID	id,
		mwSize	m,
		mwSize	n,
		mxComplexity	flag = mxREAL
	)

mxArray::mxArray	(	mxClassID	id,
		double	val
	)

mxArray::mxArray	(	mxClassID	id,
		mxLogical	val
	)

mxArray::mxArray

(

const char *

str

)

mxArray::mxArray	(	mwSize	m,
		const char **	str
	)

mxArray::mxArray	(	mxClassID	id,
		mwSize	m,
		mwSize	n,
		mwSize	nzmax,
		mxComplexity	flag = mxREAL
	)

mxArray::mxArray	(	mwSize	ndims,
		const mwSize *	dims,
		int	num_keys,
		const char **	keys
	)

mxArray::mxArray	(	const dim_vector &	dv,
		int	num_keys,
		const char **	keys
	)

mxArray::mxArray	(	mwSize	m,
		mwSize	n,
		int	num_keys,
		const char **	keys
	)

mxArray::mxArray	(	mwSize	ndims,
		const mwSize *	dims
	)

mxArray::mxArray

(

const dim_vector &

dv

)

mxArray::mxArray	(	mwSize	m,
		mwSize	n
	)

mxArray::~mxArray

(

void

)

[virtual]

mxArray::mxArray

(

const xmxArray &

)

[inline, protected]

---

Member Function Documentation

virtual int mxArray::add_field

(

const char *

key

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

virtual char* mxArray::array_to_string

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_number.

octave_value mxArray::as_octave_value

(

void

)

const [protected, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_number, mxArray_sparse, mxArray_struct, and mxArray_cell.

octave_value mxArray::as_octave_value

(

mxArray *

ptr

)

[static]

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

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

void * mxArray::calloc	(	size_t	n,
		size_t	t
	)			[static]

virtual mxArray* mxArray::clone

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_number, mxArray_sparse, mxArray_struct, and mxArray_cell.

virtual mxArray* mxArray::get_cell

(

mwIndex

idx

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_cell.

virtual mxClassID mxArray::get_class_id

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual const char* mxArray::get_class_name

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual void* mxArray::get_data

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, mxArray_number, mxArray_sparse, mxArray_struct, and mxArray_cell.

virtual mwSize* mxArray::get_dimensions

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual size_t mxArray::get_element_size

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

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

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

virtual const char* mxArray::get_field_name_by_number

(

int

key_num

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

virtual int mxArray::get_field_number

(

const char *

key

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

virtual void* mxArray::get_imag_data

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, mxArray_number, and mxArray_sparse.

virtual mwIndex* mxArray::get_ir

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

virtual mwIndex* mxArray::get_jc

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

virtual mwSize mxArray::get_m

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual mwSize mxArray::get_n

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

const char* mxArray::get_name

(

void

)

const [inline]

virtual mwSize mxArray::get_number_of_dimensions

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual mwSize mxArray::get_number_of_elements

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::get_number_of_fields

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

virtual mwSize mxArray::get_nzmax

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

virtual double mxArray::get_scalar

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_number.

virtual int mxArray::get_string	(	char *	buf,
		mwSize	buflen
	)			const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_number.

virtual int mxArray::is_cell

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_char

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_class

(

const char *

name_arg

)

const [inline, virtual]

Reimplemented in mxArray_base.

virtual int mxArray::is_complex

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, mxArray_number, and mxArray_sparse.

virtual int mxArray::is_double

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_empty

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_int16

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_int32

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_int64

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_int8

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_logical

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_logical_scalar

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base.

virtual int mxArray::is_logical_scalar_true

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_numeric

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual bool mxArray::is_octave_value

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, and mxArray_octave_value.

virtual int mxArray::is_single

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_sparse

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

virtual int mxArray::is_struct

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_uint16

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_uint32

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_uint64

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual int mxArray::is_uint8

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

void * mxArray::malloc

(

size_t

n

)

[static]

virtual mxArray* mxArray::mutate

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, and mxArray_octave_value.

virtual bool mxArray::mutation_needed

(

void

)

const [inline, virtual]

Reimplemented in mxArray_base, and mxArray_octave_value.

virtual void mxArray::remove_field

(

int

key_num

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

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

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_cell.

virtual void mxArray::set_class_name

(

const char *

name_arg

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual void mxArray::set_data

(

void *

pr

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, mxArray_number, mxArray_sparse, mxArray_struct, and mxArray_cell.

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

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

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

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_struct.

virtual void mxArray::set_imag_data

(

void *

pi

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, mxArray_number, and mxArray_sparse.

virtual void mxArray::set_ir

(

mwIndex *

ir

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

virtual void mxArray::set_jc

(

mwIndex *

jc

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

virtual void mxArray::set_m

(

mwSize

m

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

virtual void mxArray::set_n

(

mwSize

n

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, and mxArray_matlab.

void mxArray::set_name

(

const char *

name_arg

)

virtual void mxArray::set_nzmax

(

mwSize

nzmax

)

[inline, virtual]

Reimplemented in mxArray_base, mxArray_octave_value, mxArray_matlab, and mxArray_sparse.

static char* mxArray::strsave

(

const char *

str

)

[inline, static]

---

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

• mxarray.h
• mex.cc