GNU Octave  6.2.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
octave::scoped_fcn_handle Class Reference
Inheritance diagram for octave::scoped_fcn_handle:
Inheritance graph
[legend]
Collaboration diagram for octave::scoped_fcn_handle:
Collaboration graph
[legend]

Public Member Functions

 scoped_fcn_handle (const octave_value &fcn, const std::string &name, const std::list< std::string > &parentage)
 
 scoped_fcn_handle (const scoped_fcn_handle &)=default
 
 scoped_fcn_handle (const std::string &name="", const std::string &file="", const std::string &="")
 
 ~scoped_fcn_handle (void)=default
 
octave_value_list call (int nargout, const octave_value_list &args)
 
scoped_fcn_handle * clone (void) const
 
octave_value convert_to_str_internal (bool pad, bool force, char type) const
 
std::string fcn_name (void) const
 
octave_value fcn_val (void)
 
std::string file (void) const
 
octave_function * function_value (bool=false)
 
virtual std::string get_dispatch_class (void) const
 
octave_scalar_map info (void)
 
virtual bool is_anonymous (void) const
 
virtual bool is_class_simple (void) const
 
virtual bool is_internal (void) const
 
virtual bool is_nested (void) const
 
bool is_scoped (void) const
 
virtual bool is_simple (void) const
 
bool load_ascii (std::istream &is)
 
bool load_binary (std::istream &is, bool swap, mach_info::float_format fmt)
 
bool load_hdf5 (octave_hdf5_id &group_hid, octave_hdf5_id &space_hid, octave_hdf5_id &type_hid)
 
virtual bool print_as_scalar (void) const
 
void print_raw (std::ostream &, bool pr_as_read_syntax, int current_print_indent_level) const
 
bool save_ascii (std::ostream &os)
 
bool save_binary (std::ostream &os, bool save_as_floats)
 
bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats)
 
virtual void set_dispatch_class (const std::string &)
 
virtual bool set_fcn (const std::string &, const std::string &)
 
octave_value_list subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout)
 
std::string type (void) const
 
octave_user_function * user_function_value (bool=false)
 
virtual octave_value workspace (void) const
 

Protected Member Functions

void find_function (void)
 
void unimplemented (const char *op, const char *fmt) const
 
void warn_load (const char *file_type) const
 
void warn_save (const char *file_type) const
 

Protected Attributes

octave_value m_fcn
 
std::string m_file
 
std::string m_name
 
std::list< std::string > m_parentage
 

Friends

bool is_equal_to (const scoped_fcn_handle &fh1, const scoped_fcn_handle &fh2)
 

Detailed Description

Definition at line 236 of file ov-fcn-handle.cc.

Constructor & Destructor Documentation

◆ scoped_fcn_handle() [1/3]

octave::scoped_fcn_handle::scoped_fcn_handle ( const std::string &  name = "",
const std::string &  file = "",
const std::string &  = "" 
)
inline

Definition at line 243 of file ov-fcn-handle.cc.

Referenced by clone().

◆ scoped_fcn_handle() [2/3]

octave::scoped_fcn_handle::scoped_fcn_handle ( const octave_value &  fcn,
const std::string &  name,
const std::list< std::string > &  parentage 
)

Definition at line 1253 of file ov-fcn-handle.cc.

References octave_function::fcn_file_name(), octave_value::function_value(), octave_value::is_defined(), m_fcn, octave::base_fcn_handle::m_file, m_parentage, and name.

◆ scoped_fcn_handle() [3/3]

octave::scoped_fcn_handle::scoped_fcn_handle ( const scoped_fcn_handle &  )
default

◆ ~scoped_fcn_handle()

octave::scoped_fcn_handle::~scoped_fcn_handle ( void  )
default

Member Function Documentation

◆ call()

octave_value_list octave::scoped_fcn_handle::call ( int  nargout,
const octave_value_list &  args 
)
virtual

Implements octave::base_fcn_handle.

Definition at line 1272 of file ov-fcn-handle.cc.

References octave::__get_interpreter__(), octave::err_invalid_fcn_handle(), octave::interpreter::feval(), find_function(), octave_value::is_defined(), m_fcn, and octave::base_fcn_handle::m_name.

◆ clone()

scoped_fcn_handle* octave::scoped_fcn_handle::clone ( void  ) const
inlinevirtual

Implements octave::base_fcn_handle.

Definition at line 256 of file ov-fcn-handle.cc.

References scoped_fcn_handle().

◆ convert_to_str_internal()

octave_value octave::base_fcn_handle::convert_to_str_internal ( bool  pad,
bool  force,
char  type 
) const
inherited

Definition at line 637 of file ov-fcn-handle.cc.

References octave_value(), octave::base_fcn_handle::print_raw(), and octave::base_fcn_handle::type().

◆ fcn_name()

std::string octave::base_fcn_handle::fcn_name ( void  ) const
inlineinherited

Definition at line 79 of file ov-fcn-handle.h.

References octave::base_fcn_handle::m_name.

Referenced by octave::class_simple_fcn_handle::call(), find_function(), octave::internal_fcn_handle::info(), octave::simple_fcn_handle::info(), info(), octave::nested_fcn_handle::info(), and octave::class_simple_fcn_handle::info().

◆ fcn_val()

octave_value octave::scoped_fcn_handle::fcn_val ( void  )
inlinevirtual

Reimplemented from octave::base_fcn_handle.

Definition at line 279 of file ov-fcn-handle.cc.

References m_fcn.

◆ file()

std::string octave::base_fcn_handle::file ( void  ) const
inlineinherited

Definition at line 81 of file ov-fcn-handle.h.

References octave::base_fcn_handle::m_file.

Referenced by octave::simple_fcn_handle::info(), info(), octave::simple_fcn_handle::save_ascii(), save_ascii(), and save_binary().

◆ find_function()

void octave::scoped_fcn_handle::find_function ( void  )
protected

Definition at line 1446 of file ov-fcn-handle.cc.

References octave::__get_symbol_table__(), octave::sys::file_ops::dir_sep_chars(), octave::sys::file_ops::dirname(), octave_user_code::fcn_file_name(), octave::base_fcn_handle::fcn_name(), octave::symbol_table::find_private_function(), octave_user_function::find_subfunction(), octave::symbol_table::find_user_function(), octave_value::is_defined(), m_fcn, octave::base_fcn_handle::m_file, octave::base_fcn_handle::m_name, m_parentage, octave::config::octave_exec_home(), and octave_value::user_function_value().

Referenced by call().

◆ function_value()

octave_function* octave::scoped_fcn_handle::function_value ( bool  = false)
inlinevirtual

Reimplemented from octave::base_fcn_handle.

Definition at line 269 of file ov-fcn-handle.cc.

References octave_value::function_value(), and m_fcn.

◆ get_dispatch_class()

virtual std::string octave::base_fcn_handle::get_dispatch_class ( void  ) const
inlinevirtualinherited

Definition at line 111 of file ov-fcn-handle.h.

◆ info()

octave_scalar_map octave::scoped_fcn_handle::info ( void  )
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1291 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::fcn_name(), octave::base_fcn_handle::file(), m, m_parentage, and type().

◆ is_anonymous()

virtual bool octave::base_fcn_handle::is_anonymous ( void  ) const
inlinevirtualinherited

Reimplemented in octave::anonymous_fcn_handle.

Definition at line 77 of file ov-fcn-handle.h.

◆ is_class_simple()

virtual bool octave::base_fcn_handle::is_class_simple ( void  ) const
inlinevirtualinherited

Reimplemented in octave::class_simple_fcn_handle.

Definition at line 75 of file ov-fcn-handle.h.

◆ is_internal()

virtual bool octave::base_fcn_handle::is_internal ( void  ) const
inlinevirtualinherited

Reimplemented in octave::internal_fcn_handle.

Definition at line 67 of file ov-fcn-handle.h.

◆ is_nested()

virtual bool octave::base_fcn_handle::is_nested ( void  ) const
inlinevirtualinherited

Reimplemented in octave::nested_fcn_handle.

Definition at line 73 of file ov-fcn-handle.h.

◆ is_scoped()

bool octave::scoped_fcn_handle::is_scoped ( void  ) const
inlinevirtual

Reimplemented from octave::base_fcn_handle.

Definition at line 263 of file ov-fcn-handle.cc.

◆ is_simple()

virtual bool octave::base_fcn_handle::is_simple ( void  ) const
inlinevirtualinherited

Reimplemented in octave::simple_fcn_handle.

Definition at line 69 of file ov-fcn-handle.h.

◆ load_ascii()

bool octave::scoped_fcn_handle::load_ascii ( std::istream &  is)
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1322 of file ov-fcn-handle.cc.

References octave_cell::cellstr_value(), octave_cell::iscellstr(), octave_cell::load_ascii(), m_parentage, and Array< T >::numel().

◆ load_binary()

bool octave::scoped_fcn_handle::load_binary ( std::istream &  is,
bool  swap,
mach_info::float_format  fmt 
)
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1358 of file ov-fcn-handle.cc.

References octave_cell::cellstr_value(), octave_cell::iscellstr(), octave_cell::load_binary(), m_parentage, and Array< T >::numel().

◆ load_hdf5()

bool octave::scoped_fcn_handle::load_hdf5 ( octave_hdf5_id &  group_hid,
octave_hdf5_id &  space_hid,
octave_hdf5_id &  type_hid 
)
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1401 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::unimplemented().

◆ print_as_scalar()

virtual bool octave::base_fcn_handle::print_as_scalar ( void  ) const
inlinevirtualinherited

Reimplemented in octave::anonymous_fcn_handle.

Definition at line 136 of file ov-fcn-handle.h.

◆ print_raw()

void octave::scoped_fcn_handle::print_raw ( std::ostream &  os,
bool  pr_as_read_syntax,
int  current_print_indent_level 
) const
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1428 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::m_name, and octave_print_internal().

◆ save_ascii()

bool octave::scoped_fcn_handle::save_ascii ( std::ostream &  os)
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1304 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::file(), octave::base_fcn_handle::m_name, m_parentage, octave::config::octave_exec_home(), octave_value::save_ascii(), and type().

◆ save_binary()

bool octave::scoped_fcn_handle::save_binary ( std::ostream &  os,
bool  save_as_floats 
)
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1338 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::file(), len, octave::base_fcn_handle::m_name, m_parentage, octave::config::octave_exec_home(), and octave_value::save_binary().

◆ save_hdf5()

bool octave::scoped_fcn_handle::save_hdf5 ( octave_hdf5_id  loc_id,
const char *  name,
bool  save_as_floats 
)
virtual

Reimplemented from octave::base_fcn_handle.

Definition at line 1375 of file ov-fcn-handle.cc.

References name, octave::base_fcn_handle::unimplemented(), and octave::base_fcn_handle::warn_save().

◆ set_dispatch_class()

virtual void octave::base_fcn_handle::set_dispatch_class ( const std::string &  )
inlinevirtualinherited

Definition at line 109 of file ov-fcn-handle.h.

◆ set_fcn()

virtual bool octave::base_fcn_handle::set_fcn ( const std::string &  ,
const std::string &   
)
inlinevirtualinherited

Definition at line 139 of file ov-fcn-handle.h.

◆ subsref()

octave_value_list octave::base_fcn_handle::subsref ( const std::string &  type,
const std::list< octave_value_list > &  idx,
int  nargout 
)
inherited

Definition at line 601 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::call(), error(), panic_impossible, retval, and octave::base_fcn_handle::type().

◆ type()

std::string octave::scoped_fcn_handle::type ( void  ) const
inlinevirtual

Implements octave::base_fcn_handle.

Definition at line 261 of file ov-fcn-handle.cc.

Referenced by info(), and save_ascii().

◆ unimplemented()

void octave::base_fcn_handle::unimplemented ( const char *  op,
const char *  fmt 
) const
protectedinherited

Definition at line 712 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::type(), and warning().

Referenced by octave::nested_fcn_handle::load_ascii(), octave::class_simple_fcn_handle::load_ascii(), octave::base_fcn_handle::load_ascii(), octave::nested_fcn_handle::load_binary(), octave::class_simple_fcn_handle::load_binary(), octave::base_fcn_handle::load_binary(), octave::simple_fcn_handle::load_hdf5(), load_hdf5(), octave::nested_fcn_handle::load_hdf5(), octave::class_simple_fcn_handle::load_hdf5(), octave::base_fcn_handle::load_hdf5(), octave::nested_fcn_handle::save_ascii(), octave::class_simple_fcn_handle::save_ascii(), octave::base_fcn_handle::save_ascii(), octave::nested_fcn_handle::save_binary(), octave::class_simple_fcn_handle::save_binary(), octave::base_fcn_handle::save_binary(), save_hdf5(), octave::nested_fcn_handle::save_hdf5(), octave::class_simple_fcn_handle::save_hdf5(), and octave::base_fcn_handle::save_hdf5().

◆ user_function_value()

octave_user_function* octave::scoped_fcn_handle::user_function_value ( bool  = false)
inlinevirtual

Reimplemented from octave::base_fcn_handle.

Definition at line 274 of file ov-fcn-handle.cc.

References m_fcn, and octave_value::user_function_value().

◆ warn_load()

void octave::base_fcn_handle::warn_load ( const char *  file_type) const
protectedinherited

Definition at line 692 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::type(), and warning_with_id().

◆ warn_save()

void octave::base_fcn_handle::warn_save ( const char *  file_type) const
protectedinherited

Definition at line 702 of file ov-fcn-handle.cc.

References octave::base_fcn_handle::type(), and warning_with_id().

Referenced by octave::simple_fcn_handle::save_hdf5(), save_hdf5(), octave::nested_fcn_handle::save_hdf5(), octave::class_simple_fcn_handle::save_hdf5(), and octave::anonymous_fcn_handle::save_hdf5().

◆ workspace()

virtual octave_value octave::base_fcn_handle::workspace ( void  ) const
inlinevirtualinherited

Reimplemented in octave::anonymous_fcn_handle, and octave::nested_fcn_handle.

Definition at line 104 of file ov-fcn-handle.h.

References octave_value().

Friends And Related Function Documentation

◆ is_equal_to

bool is_equal_to ( const scoped_fcn_handle &  fh1,
const scoped_fcn_handle &  fh2 
)
friend

Definition at line 1436 of file ov-fcn-handle.cc.

Member Data Documentation

◆ m_fcn

octave_value octave::scoped_fcn_handle::m_fcn
protected

Definition at line 308 of file ov-fcn-handle.cc.

Referenced by scoped_fcn_handle(), call(), fcn_val(), find_function(), function_value(), and user_function_value().

◆ m_file

std::string octave::base_fcn_handle::m_file
protectedinherited

Definition at line 156 of file ov-fcn-handle.h.

Referenced by scoped_fcn_handle(), octave::simple_fcn_handle::simple_fcn_handle(), octave::base_fcn_handle::file(), and find_function().

◆ m_name

std::string octave::base_fcn_handle::m_name
protectedinherited

Definition at line 153 of file ov-fcn-handle.h.

Referenced by octave::simple_fcn_handle::call(), call(), octave::base_fcn_handle::fcn_name(), octave::simple_fcn_handle::fcn_val(), find_function(), octave::simple_fcn_handle::function_value(), octave::class_simple_fcn_handle::function_value(), octave::anonymous_fcn_handle::load_binary(), octave::anonymous_fcn_handle::parse(), print_raw(), octave::nested_fcn_handle::print_raw(), octave::class_simple_fcn_handle::print_raw(), octave::simple_fcn_handle::print_raw(), octave::simple_fcn_handle::save_ascii(), save_ascii(), octave::anonymous_fcn_handle::save_ascii(), octave::simple_fcn_handle::save_binary(), save_binary(), octave::simple_fcn_handle::save_hdf5(), octave::anonymous_fcn_handle::save_hdf5(), and octave::simple_fcn_handle::user_function_value().

◆ m_parentage

std::list<std::string> octave::scoped_fcn_handle::m_parentage
protected

Definition at line 312 of file ov-fcn-handle.cc.

Referenced by scoped_fcn_handle(), find_function(), info(), load_ascii(), load_binary(), save_ascii(), and save_binary().

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