mxArray_octave_value Class Reference

Inheritance diagram for mxArray_octave_value:

Collaboration diagram for mxArray_octave_value:

Public Member Functions
	mxArray_octave_value (const octave_value &ov)
	~mxArray_octave_value (void)
int	add_field (const char *)
char *	array_to_string (void) const
mxArray *	as_mxArray (void) const
octave_value	as_octave_value (void) const
mwIndex	calc_single_subscript (mwSize nsubs, mwIndex *subs) const
mxArray_base *	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 *buf, mwSize buflen) const
int	is_cell (void) const
int	is_char (void) const
virtual int	is_class (const char *name_arg) const
virtual 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
virtual int	is_logical_scalar (void) const
virtual 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_range (void) const
int	is_real_type (void) const
bool	is_scalar (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	request_mutation (void) const
void	set_cell (mwIndex, mxArray *)
void	set_class_name (const char *)
void	set_data (void *)
int	set_dimensions (mwSize *, mwSize)
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)
void	set_n (mwSize)
void	set_nzmax (mwSize)

Protected Member Functions
	mxArray_octave_value (const mxArray_octave_value &arg)
OCTAVE_NORETURN void	err_invalid_type (void) const
OCTAVE_NORETURN void	err_invalid_type (void) const
void	invalid_type_error (void) const
void	invalid_type_error (void) const

Private Member Functions
mxArray_octave_value &	operator= (const mxArray_octave_value &)

Private Attributes
char *	class_name
mwSize *	dims
mxClassID	id
bool	mutate_flag
mwSize	ndims
octave_value	val

Detailed Description

Definition at line 154 of file mex.cc.

Constructor & Destructor Documentation

mxArray_octave_value::mxArray_octave_value ( const octave_value &  ov )

inline

Definition at line 158 of file mex.cc.

Referenced by dup().

mxArray_octave_value::~mxArray_octave_value ( void  )

inline

Definition at line 201 of file mex.cc.

References class_name, dims, and mxFree().

mxArray_octave_value::mxArray_octave_value ( const mxArray_octave_value &  arg )

inlineprotected

Definition at line 592 of file mex.cc.

References dims, and ndims.

Member Function Documentation

int mxArray_octave_value::add_field ( const char *  )

inlinevirtual

Implements mxArray_base.

Definition at line 453 of file mex.cc.

References request_mutation().

char* mxArray_octave_value::array_to_string ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 512 of file mex.cc.

References octave_value::char_array_value(), Array< T >::data(), get_number_of_elements(), octave_value::is_string(), mxArray::malloc(), p, tmp, and val.

mxArray* mxArray_octave_value::as_mxArray ( void  ) const

inlinevirtual

Reimplemented from mxArray_base.

Definition at line 164 of file mex.cc.

References octave_value::as_mxArray(), class_name, dims, mxArray::get_dimensions(), mxFree(), ndims, retval, mxArray::set_class_name(), mxArray::set_dimensions(), and val.

Referenced by mutate().

octave_value mxArray_octave_value::as_octave_value ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 588 of file mex.cc.

References val.

mwIndex mxArray_octave_value::calc_single_subscript ( mwSize  nsubs, mwIndex *  subs  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 540 of file mex.cc.

References calc_single_subscript_internal(), dims, get_dimensions(), and ndims.

mxArray_base* mxArray_octave_value::dup ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 162 of file mex.cc.

References mxArray_octave_value().

OCTAVE_NORETURN void mxArray_base::err_invalid_type ( void  ) const

inlineprotectedinherited

Definition at line 297 of file mxarray.h.

References error().

Referenced by mxArray_base::get_cell().

OCTAVE_NORETURN void mxArray_base::err_invalid_type ( void  ) const

inlineprotectedinherited

Definition at line 297 of file mxarray.in.h.

References error().

mxArray* mxArray_octave_value::get_cell ( mwIndex  ) const

inlinevirtual

Reimplemented from mxArray_base.

Definition at line 372 of file mex.cc.

References request_mutation().

mxClassID mxArray_octave_value::get_class_id ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 318 of file mex.cc.

References octave_value::class_name(), id, mxCELL_CLASS, mxCHAR_CLASS, mxDOUBLE_CLASS, mxFUNCTION_CLASS, mxINT16_CLASS, mxINT32_CLASS, mxINT64_CLASS, mxINT8_CLASS, mxLOGICAL_CLASS, mxSINGLE_CLASS, mxSTRUCT_CLASS, mxUINT16_CLASS, mxUINT32_CLASS, mxUINT64_CLASS, mxUINT8_CLASS, mxUNKNOWN_CLASS, string, and val.

Referenced by get_element_size().

const char* mxArray_octave_value::get_class_name ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 358 of file mex.cc.

References class_name, octave_value::class_name(), s, string, mxArray::strsave(), and val.

void* mxArray_octave_value::get_data ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 401 of file mex.cc.

References maybe_mark_foreign(), octave_value::mex_get_data(), request_mutation(), retval, and val.

mwSize* mxArray_octave_value::get_dimensions ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 269 of file mex.cc.

References octave_value::dims(), dims, dv, mxArray::malloc(), octave_value::ndims(), ndims, and val.

Referenced by calc_single_subscript(), get_n(), get_number_of_dimensions(), and is_scalar().

size_t mxArray_octave_value::get_element_size ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 548 of file mex.cc.

References double, get_class_id(), mxCELL_CLASS, mxCHAR_CLASS, mxDOUBLE_CLASS, mxFUNCTION_CLASS, mxINT16_CLASS, mxINT32_CLASS, mxINT64_CLASS, mxINT8_CLASS, mxLOGICAL_CLASS, mxSINGLE_CLASS, mxSTRUCT_CLASS, mxUINT16_CLASS, mxUINT32_CLASS, mxUINT64_CLASS, and mxUINT8_CLASS.

mxArray* mxArray_octave_value::get_field_by_number ( mwIndex  , int    ) const

inlinevirtual

Implements mxArray_base.

Definition at line 462 of file mex.cc.

References request_mutation().

const char* mxArray_octave_value::get_field_name_by_number ( int  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 477 of file mex.cc.

References request_mutation().

int mxArray_octave_value::get_field_number ( const char *  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 483 of file mex.cc.

References request_mutation().

void* mxArray_octave_value::get_imag_data ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 413 of file mex.cc.

References is_numeric(), is_real_type(), request_mutation(), and retval.

mwIndex* mxArray_octave_value::get_ir ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 431 of file mex.cc.

References maybe_mark_foreign(), octave_value::mex_get_ir(), and val.

mwIndex* mxArray_octave_value::get_jc ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 436 of file mex.cc.

References maybe_mark_foreign(), octave_value::mex_get_jc(), and val.

mwSize mxArray_octave_value::get_m ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 254 of file mex.cc.

References octave_value::rows(), and val.

mwSize mxArray_octave_value::get_n ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 256 of file mex.cc.

References dims, get_dimensions(), and ndims.

mwSize mxArray_octave_value::get_number_of_dimensions ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 287 of file mex.cc.

References get_dimensions(), and ndims.

mwSize mxArray_octave_value::get_number_of_elements ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 306 of file mex.cc.

References octave_value::numel(), and val.

Referenced by array_to_string(), and get_string().

int mxArray_octave_value::get_number_of_fields ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 475 of file mex.cc.

References octave_value::nfields(), and val.

mwSize mxArray_octave_value::get_nzmax ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 441 of file mex.cc.

References octave_value::nzmax(), and val.

double mxArray_octave_value::get_scalar ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 381 of file mex.cc.

References octave_value::is_bool_type(), octave_value::is_real_type(), octave_value::is_sparse_type(), octave_value::mex_get_data(), octave_value::scalar_value(), and val.

int mxArray_octave_value::get_string ( char *  buf, mwSize  buflen  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 489 of file mex.cc.

References octave_value::char_array_value(), Array< T >::data(), get_number_of_elements(), octave_value::is_string(), p, retval, tmp, and val.

void mxArray_base::invalid_type_error ( void  ) const

inlineprotectedinherited

Definition at line 292 of file mxarray.h.

References error().

void mxArray_base::invalid_type_error ( void  ) const

inlineprotectedinherited

Definition at line 292 of file mxarray.in.h.

References error().

int mxArray_octave_value::is_cell ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 209 of file mex.cc.

References octave_value::is_cell(), and val.

int mxArray_octave_value::is_char ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 211 of file mex.cc.

References octave_value::is_string(), and val.

virtual int mxArray_base::is_class ( const char *  name_arg ) const

inlinevirtualinherited

Definition at line 149 of file mxarray.h.

References mxArray_base::get_class_name(), retval, and octave::string::strcmp().

Referenced by mxArray::is_class().

virtual int mxArray_base::is_class ( const char *  name_arg ) const

inlinevirtualinherited

Definition at line 149 of file mxarray.in.h.

References mxArray_base::get_class_name(), retval, and octave::string::strcmp().

int mxArray_octave_value::is_complex ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 213 of file mex.cc.

References octave_value::is_complex_type(), and val.

int mxArray_octave_value::is_double ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 215 of file mex.cc.

References octave_value::is_double_type(), and val.

int mxArray_octave_value::is_empty ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 308 of file mex.cc.

References octave_value::is_empty(), and val.

int mxArray_octave_value::is_function_handle ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 217 of file mex.cc.

References octave_value::is_function_handle(), and val.

int mxArray_octave_value::is_int16 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 219 of file mex.cc.

References octave_value::is_int16_type(), and val.

int mxArray_octave_value::is_int32 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 221 of file mex.cc.

References octave_value::is_int32_type(), and val.

int mxArray_octave_value::is_int64 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 223 of file mex.cc.

References octave_value::is_int64_type(), and val.

int mxArray_octave_value::is_int8 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 225 of file mex.cc.

References octave_value::is_int8_type(), and val.

int mxArray_octave_value::is_logical ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 227 of file mex.cc.

References octave_value::is_bool_type(), and val.

virtual int mxArray_base::is_logical_scalar ( void  ) const

inlinevirtualinherited

Definition at line 193 of file mxarray.h.

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

Referenced by mxArray::is_logical_scalar(), is_logical_scalar_true(), and mxArray_matlab::is_logical_scalar_true().

virtual int mxArray_base::is_logical_scalar ( void  ) const

inlinevirtualinherited

Definition at line 193 of file mxarray.in.h.

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

int mxArray_octave_value::is_logical_scalar_true ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 249 of file mex.cc.

References mxArray_base::is_logical_scalar(), octave_value::is_true(), and val.

int mxArray_octave_value::is_numeric ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 229 of file mex.cc.

References octave_value::is_numeric_type(), and val.

Referenced by get_imag_data().

bool mxArray_octave_value::is_octave_value ( void  ) const

inlinevirtual

Reimplemented from mxArray_base.

Definition at line 207 of file mex.cc.

int mxArray_octave_value::is_range ( void  ) const

inline

Definition at line 245 of file mex.cc.

References octave_value::is_range(), and val.

int mxArray_octave_value::is_real_type ( void  ) const

inline

Definition at line 247 of file mex.cc.

References octave_value::is_real_type(), and val.

Referenced by get_imag_data().

bool mxArray_octave_value::is_scalar ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 310 of file mex.cc.

References dims, get_dimensions(), and ndims.

int mxArray_octave_value::is_single ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 231 of file mex.cc.

References octave_value::is_single_type(), and val.

int mxArray_octave_value::is_sparse ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 233 of file mex.cc.

References octave_value::is_sparse_type(), and val.

int mxArray_octave_value::is_struct ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 235 of file mex.cc.

References octave_value::is_map(), and val.

int mxArray_octave_value::is_uint16 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 237 of file mex.cc.

References octave_value::is_uint16_type(), and val.

int mxArray_octave_value::is_uint32 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 239 of file mex.cc.

References octave_value::is_uint32_type(), and val.

int mxArray_octave_value::is_uint64 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 241 of file mex.cc.

References octave_value::is_uint64_type(), and val.

int mxArray_octave_value::is_uint8 ( void  ) const

inlinevirtual

Implements mxArray_base.

Definition at line 243 of file mex.cc.

References octave_value::is_uint8_type(), and val.

mxArray* mxArray_octave_value::mutate ( void  ) const

inlinevirtual

Reimplemented from mxArray_base.

Definition at line 586 of file mex.cc.

References as_mxArray().

bool mxArray_octave_value::mutation_needed ( void  ) const

inlinevirtual

Reimplemented from mxArray_base.

Definition at line 576 of file mex.cc.

References mutate_flag.

mxArray_octave_value& mxArray_octave_value::operator= ( const mxArray_octave_value &  )

private

void mxArray_octave_value::remove_field ( int  )

inlinevirtual

Implements mxArray_base.

Definition at line 460 of file mex.cc.

References request_mutation().

void mxArray_octave_value::request_mutation ( void  ) const

inline

Definition at line 578 of file mex.cc.

References mutate_flag, and panic_impossible.

Referenced by add_field(), get_cell(), get_data(), get_field_by_number(), get_field_name_by_number(), get_field_number(), get_imag_data(), remove_field(), set_cell(), set_class_name(), set_data(), set_dimensions(), set_field_by_number(), set_imag_data(), set_ir(), set_jc(), set_m(), set_n(), and set_nzmax().

void mxArray_octave_value::set_cell ( mwIndex  , mxArray *    )

inlinevirtual

Implements mxArray_base.

Definition at line 379 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_class_name ( const char *  )

inlinevirtual

Implements mxArray_base.

Definition at line 370 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_data ( void *  )

inlinevirtual

Implements mxArray_base.

Definition at line 426 of file mex.cc.

References request_mutation().

int mxArray_octave_value::set_dimensions ( mwSize *  , mwSize    )

inlinevirtual

Implements mxArray_base.

Definition at line 299 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_field_by_number ( mwIndex  , int  , mxArray *    )

inlinevirtual

Implements mxArray_base.

Definition at line 469 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_imag_data ( void *  )

inlinevirtual

Implements mxArray_base.

Definition at line 429 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_ir ( mwIndex *  )

inlinevirtual

Implements mxArray_base.

Definition at line 444 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_jc ( mwIndex *  )

inlinevirtual

Implements mxArray_base.

Definition at line 447 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_m ( mwSize  )

inlinevirtual

Implements mxArray_base.

Definition at line 295 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_n ( mwSize  )

inlinevirtual

Implements mxArray_base.

Definition at line 297 of file mex.cc.

References request_mutation().

void mxArray_octave_value::set_nzmax ( mwSize  )

inlinevirtual

Implements mxArray_base.

Definition at line 450 of file mex.cc.

References request_mutation().

Member Data Documentation

char* mxArray_octave_value::class_name

mutableprivate

Definition at line 618 of file mex.cc.

Referenced by as_mxArray(), get_class_name(), and ~mxArray_octave_value().

mwSize* mxArray_octave_value::dims

mutableprivate

Definition at line 620 of file mex.cc.

Referenced by as_mxArray(), calc_single_subscript(), get_dimensions(), get_n(), is_scalar(), mxArray_octave_value(), and ~mxArray_octave_value().

mxClassID mxArray_octave_value::id

mutableprivate

Definition at line 617 of file mex.cc.

Referenced by get_class_id().

bool mxArray_octave_value::mutate_flag

mutableprivate

Definition at line 611 of file mex.cc.

Referenced by mutation_needed(), and request_mutation().

mwSize mxArray_octave_value::ndims

mutableprivate

Definition at line 619 of file mex.cc.

Referenced by as_mxArray(), calc_single_subscript(), get_dimensions(), get_n(), get_number_of_dimensions(), is_scalar(), and mxArray_octave_value().

octave_value mxArray_octave_value::val

private

Definition at line 609 of file mex.cc.

Referenced by array_to_string(), as_mxArray(), as_octave_value(), get_class_id(), get_class_name(), get_data(), get_dimensions(), get_ir(), get_jc(), get_m(), get_number_of_elements(), get_number_of_fields(), get_nzmax(), get_scalar(), get_string(), is_cell(), is_char(), is_complex(), is_double(), is_empty(), is_function_handle(), is_int16(), is_int32(), is_int64(), is_int8(), is_logical(), is_logical_scalar_true(), is_numeric(), is_range(), is_real_type(), is_single(), is_sparse(), is_struct(), is_uint16(), is_uint32(), is_uint64(), and is_uint8().

---

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

• libinterp/corefcn/mex.cc