octave_fcn_handle Class Reference

#include <ov-fcn-handle.h>

Inherits octave_base_value.

Inherited by octave_fcn_binder, and octave_fcn_inline.

Collaboration diagram for octave_fcn_handle:

List of all members.

Public Member Functions
	octave_fcn_handle (void)
	octave_fcn_handle (const std::string &n)
	octave_fcn_handle (const octave_value &f, const std::string &n=anonymous)
	octave_fcn_handle (const octave_fcn_handle &fh)
	~octave_fcn_handle (void)
octave_base_value *	clone (void) const
octave_base_value *	empty_clone (void) const
octave_value	subsref (const std::string &type, const std::list< octave_value_list > &idx)
octave_value_list	subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout)
octave_value_list	subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout, const std::list< octave_lvalue > *lvalue_list)
octave_value_list	do_multi_index_op (int nargout, const octave_value_list &args)
octave_value_list	do_multi_index_op (int nargout, const octave_value_list &args, const std::list< octave_lvalue > *lvalue_list)
bool	is_defined (void) const
bool	is_function_handle (void) const
builtin_type_t	builtin_type (void) const
bool	is_overloaded (void) const
dim_vector	dims (void) const
octave_function *	function_value (bool=false)
octave_user_function *	user_function_value (bool=false)
octave_fcn_handle *	fcn_handle_value (bool=false)
octave_value	fcn_val (void) const
std::string	fcn_name (void) const
void	set_overload (builtin_type_t btyp, const octave_value &ov_fcn)
void	set_overload (const std::string &dispatch_type, const octave_value &ov_fcn)
bool	is_equal_to (const octave_fcn_handle &) const
bool	save_ascii (std::ostream &os)
bool	load_ascii (std::istream &is)
bool	save_binary (std::ostream &os, bool &save_as_floats)
bool	load_binary (std::istream &is, bool swap, oct_mach_info::float_format fmt)
void	print (std::ostream &os, bool pr_as_read_syntax=false) const
void	print_raw (std::ostream &os, bool pr_as_read_syntax=false) const
bool	print_as_scalar (void) const
Static Public Attributes
static const std::string	anonymous
Protected Attributes
octave_value	fcn
std::string	nm
bool	has_overloads
octave_value	builtin_overloads [btyp_num_types]
str_ov_map	overloads
Friends
octave_value	make_fcn_handle (const std::string &, bool)

---

Constructor & Destructor Documentation

octave_fcn_handle::octave_fcn_handle

(

void

)

[inline]

octave_fcn_handle::octave_fcn_handle

(

const std::string &

n

)

[inline]

octave_fcn_handle::octave_fcn_handle	(	const octave_value &	f,
		const std::string &	n = anonymous
	)

octave_fcn_handle::octave_fcn_handle

(

const octave_fcn_handle &

fh

)

[inline]

octave_fcn_handle::~octave_fcn_handle

(

void

)

[inline]

---

Member Function Documentation

builtin_type_t octave_fcn_handle::builtin_type

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

octave_base_value* octave_fcn_handle::clone

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

dim_vector octave_fcn_handle::dims

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

octave_value_list octave_fcn_handle::do_multi_index_op	(	int	nargout,
		const octave_value_list &	args
	)			[virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_binder.

octave_value_list octave_fcn_handle::do_multi_index_op	(	int	nargout,
		const octave_value_list &	args,
		const std::list< octave_lvalue > *	lvalue_list
	)			[virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_binder.

octave_base_value* octave_fcn_handle::empty_clone

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

octave_fcn_handle* octave_fcn_handle::fcn_handle_value

(

bool

= false

)

[inline, virtual]

Reimplemented from octave_base_value.

std::string octave_fcn_handle::fcn_name

(

void

)

const [inline]

octave_value octave_fcn_handle::fcn_val

(

void

)

const [inline]

octave_function* octave_fcn_handle::function_value

(

bool

= false

)

[inline, virtual]

Reimplemented from octave_base_value.

bool octave_fcn_handle::is_defined

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

bool octave_fcn_handle::is_equal_to

(

const octave_fcn_handle &

h

)

const

bool octave_fcn_handle::is_function_handle

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

bool octave_fcn_handle::is_overloaded

(

void

)

const [inline]

bool octave_fcn_handle::load_ascii

(

std::istream &

is

)

[virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

bool octave_fcn_handle::load_binary	(	std::istream &	is,
		bool	swap,
		oct_mach_info::float_format	fmt
	)			[virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

void octave_fcn_handle::print	(	std::ostream &	os,
		bool	pr_as_read_syntax = false
	)			const [virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

bool octave_fcn_handle::print_as_scalar

(

void

)

const [inline, virtual]

Reimplemented from octave_base_value.

void octave_fcn_handle::print_raw	(	std::ostream &	os,
		bool	pr_as_read_syntax = false
	)			const [virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

bool octave_fcn_handle::save_ascii

(

std::ostream &

os

)

[virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

bool octave_fcn_handle::save_binary	(	std::ostream &	os,
		bool &	save_as_floats
	)			[virtual]

Reimplemented from octave_base_value.

Reimplemented in octave_fcn_inline.

void octave_fcn_handle::set_overload	(	builtin_type_t	btyp,
		const octave_value &	ov_fcn
	)			[inline]

void octave_fcn_handle::set_overload	(	const std::string &	dispatch_type,
		const octave_value &	ov_fcn
	)			[inline]

octave_value octave_fcn_handle::subsref	(	const std::string &	type,
		const std::list< octave_value_list > &	idx
	)			[inline, virtual]

Reimplemented from octave_base_value.

octave_value_list octave_fcn_handle::subsref	(	const std::string &	type,
		const std::list< octave_value_list > &	idx,
		int	nargout,
		const std::list< octave_lvalue > *	lvalue_list
	)			[virtual]

Reimplemented from octave_base_value.

octave_value_list octave_fcn_handle::subsref	(	const std::string &	type,
		const std::list< octave_value_list > &	idx,
		int	nargout
	)			[virtual]

Reimplemented from octave_base_value.

octave_user_function* octave_fcn_handle::user_function_value

(

bool

= false

)

[inline, virtual]

Reimplemented from octave_base_value.

---

Friends And Related Function Documentation

octave_value make_fcn_handle	(	const std::string &	,
		bool
	)			[friend]

---

Member Data Documentation

const std::string octave_fcn_handle::anonymous [static]

octave_value octave_fcn_handle::builtin_overloads[btyp_num_types] [protected]

octave_value octave_fcn_handle::fcn [protected]

bool octave_fcn_handle::has_overloads [protected]

std::string octave_fcn_handle::nm [protected]

str_ov_map octave_fcn_handle::overloads [protected]

---

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

• ov-fcn-handle.h
• ov-fcn-handle.cc