Recent changes to Overview

Overview modified by ENGITEX

ENGITEX — Mon, 09 Oct 2023 08:47:04 -0000

--- v5
+++ v6
@@ -19,6 +19,8 @@
 (b) `myfunc` has not completed (an error has occured)
 This is why it is recommended to add an exit code as an output parameter if `myfunc` is "void".

+As a side note, Windows OS supports many CPUs and will distribute the load from several `parstart` calls in more or less optimal way.
+
 See also:
 [API reference]
 [System requirements]

Overview modified by ENGITEX

ENGITEX — Mon, 09 Oct 2023 08:29:01 -0000

--- v4
+++ v5
@@ -6,7 +6,7 @@
 But the call to `pararrayfun` itself is still synchronous.

 This library is supposed to be used in a similar way as asynchronous calls are used in Python and C#:
-`pid = parstart("myfunc", arg_in1, arg_in2, ...)`
+`pid = parstart("myfunc", argin1, argin2, ...)`
 This call returns quickly and the user can do other jobs.
 The current status of the `mufunc` call can be checked by `running(pid)`
 When the function has completed, `running(pid) == 0`

Overview modified by ENGITEX

ENGITEX — Mon, 09 Oct 2023 08:27:39 -0000

--- v3
+++ v4
@@ -1,3 +1,24 @@
+### Overview
+
+The library lets a user make asynchronous function calls in GNU Octave.
+The existing [Parallel Package](https://wiki.octave.org/Parallel_package) allows parallel function calls in the following way:
+`output_vector = pararrayfun(n_cores, @myfunc, input_vector)`
+But the call to `pararrayfun` itself is still synchronous.
+
+This library is supposed to be used in a similar way as asynchronous calls are used in Python and C#:
+`pid = parstart("myfunc", arg_in1, arg_in2, ...)`
+This call returns quickly and the user can do other jobs.
+The current status of the `mufunc` call can be checked by `running(pid)`
+When the function has completed, `running(pid) == 0`
+and the output parameters from `myfunc` (if any) should be obtained by calling
+`d = get_data(pid)`
+
+The parameters will be packed in a structure `d`.
+An empty [](0x0) array is returned if
+(a) `myfunc` has no output parameters, or
+(b) `myfunc` has not completed (an error has occured)
+This is why it is recommended to add an exit code as an output parameter if `myfunc` is "void".
+
 See also:
 [API reference]
 [System requirements]

Overview modified by ENGITEX

ENGITEX — Mon, 09 Oct 2023 07:21:47 -0000

--- v2
+++ v3
@@ -1,4 +1,3 @@
-
 See also:
 [API reference]
 [System requirements]

Overview modified by ENGITEX

ENGITEX — Mon, 09 Oct 2023 07:20:58 -0000

--- v1
+++ v2
@@ -1,8 +1,4 @@
-Welcome to your wiki!

-This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].
-
-The wiki uses [Markdown](/p/parallel-octave/wiki/markdown_syntax/) syntax.
-
-[[members limit=20]]
-[[download_button]]
+See also:
+[API reference]
+[System requirements]

Home modified by ENGITEX

ENGITEX — Mon, 09 Oct 2023 06:59:56 -0000

Welcome to your wiki!

This is the default page, edit it as you see fit. To add a new page simply reference it within brackets, e.g.: [SamplePage].

The wiki uses Markdown syntax.

Project Members:

ENGITEX (admin)