mboct-octave-pkg

This package belongs to a suite of packages which can be used for pre- and postprocessing of flexible bodies in MBDyn (www.mbdyn.org) with GNU-Octave. It contains general purpose utility functions used in all mboct-* packages.

Select category:

Processes

shell
Execute a command within the POSIX shell on WIN32 systems with Msys.
spawn
Start the program identified by COMMAND on Unix or Windows systems and return it's PID
spawn_wait
Wait until the program identified by PID exits and return it's exit status
run_parallel
Distribute the execution of a function to multiple processes and return the results of each call as an cell array.
run_parallel_func
Helper function used by run_parallel
run_parallel_helper
Allow us to run code like this: evalin("base", "clear all");

Design of experiment

doe_param_dim_to_res_dim
Return the total number of function evaluations needed by a DOE with PARAMETER_DIM dimensions.
doe_res_idx_to_param_idx
This function is useful to distribute DOE's to multiple processes with run_parallel.

Exception handling

error_report
Print an error report for ERR to a file FD or to stderr

Utility

addpath_full
Add PATHNAME to octave's search path as an absolute pathname.
struct_print
Prints the struct PARAM to the file associated with file descriptor FOUT.
struct_sizeof
Print a report for memory usage of variable S to file descriptor FD or to stdout.

Plotting

figure_export_ascii
Creates an ASCII file to be imported by MS Excel from all figures in range .
figure_hide
Hide a list of figures identified by IFIG
figure_list
Print a list of all figures (visible or invisible)
figure_set_visible
Makes several figures, identified by IFIG, visible or invisible and select a graphics toolkit for it.
figure_show
Make hidden figures, identified by , visible and optionally select the graphics toolkit for it.
pdf_create
Creates a Pdf file from all figures listed in NFIG
pdf_merge
Combine several Pdf files listed in INPUT_FILENAMES into a single file identified by OUTPUT_FILENAME.
printable_title
Prepare a string to be displayed in a figure (e.g. without underscores)

Interpolation

griddata_prepared
This is an optimized variant of Octave's builtin griddata function where the triangulation has to be performed only once.

Command-line parsing

overwrite_struct
This function is useful for Octave programs which allow user input in form of octave expressions passed as command line arguments.
overwrite_struct_add_arg
Add a command line argument CMD_ARGS to a list of values OVERWRITE_IN which can be passed to overwrite_struct.

Testing

assert_simple
Produce an error if the specified condition is not met.
exec_demo
Executes a demo function in the global context, and leave all variables in place
exec_test
Execute a test from a function file within the global context and leave all variables in place.
run_tests_parallel
Distribute the execution of all test functions from a package to multiple processes PACKAGE_NAMES ...
run_tests_parallel_handler
Execute Octave's test function in parallel

Package: mboct-octave-pkg