GNU Octave  4.2.1
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
octave Namespace Reference

Octave interface to the compression and uncompression libraries. More...

Namespaces

 build_env
 
 crypto
 
 math
 
 string
 Octave string utility functions.
 
 sys
 

Classes

class  base_interrupt_manager
 
class  base_lexer
 
class  base_list
 
class  base_parser
 
class  base_text_renderer
 
class  base_url_transfer
 
class  CFile
 RIIA wrapper for std::FILE*. More...
 
class  child
 
class  child_list
 
class  command_editor
 
class  command_history
 
class  complex_index_exception
 
class  curl_transfer
 
class  default_command_editor
 
class  delimited_stream
 
class  directory_path
 
class  dynamic_library
 
union  equiv
 
struct  float_params
 
class  ft_manager
 
class  ft_text_renderer
 
class  gui_application
 
class  index_exception
 
class  interpreter
 
struct  interrupt_handler
 
class  interrupt_manager
 
class  invalid_index
 
class  JVMArgs
 
class  lexer
 
class  lexical_feedback
 
class  mach_info
 
class  opengl_renderer
 
class  opengl_selector
 
class  opengl_tesselator
 
class  opengl_texture
 
class  out_of_range
 
class  parser
 
class  pid_equal
 
class  posix_interrupt_manager
 
class  push_lexer
 
class  push_parser
 
class  regexp
 
struct  rep_token_t
 
class  text_renderer
 
class  textscan
 
class  textscan_format_elt
 
class  textscan_format_list
 
class  tree_evaluator
 
class  unwind_protect
 
class  unwind_protect_safe
 
class  url_transfer
 
class  vertex_data
 

Typedefs

typedef void sig_handler (int)
 

Enumerations

enum  { UNIFORM, FLAT, INTERP, TEXTURE }
 
enum  { NONE, GOURAUD = 2 }
 
enum  { X_AXIS, Y_AXIS, Z_AXIS }
 
enum  select_flags { select_ignore_hittest = 0x01, select_last = 0x02 }
 

Functions

interrupt_handler catch_interrupts (void)
 
char * do_completer_word_break_hook ()
 
static int equiv_compare (const equiv *std, const equiv *v, int len)
 
void err_del_index_out_of_range (bool is1d, octave_idx_type idx, octave_idx_type ext)
 
void err_index_out_of_range (int nd, int dim, octave_idx_type idx, octave_idx_type ext)
 
void err_index_out_of_range (int nd, int dim, octave_idx_type idx, octave_idx_type ext, const dim_vector &d)
 
void err_invalid_index (const std::string &idx, octave_idx_type nd, octave_idx_type dim, const std::string &)
 
void err_invalid_index (octave_idx_type n, octave_idx_type nd, octave_idx_type dim, const std::string &var)
 
void err_invalid_index (double n, octave_idx_type nd, octave_idx_type dim, const std::string &var)
 
void err_invalid_resize (void)
 
void err_nan_to_character_conversion (void)
 
void err_nan_to_logical_conversion (void)
 
void err_nonconformant (const char *op, octave_idx_type op1_len, octave_idx_type op2_len)
 
void err_nonconformant (const char *op, octave_idx_type op1_nr, octave_idx_type op1_nc, octave_idx_type op2_nr, octave_idx_type op2_nc)
 
void err_nonconformant (const char *op, const dim_vector &op1_dims, const dim_vector &op2_dims)
 
static void generic_sig_handler (int sig)
 
static mach_info::float_format get_float_format (void)
 
void gl2ps_print (const graphics_object &fig, const std::string &stream, const std::string &term)
 
static std::string gl_get_string (GLenum id)
 
interrupt_handler ignore_interrupts (void)
 
void install_signal_handlers (void)
 
bool is_keyword (const std::string &s)
 
base_text_renderermake_ft_text_renderer (void)
 
static octave_scalar_map make_sig_struct (void)
 
static void my_friendly_exit (const char *sig_name, int sig_number, bool save_vars=true)
 
static int read_data (void *buffer, size_t size, size_t nmemb, void *streamp)
 
interrupt_handler set_interrupt_handler (const volatile interrupt_handler &h, bool restart_syscalls)
 
static void set_sig_struct_field (octave_scalar_map &m, const char *signame)
 
sig_handlerset_signal_handler (int sig, sig_handler *handler, bool restart_syscalls)
 
sig_handlerset_signal_handler (const char *signame, sig_handler *handler, bool restart_syscalls)
 
static void sig_hup_handler (int)
 
static void sig_term_handler (int)
 
static void sigchld_handler (int sig)
 
static void sigint_handler (int sig)
 
void signal_handler (void)
 
static void sigpipe_handler (int sig)
 
static bool ten_little_endians (void)
 
static size_t throw_away (void *, size_t size, size_t nmemb, void *)
 
static void user_abort (const char *sig_name, int sig_number)
 
void warn_singular_matrix (double rcond)
 
static int write_data (void *buffer, size_t size, size_t nmemb, void *streamp)
 
template<typename X >
string_vector xzip (const Array< std::string > &source_patterns, const std::function< std::string(const std::string &)> &mk_dest_path)
 
template<typename X >
string_vector xzip (const Array< std::string > &source_patterns)
 
template<typename X >
string_vector xzip (const Array< std::string > &source_patterns, const std::string &out_dir)
 
template<typename X >
static octave_value_list xzip (const std::string &func_name, const octave_value_list &args)
 

Variables

bool can_interrupt = false
 
tree_evaluatorcurrent_evaluator
 
static octave_mutex event_hook_lock
 
base_lexerLEXER
 
int pipe_handler_error_count = 0
 
static boolsignals_caught = 0
 
bool Vdebug_on_interrupt = false
 
static bool Vsighup_dumps_octave_core = true
 
static bool Vsigterm_dumps_octave_core = true
 

Detailed Description

Octave interface to the compression and uncompression libraries.

This was originally implemented as an m file which directly called bzip2 and gzip applications. This may look simpler but causes some issues (see bug #43431) because we have no control over the output file:

In addition, because system() does not have a method that allows passing a list of arguments, there is the issue of having to escape filenames.

A solution is to pipe file contents into the applications instead of filenames. However, that solution causes:

missing file header with original file information;

implementing ourselves the recursive transversion of directories;

do the above in a m file which will be slow;

popen2 is frail on windows.

Typedef Documentation

typedef void octave::sig_handler(int)

Definition at line 43 of file sighandlers.h.

Enumeration Type Documentation

anonymous enum
Enumerator
UNIFORM 
FLAT 
INTERP 
TEXTURE 

Definition at line 73 of file gl-render.cc.

anonymous enum
Enumerator
NONE 
GOURAUD 

Definition at line 82 of file gl-render.cc.

anonymous enum
Enumerator
X_AXIS 
Y_AXIS 
Z_AXIS 

Definition at line 65 of file gl-render.cc.

Enumerator
select_ignore_hittest 
select_last 

Definition at line 34 of file gl-select.h.

Function Documentation

OCTINTERP_API interrupt_handler octave::catch_interrupts ( void  )
char* octave::do_completer_word_break_hook ( )
static int octave::equiv_compare ( const equiv std,
const equiv v,
int  len 
)
static

Definition at line 66 of file mach-info.cc.

Referenced by get_float_format().

OCTAVE_NORETURN OCTAVE_API void octave::err_del_index_out_of_range ( bool  is1d,
octave_idx_type  idx,
octave_idx_type  ext 
)
OCTAVE_NORETURN OCTAVE_API void octave::err_index_out_of_range ( int  nd,
int  dim,
octave_idx_type  idx,
octave_idx_type  ext 
)
OCTAVE_NORETURN OCTAVE_API void octave::err_index_out_of_range ( int  nd,
int  dim,
octave_idx_type  idx,
octave_idx_type  ext,
const dim_vector d 
)

Definition at line 292 of file lo-array-errwarn.cc.

References e.

OCTAVE_NORETURN OCTAVE_API void octave::err_invalid_index ( const std::string idx,
octave_idx_type  nd,
octave_idx_type  dim,
const std::string  
)
OCTAVE_NORETURN OCTAVE_API void octave::err_invalid_index ( octave_idx_type  n,
octave_idx_type  nd,
octave_idx_type  dim,
const std::string var 
)

Definition at line 204 of file lo-array-errwarn.cc.

References err_invalid_index(), and var.

OCTAVE_NORETURN OCTAVE_API void octave::err_invalid_index ( double  n,
octave_idx_type  nd,
octave_idx_type  dim,
const std::string var 
)

Definition at line 213 of file lo-array-errwarn.cc.

References err_invalid_index(), and var.

OCTAVE_NORETURN OCTAVE_API void octave::err_invalid_resize ( void  )
OCTAVE_NORETURN OCTAVE_API void octave::err_nan_to_character_conversion ( void  )
OCTAVE_NORETURN OCTAVE_API void octave::err_nan_to_logical_conversion ( void  )
OCTAVE_NORETURN OCTAVE_API void octave::err_nonconformant ( const char *  op,
octave_idx_type  op1_len,
octave_idx_type  op2_len 
)
OCTAVE_NORETURN OCTAVE_API void octave::err_nonconformant ( const char *  op,
octave_idx_type  op1_nr,
octave_idx_type  op1_nc,
octave_idx_type  op2_nr,
octave_idx_type  op2_nc 
)

Definition at line 72 of file lo-array-errwarn.cc.

References error_id_nonconformant_args.

OCTAVE_NORETURN OCTAVE_API void octave::err_nonconformant ( const char *  op,
const dim_vector op1_dims,
const dim_vector op2_dims 
)

Definition at line 84 of file lo-array-errwarn.cc.

References error_id_nonconformant_args, dim_vector::str(), and string.

static void octave::generic_sig_handler ( int  sig)
static

Definition at line 420 of file sighandlers.cc.

References my_friendly_exit(), and octave_strsignal_wrapper().

Referenced by install_signal_handlers().

static mach_info::float_format octave::get_float_format ( void  )
static
OCTINTERP_API void octave::gl2ps_print ( const graphics_object fig,
const std::string stream,
const std::string term 
)
static std::string octave::gl_get_string ( GLenum  id)
static

Definition at line 713 of file gl-render.cc.

References string.

Referenced by octave::opengl_renderer::draw_figure().

OCTINTERP_API interrupt_handler octave::ignore_interrupts ( void  )
OCTINTERP_API void octave::install_signal_handlers ( void  )
bool octave::is_keyword ( const std::string s)
base_text_renderer * octave::make_ft_text_renderer ( void  )

Definition at line 1378 of file ft-text-renderer.cc.

Referenced by make_text_renderer().

static octave_scalar_map octave::make_sig_struct ( void  )
static

Definition at line 683 of file sighandlers.cc.

References m, and set_sig_struct_field().

Referenced by FSIG().

static void octave::my_friendly_exit ( const char *  sig_name,
int  sig_number,
bool  save_vars = true 
)
static
static int octave::read_data ( void *  buffer,
size_t  size,
size_t  nmemb,
void *  streamp 
)
static

Definition at line 230 of file url-transfer.cc.

Referenced by octave::curl_transfer::init().

OCTINTERP_API interrupt_handler octave::set_interrupt_handler ( const volatile interrupt_handler &  h,
bool  restart_syscalls 
)
static void octave::set_sig_struct_field ( octave_scalar_map m,
const char *  signame 
)
static
OCTINTERP_API sig_handler * octave::set_signal_handler ( int  sig,
sig_handler *  handler,
bool  restart_syscalls 
)
OCTINTERP_API sig_handler * octave::set_signal_handler ( const char *  signame,
sig_handler *  handler,
bool  restart_syscalls 
)

Definition at line 412 of file sighandlers.cc.

References octave_set_signal_handler_by_name().

static void octave::sig_hup_handler ( int  )
static

Definition at line 451 of file sighandlers.cc.

References clean_up_and_exit(), and dump_octave_core().

Referenced by install_signal_handlers().

static void octave::sig_term_handler ( int  )
static

Definition at line 460 of file sighandlers.cc.

References clean_up_and_exit(), and dump_octave_core().

Referenced by install_signal_handlers().

static void octave::sigchld_handler ( int  sig)
static

Definition at line 428 of file sighandlers.cc.

References octave_signal_caught.

Referenced by install_signal_handlers().

static void octave::sigint_handler ( int  sig)
static
OCTINTERP_API void octave::signal_handler ( void  )
static void octave::sigpipe_handler ( int  sig)
static

Definition at line 546 of file sighandlers.cc.

References octave_interrupt_state, and octave_signal_caught.

Referenced by install_signal_handlers().

static bool octave::ten_little_endians ( void  )
static

Definition at line 122 of file mach-info.cc.

References c, and u.

static size_t octave::throw_away ( void *  ,
size_t  size,
size_t  nmemb,
void *   
)
static

Definition at line 241 of file url-transfer.cc.

Referenced by octave::curl_transfer::get_fileinfo().

static void octave::user_abort ( const char *  sig_name,
int  sig_number 
)
static
OCTAVE_API void octave::warn_singular_matrix ( double  rcond)
static int octave::write_data ( void *  buffer,
size_t  size,
size_t  nmemb,
void *  streamp 
)
static
template<typename X >
string_vector octave::xzip ( const Array< std::string > &  source_patterns,
const std::function< std::string(const std::string &)> &  mk_dest_path 
)
template<typename X >
string_vector octave::xzip ( const Array< std::string > &  source_patterns)

Definition at line 489 of file gzip.cc.

References string.

template<typename X >
string_vector octave::xzip ( const Array< std::string > &  source_patterns,
const std::string out_dir 
)
template<typename X >
static octave_value_list octave::xzip ( const std::string func_name,
const octave_value_list args 
)
static

Definition at line 522 of file gzip.cc.

References octave_value_list::length(), nargin, octave_value(), print_usage(), and string.

Variable Documentation

OCTINTERP_API bool octave::can_interrupt = false

Definition at line 67 of file sighandlers.cc.

Referenced by recover_from_exception().

tree_evaluator* octave::current_evaluator
octave_mutex octave::event_hook_lock
static

Definition at line 64 of file cmd-edit.cc.

base_lexer* octave::LEXER

Definition at line 139 of file oct-parse.cc.

int octave::pipe_handler_error_count = 0

Definition at line 64 of file sighandlers.cc.

Referenced by octave_base_reader::octave_gets().

bool* octave::signals_caught = 0
static

Definition at line 81 of file sighandlers.cc.

OCTINTERP_API bool octave::Vdebug_on_interrupt = false
bool octave::Vsighup_dumps_octave_core = true
static

Definition at line 75 of file sighandlers.cc.

bool octave::Vsigterm_dumps_octave_core = true
static

Definition at line 78 of file sighandlers.cc.