mxArray_sparse Class Reference

Inheritance diagram for mxArray_sparse:

Collaboration diagram for mxArray_sparse:

List of all members.

Public Member Functions
	mxArray_sparse (mxClassID id_arg, mwSize m, mwSize n, mwSize nzmax_arg, mxComplexity flag=mxREAL)
	~mxArray_sparse (void)
int	add_field (const char *)
char *	array_to_string (void) const
mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const
mxArray_sparse *	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, 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 *pr_arg)
void	set_dimensions (mwSize *dims_arg, mwSize ndims_arg)
void	set_field_by_number (mwIndex, int, mxArray *)
void	set_imag_data (void *pi_arg)
void	set_ir (mwIndex *ir_arg)
void	set_jc (mwIndex *jc_arg)
void	set_m (mwSize m)
void	set_n (mwSize n)
void	set_nzmax (mwSize nzmax_arg)
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_sparse (const mxArray_sparse &val)
mxArray_sparse &	operator= (const mxArray_sparse &)
Private Attributes
mwIndex *	ir
mwIndex *	jc
mwSize	nzmax
void *	pi
void *	pr

---

Detailed Description

Definition at line 1513 of file mex.cc.

---

Constructor & Destructor Documentation

mxArray_sparse::mxArray_sparse	(	mxClassID	id_arg,
		mwSize	m,
		mwSize	n,
		mwSize	nzmax_arg,
		mxComplexity	flag = mxREAL
	)			[inline]

Definition at line 1517 of file mex.cc.

Referenced by dup().

mxArray_sparse::~mxArray_sparse

(

void

)

[inline]

Definition at line 1528 of file mex.cc.

References ir, jc, mxFree(), pi, and pr.

mxArray_sparse::mxArray_sparse

(

const mxArray_sparse &

val

)

[inline, private]

Definition at line 1652 of file mex.cc.

References mxArray_matlab::get_element_size(), mxArray_matlab::get_n(), ir, jc, nzmax, pi, and pr.

---

Member Function Documentation

int mxArray_matlab::add_field

(

const char *

)

[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 990 of file mex.cc.

References mxArray_matlab::invalid_type_error().

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_sparse::as_octave_value

(

void

)

const [inline, protected, virtual]

Implements mxArray_base.

Definition at line 1562 of file mex.cc.

References mxArray_matlab::dims_to_dim_vector(), mxArray_base::error(), mxArray_matlab::get_class_id(), mxArray_matlab::get_m(), mxArray_matlab::get_n(), ir, jc, nzmax, panic_impossible, pi, pr, Sparse< T >::xcidx(), Sparse< T >::xdata(), and Sparse< T >::xridx().

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(), mxArray_struct::as_octave_value(), as_octave_value(), and mxArray_number::as_octave_value().

mxArray_sparse* mxArray_sparse::dup

(

void

)

const [inline, virtual]

Implements mxArray_base.

Definition at line 1526 of file mex.cc.

References mxArray_sparse().

void mxArray_base::error

(

const char *

msg

)

const [inline, protected, inherited]

Definition at line 270 of file mex.cc.

Referenced by 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 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_sparse::get_data

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1540 of file mex.cc.

References pr.

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* mxArray_matlab::get_field_by_number	(	mwIndex	,
		int
	)			const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1001 of file mex.cc.

References mxArray_matlab::invalid_type_error().

const char* mxArray_matlab::get_field_name_by_number

(

int

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1018 of file mex.cc.

References mxArray_matlab::invalid_type_error().

int mxArray_matlab::get_field_number

(

const char *

)

const [inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1024 of file mex.cc.

void* mxArray_sparse::get_imag_data

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1542 of file mex.cc.

References pi.

mwIndex* mxArray_sparse::get_ir

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1548 of file mex.cc.

References ir.

mwIndex* mxArray_sparse::get_jc

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1550 of file mex.cc.

References jc.

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 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 as_octave_value(), and 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 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(), mxArray_matlab::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, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1012 of file mex.cc.

References mxArray_matlab::invalid_type_error().

mwSize mxArray_sparse::get_nzmax

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1552 of file mex.cc.

References nzmax.

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().

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_sparse::is_complex

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1536 of file mex.cc.

References pi.

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_sparse::is_sparse

(

void

)

const [inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1538 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_sparse& mxArray_sparse::operator=

(

const mxArray_sparse &

)

[private]

void mxArray_matlab::remove_field

(

int

)

[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 996 of file mex.cc.

References mxArray_matlab::invalid_type_error().

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_sparse::set_data

(

void *

pr_arg

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1544 of file mex.cc.

References pr.

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_matlab::set_field_by_number	(	mwIndex	,
		int	,
		mxArray *
	)			[inline, virtual, inherited]

Implements mxArray_base.

Reimplemented in mxArray_struct.

Definition at line 1007 of file mex.cc.

References mxArray_matlab::invalid_type_error().

void mxArray_sparse::set_imag_data

(

void *

pi_arg

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1546 of file mex.cc.

References pi.

void mxArray_sparse::set_ir

(

mwIndex *

ir_arg

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1554 of file mex.cc.

References ir.

void mxArray_sparse::set_jc

(

mwIndex *

jc_arg

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1556 of file mex.cc.

References jc.

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_sparse::set_nzmax

(

mwSize

nzmax_arg

)

[inline, virtual]

Reimplemented from mxArray_matlab.

Definition at line 1558 of file mex.cc.

References nzmax.

---

Member Data Documentation

mwIndex* mxArray_sparse::ir [private]

Definition at line 1649 of file mex.cc.

Referenced by as_octave_value(), get_ir(), mxArray_sparse(), set_ir(), and ~mxArray_sparse().

mwIndex* mxArray_sparse::jc [private]

Definition at line 1650 of file mex.cc.

Referenced by as_octave_value(), get_jc(), mxArray_sparse(), set_jc(), and ~mxArray_sparse().

mwSize mxArray_sparse::nzmax [private]

Definition at line 1645 of file mex.cc.

Referenced by as_octave_value(), get_nzmax(), mxArray_sparse(), and set_nzmax().

void* mxArray_sparse::pi [private]

Definition at line 1648 of file mex.cc.

Referenced by as_octave_value(), get_imag_data(), is_complex(), mxArray_sparse(), set_imag_data(), and ~mxArray_sparse().

void* mxArray_sparse::pr [private]

Definition at line 1647 of file mex.cc.

Referenced by as_octave_value(), get_data(), mxArray_sparse(), set_data(), and ~mxArray_sparse().

---

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

• src/mex.cc