# doc-cache created by Octave 11.3.0
# name: cache
# type: cell
# rows: 3
# columns: 25
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
addpath_full


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 161
 -- Function File: addpath_full(PATHNAME)

     Add PATHNAME to octave's search path as an absolute pathname.  This
     function supports also shell expansions.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 61
Add PATHNAME to octave's search path as an absolute pathname.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
assert_simple


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 2023
 -- assert_simple (COND)
 -- assert_simple (COND, ERRMSG)
 -- assert_simple (COND, ERRMSG, ...)
 -- assert_simple (COND, MSG_ID, ERRMSG, ...)
 -- assert_simple (OBSERVED, EXPECTED)
 -- assert_simple (OBSERVED, EXPECTED, TOL)

     Produce an error if the specified condition is not met.  The reason why we
     cannot just call assert is, that assert might be excessively slow in some
     situations.  For that reason, assert may break a whole testsuite just
     because a single assertion fails and the error message becomes too long.

     ‘assert_simple’ can be called in three different ways.

     ‘assert_simple (COND)’
     ‘assert_simple (COND, ERRMSG)’
     ‘assert_simple (COND, ERRMSG, ...)’
     ‘assert_simple (COND, MSG_ID, ERRMSG, ...)’
          Called with a single argument COND, ‘assert_simple’ produces an error
          if COND is false (numeric zero).

          Any additional arguments are passed to the ‘error’ function for
          processing.

     ‘assert_simple (OBSERVED, EXPECTED)’
          Produce an error if observed is not the same as expected.

          Note that OBSERVED and EXPECTED can be scalars, vectors, matrices,
          strings, cell arrays, or structures.

     ‘assert_simple (OBSERVED, EXPECTED, TOL)’
          Produce an error if observed is not the same as expected but equality
          comparison for numeric data uses a tolerance TOL.

          If TOL is positive then it is an absolute tolerance which will produce
          an error if ‘abs (OBSERVED - EXPECTED) > abs (TOL)’.

          If TOL is negative then it is a relative tolerance which will produce
          an error if ‘abs (OBSERVED - EXPECTED) > abs (TOL * EXPECTED)’.

          If EXPECTED is zero TOL will always be interpreted as an absolute
          tolerance.

          If TOL is not scalar its dimensions must agree with those of OBSERVED
          and EXPECTED and tests are performed on an element-by-element basis.

     See also: assert.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 55
Produce an error if the specified condition is not met.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 24
doe_param_dim_to_res_dim


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 223
 -- Function File: N = doe_param_dim_to_res_dim(PARAMETER_DIM)
     Return the total number of function evaluations needed by a DOE with
     PARAMETER_DIM dimensions.

     See also: run_parallel, doe_res_idx_to_param_idx.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Return the total number of function evaluations needed by a DOE with
PARAMETE...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 24
doe_res_idx_to_param_idx


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1216
 -- Function File: PARAM_IDX = doe_res_idx_to_param_idx(PARAMETER_DIM,
          RESULT_INDEX)
     This function is useful to distribute DOE's to multiple processes with
     run_parallel.  For example we have a scalar function Y = f(X_1, X_2, ...,
     X_N) which depends on N scalar parameters.  For each parameter X_i the
     function f should be evaluated for PARAMETER_DIM(i) different values.  In
     this case the total number of function evaluations to be executed by
     run_parallel will be NUMBER_OF_PARAMETERS =
     doe_param_dim_to_res_dim(PARAMETER_DIM).  Run_parallel will pass
     RESULT_INDEX as the first argument to the user supplied callback function
     FUNC.  Then the callback function FUNC can use the return value PARAM_IDX
     from doe_res_idx_to_param_idx(PARAMETER_DIM, RESULT_INDEX) to evaluate X_i.

     Y{RESULT_INDEX} = f(X_1(PARAM_IDX(1)), X_2(PARAM_IDX(2)), ...,
     X_N(PARAM_IDX(N)))

     PARAMETER_DIM ... array containing the number of different values for each
     parameter in the DOE

     RESULT_INDEX ... index of the function call (e.g.  the first argument
     passed to a user function by run_parallel)

     See also: run_parallel, doe_param_dim_to_res_dim.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
This function is useful to distribute DOE's to multiple processes with
run_pa...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
error_report


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 142
 -- Function File: error_report()
 -- error_report(ERR)
 -- error_report(ERR, FD)
     Print an error report for ERR to a file FD or to stderr


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 55
Print an error report for ERR to a file FD or to stderr



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
exec_demo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 384
 -- Function File: exec_demo(FILENAME)
 -- exec_demo(FILENAME, INDEX)
 -- exec_demo(FILENAME, INDEX, FIRST_LINE)
 -- exec_demo(FILENAME, INDEX, FIRST_LINE, TYPE)

     Executes a demo function in the global context, and leave all variables in
     place

     INDEX index of the demo

     FIRST_LINE first code line to be executed

     TYPE type of function (e.g.  "demo" or "test")


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Executes a demo function in the global context, and leave all variables in pl...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
exec_test


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 218
 -- Function File: exec_test(FILENAME)
 -- exec_test(FILENAME, INDEX)
 -- exec_test(FILENAME, INDEX, FIRST_LINE)
     Execute a test from a function file within the global context and leave all
     variables in place.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Execute a test from a function file within the global context and leave all
v...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
figure_export_ascii


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 513
 -- Function File: figure_export_ascii(NFIG, OUTPUT_FILENAME)

 -- Function File: figure_export_ascii(NFIG, OUTPUT_FILENAME, SAMPLE_RATE)

     Creates an ASCII file to be imported by MS Excel from all figures in range
     <NFIG>.  Only those curves will be written to the ASCII file which have a
     name.

     NFIG ... Array of figure handles.

     OUTPUT_FILENAME ... Name of the output file.

     SAMPLE_RATE ... Define this value to an integer higher than one in order to
     reduce the amount of data.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Creates an ASCII file to be imported by MS Excel from all figures in range
<N...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
figure_hide


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 145
 -- Function File: figure_hide(IFIG)
     Hide a list of figures identified by IFIG

     See also: figure_show, figure_set_visible, figure_list.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 41
Hide a list of figures identified by IFIG



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
figure_list


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 150
 -- Function File: figure_list()
     Print a list of all figures (visible or invisible)

     See also: figure_show, figure_hide, figure_set_visible.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 50
Print a list of all figures (visible or invisible)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 18
figure_set_visible


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 367
 -- Function File: figure_set_visible(IFIG, VISIBLE)
 -- figure_set_visible(..., TOOLKIT)
     Makes several figures, identified by IFIG, visible or invisible and select
     a graphics toolkit for it.

     IFIG ... Array of figure handles

     TOOLKIT ... String name of graphics toolkit to be selected for IFIG

     See also: figure_show,figure_hide,figure_list.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Makes several figures, identified by IFIG, visible or invisible and select a
...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 11
figure_show


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 373
 -- Function File: figure_show(IFIG)
 -- figure_show(IFIG, TOOLKIT)
     Make hidden figures, identified by <IFIG>, visible and optionally select
     the graphics toolkit for it.

     IFIG ... Array of figure handles

     TOOLKIT ... String name of the graphics toolkit to be selected for figure
     <IFIG>.

     See also: figure_hide, figure_list, figure_set_visible.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Make hidden figures, identified by <IFIG>, visible and optionally select the
...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
griddata_prepared


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 390
 -- Function File: ZI = griddata_prepared (X, Y, Z, XI, YI, TRI)
 -- ZI = griddata_prepared (X, Y, Z, XI, YI, TRI, METHOD)
 -- [XI, YI, ZI] = griddata_prepared (...)

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

     TRI ... triangulation data returned from delaunay

     See also: griddata, delaunay.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
This is an optimized variant of Octave's builtin griddata function where the
...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 16
overwrite_struct


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 809
 -- Function File: DATA = overwrite_struct(DATA_IN, OVERWRITE)
 -- ... = overwrite_struct(DATA_IN, OVERWRITE, OPTIONS)
     This function is useful for Octave programs which allow user input in form
     of octave expressions passed as command line arguments.  Overwrite a value
     in a struct by an expression passed as a character string.

     DATA_IN ... input data structure

     OVERWRITE ... return value from overwrite_struct_add_arg

     OPTIONS.verbose ... enable verbose output

          ov.data.x = 1;
          ov.data.y = 2;
          args = {"data.x=1.5", "data.y=2.5"};
          ovd = struct()([]);
          for i=1:numel(args)
            ovd = overwrite_struct_add_arg(ovd, args{i});
          endfor
          ov = overwrite_struct(ov, ovd);

     See also: overwrite_struct_add_arg.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
This function is useful for Octave programs which allow user input in form of...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 24
overwrite_struct_add_arg


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 233
 -- Function File: OVERWRITE = overwrite_struct_add_arg(OVERWRITE_IN, CMD_ARG)
     Add a command line argument CMD_ARGS to a list of values OVERWRITE_IN which
     can be passed to overwrite_struct.

     See also: overwrite_struct.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Add a command line argument CMD_ARGS to a list of values OVERWRITE_IN which c...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 10
pdf_create


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 725
 -- Function File: [RC]=pdf_create()
 -- [...]=pdf_create(NFIG)
 -- [...]=pdf_create(NFIG, OUTPUT_FILENAME)
 -- [...]=pdf_create(NFIG, OUTPUT_FILENAME, WIDTH, HEIGHT)
 -- [...]=pdf_create(NFIG, OUTPUT_FILENAME, WIDTH, HEIGHT, DELETE_TMP_FILES)
 -- [...]=pdf_create(NFIG, OUTPUT_FILENAME, WIDTH, HEIGHT, DELETE_TMP_FILES,
          SINGLE_PDF)

     Creates a Pdf file from all figures listed in NFIG

     NFIG ... array of figure handles or character string "all"

     OUTPUT_FILENAME ... pdf file path

     WIDTH ... page width

     HEIGHT ... page height

     DELETE_TMP_FILES ... if true, temporary files will be deleted

     SINGLE_PDF ... if true, write all figures to a single .pdf file

     See also: pdf_merge.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 50
Creates a Pdf file from all figures listed in NFIG



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 9
pdf_merge


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 532
 -- Function File: STATUS = pdf_merge(INPUT_FILENAMES, OUTPUT_FILENAME, VERBOSE)
     Combine several Pdf files listed in INPUT_FILENAMES into a single file
     identified by OUTPUT_FILENAME.  If one has many pdf files to be merged,
     pdf_merge is significantly faster than using the "-append" option of print.

     INPUT_FILENAMES ... cell array of strings containing input filenames

     OUTPUT_FILENAME ... char string containing the output filename

     VERBOSE ... enable verbose output

     See also: pdf_create,print.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Combine several Pdf files listed in INPUT_FILENAMES into a single file
identi...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
printable_title


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 126
 -- Function File: S_OUT = printable_title(S_IN)
     Prepare a string to be displayed in a figure (e.g.  without underscores)


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 72
Prepare a string to be displayed in a figure (e.g.  without underscores)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
run_parallel


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 771
 -- Function File: RES = run_parallel(OPTIONS, FUNC, VARARGIN)
     Distribute the execution of a function to multiple processes and return the
     results of each call as an cell array.

     OPTIONS.number_of_parameters ... total number of calls to FUNC to be
     executed

     OPTIONS.number_of_processors ... maximum number of processes running at the
     same time

     OPTIONS.ignore_errors ... continue if FUNC throws an exception

     OPTIONS.octave_exec ... Octave's executable to start

     FUNC ... user function to be called (e.g.  res{idx} = feval(func, idx,
     varargin{:}))

     VARARGIN ... additional arguments to be passed to FUNC

     See also: run_parallel_func, run_parallel_helper, doe_param_dim_to_res_dim,
     doe_res_idx_to_param_idx.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Distribute the execution of a function to multiple processes and return the
r...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
run_parallel_func


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 262
 -- Function File: run_parallel_func(PROC_IDX, DATA)
     Helper function used by run_parallel

     PROC_IDX ... index of current process in the call to run_parallel

     DATA ... data passed by the calling process in run_parallel

     See also: run_parallel.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 36
Helper function used by run_parallel



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
run_parallel_helper


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 115
 -- Script File: run_parallel_helper
     Helper script which is used by run_parallel

     See also: run_parallel.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 43
Helper script which is used by run_parallel



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 18
run_tests_parallel


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 233
 -- Function File: STATUS = run_tests_parallel(NUMBER_OF_PROCESSORS,
          PACKAGE_NAMES)
     Distribute the execution of all test functions from a package to multiple
     processes PACKAGE_NAMES ... Cell array of package names


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Distribute the execution of all test functions from a package to multiple
pro...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 26
run_tests_parallel_handler


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 154
 -- Function File: STATUS = run_tests_parallel_handler(IDX, PKG_FILES)
     Execute Octave's test function in parallel

     See also: run_tests_parallel.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 42
Execute Octave's test function in parallel



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 12
struct_print


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 292
 -- Function File: struct_print (PARAM,FOUT,PREFIX)

     Prints the struct PARAM to the file associated with file descriptor FOUT.
     Optionally the string PREFIX can be used as the name of the data structure.
     The output can be loaded into octave again by means of the source command.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 73
Prints the struct PARAM to the file associated with file descriptor FOUT.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
struct_sizeof


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 152
 -- Function File: struct_sizeof(S)
 -- struct_sizeof(S, FD)
     Print a report for memory usage of variable S to file descriptor FD or to
     stdout.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Print a report for memory usage of variable S to file descriptor FD or to
std...





