GNU Octave  8.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
fcn_info Class Reference

#include "fcn-info.h"

Collaboration diagram for fcn_info:
Collaboration graph
[legend]

Classes

class  fcn_info_rep
 

Public Types

typedef std::map< std::string, octave_value >::const_iterator str_val_const_iterator
 
typedef std::map< std::string, octave_value >::iterator str_val_iterator
 

Public Member Functions

 fcn_info (const fcn_info &)=default
 
 fcn_info (const std::string &nm="")
 
 ~fcn_info (void)=default
 
octave_value builtin_find (const symbol_scope &search_scope)
 
void clear (bool force=false)
 
void clear_autoload_function (bool force=false)
 
void clear_mex_function (void)
 
void clear_user_function (bool force=false)
 
octave_value dump (void) const
 
octave_value find (const symbol_scope &search_scope, const octave_value_list &args=octave_value_list())
 
octave_value find_autoload (void)
 
octave_value find_built_in_function (void) const
 
octave_value find_cmdline_function (void) const
 
octave_value find_function (const symbol_scope &search_scope, const octave_value_list &args=octave_value_list())
 
octave_value find_method (const std::string &dispatch_type) const
 
octave_value find_private_function (const std::string &dir_name) const
 
octave_value find_scoped_function (const symbol_scope &search_scope) const
 
octave_value find_user_function (void)
 
void install_built_in_dispatch (const std::string &klass)
 
void install_built_in_function (const octave_value &f)
 
void install_cmdline_function (const octave_value &f)
 
void install_local_function (const octave_value &f, const std::string &file_name)
 
void install_user_function (const octave_value &f)
 
bool is_user_function_defined (void) const
 
fcn_info & operator= (const fcn_info &)=default
 

Private Attributes

std::shared_ptr< fcn_info_rep > m_rep
 

Detailed Description

Definition at line 42 of file fcn-info.h.

Member Typedef Documentation

◆ str_val_const_iterator

typedef std::map<std::string, octave_value>::const_iterator fcn_info::str_val_const_iterator

Definition at line 47 of file fcn-info.h.

◆ str_val_iterator

typedef std::map<std::string, octave_value>::iterator fcn_info::str_val_iterator

Definition at line 48 of file fcn-info.h.

Constructor & Destructor Documentation

◆ fcn_info() [1/2]

fcn_info::fcn_info ( const std::string &  nm = "")
inline

Definition at line 243 of file fcn-info.h.

◆ fcn_info() [2/2]

fcn_info::fcn_info ( const fcn_info &  )
default

◆ ~fcn_info()

fcn_info::~fcn_info ( void  )
default

Member Function Documentation

◆ builtin_find()

octave_value fcn_info::builtin_find ( const symbol_scope &  search_scope)
inline

Definition at line 259 of file fcn-info.h.

Referenced by symbol_table::builtin_find().

◆ clear()

void fcn_info::clear ( bool  force = false)
inline

Definition at line 338 of file fcn-info.h.

◆ clear_autoload_function()

void fcn_info::clear_autoload_function ( bool  force = false)
inline

Definition at line 345 of file fcn-info.h.

Referenced by symbol_table::clear_dld_function().

◆ clear_mex_function()

void fcn_info::clear_mex_function ( void  )
inline

Definition at line 350 of file fcn-info.h.

◆ clear_user_function()

void fcn_info::clear_user_function ( bool  force = false)
inline

Definition at line 340 of file fcn-info.h.

Referenced by symbol_table::clear_dld_function(), and symbol_table::clear_user_function().

◆ dump()

octave_value fcn_info::dump ( void  ) const
inline

Definition at line 352 of file fcn-info.h.

References octave_value::dump().

Referenced by symbol_table::dump_fcn_table_map(), and F__dump_symtab_info__().

◆ find()

octave_value fcn_info::find ( const symbol_scope &  search_scope,
const octave_value_list &  args = octave_value_list () 
)
inline

Definition at line 252 of file fcn-info.h.

Referenced by symbol_table::fcn_table_find().

◆ find_autoload()

octave_value fcn_info::find_autoload ( void  )
inline

Definition at line 289 of file fcn-info.h.

Referenced by symbol_table::find_autoload(), fcn_info::fcn_info_rep::x_builtin_find(), and fcn_info::fcn_info_rep::xfind().

◆ find_built_in_function()

octave_value fcn_info::find_built_in_function ( void  ) const
inline

Definition at line 279 of file fcn-info.h.

Referenced by symbol_table::find_built_in_function().

◆ find_cmdline_function()

octave_value fcn_info::find_cmdline_function ( void  ) const
inline

Definition at line 284 of file fcn-info.h.

Referenced by symbol_table::find_cmdline_function().

◆ find_function()

octave_value fcn_info::find_function ( const symbol_scope &  search_scope,
const octave_value_list &  args = octave_value_list () 
)
inline

Definition at line 306 of file fcn-info.h.

◆ find_method()

octave_value fcn_info::find_method ( const std::string &  dispatch_type) const
inline

Definition at line 274 of file fcn-info.h.

Referenced by fcn_info::fcn_info_rep::find_method(), symbol_table::find_method(), fcn_info::fcn_info_rep::load_class_method(), and fcn_info::fcn_info_rep::xfind().

◆ find_private_function()

octave_value fcn_info::find_private_function ( const std::string &  dir_name) const
inline

Definition at line 269 of file fcn-info.h.

Referenced by symbol_table::find_private_function(), and fcn_info::fcn_info_rep::find_scoped_function().

◆ find_scoped_function()

octave_value fcn_info::find_scoped_function ( const symbol_scope &  search_scope) const
inline

Definition at line 264 of file fcn-info.h.

Referenced by symbol_table::find_scoped_function(), and fcn_info::fcn_info_rep::xfind().

◆ find_user_function()

octave_value fcn_info::find_user_function ( void  )
inline

Definition at line 295 of file fcn-info.h.

Referenced by symbol_table::find_user_function(), fcn_info::fcn_info_rep::load_class_constructor(), fcn_info::fcn_info_rep::x_builtin_find(), and fcn_info::fcn_info_rep::xfind().

◆ install_built_in_dispatch()

void fcn_info::install_built_in_dispatch ( const std::string &  klass)
inline

Definition at line 333 of file fcn-info.h.

Referenced by symbol_table::install_built_in_dispatch().

◆ install_built_in_function()

void fcn_info::install_built_in_function ( const octave_value &  f)
inline

Definition at line 328 of file fcn-info.h.

References f.

Referenced by symbol_table::alias_built_in_function(), and symbol_table::install_built_in_function().

◆ install_cmdline_function()

void fcn_info::install_cmdline_function ( const octave_value &  f)
inline

Definition at line 312 of file fcn-info.h.

References f.

Referenced by symbol_table::install_cmdline_function().

◆ install_local_function()

void fcn_info::install_local_function ( const octave_value &  f,
const std::string &  file_name 
)
inline

Definition at line 317 of file fcn-info.h.

References f.

Referenced by symbol_table::install_local_function().

◆ install_user_function()

void fcn_info::install_user_function ( const octave_value &  f)
inline

Definition at line 323 of file fcn-info.h.

References f.

Referenced by symbol_table::install_user_function().

◆ is_user_function_defined()

bool fcn_info::is_user_function_defined ( void  ) const
inline

Definition at line 300 of file fcn-info.h.

◆ operator=()

fcn_info& fcn_info::operator= ( const fcn_info &  )
default

Member Data Documentation

◆ m_rep

std::shared_ptr<fcn_info_rep> fcn_info::m_rep
private

Definition at line 356 of file fcn-info.h.

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