changeset 26588:21708bdc1c07 stable

doc: Clarify that parfor is not implemented. * op-kw-docs (Fparfor): Clarify that parfor is currently unimplemented.
author Andrew Janke <andrew@apjanke.net>
date Fri, 18 Jan 2019 21:32:12 -0500
parents 745e3d3814a4
children 7f58079955b3
files libinterp/op-kw-docs
diffstat 1 files changed, 12 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/op-kw-docs	Mon Jan 21 18:24:52 2019 -0800
+++ b/libinterp/op-kw-docs	Fri Jan 18 21:32:12 2019 -0500
@@ -673,6 +673,18 @@
 @deftypefnx {} {} parfor (@var{i} = @var{range}, @var{maxproc})
 Begin a for loop that may execute in parallel.
 
+A @code{parfor} loop has the same syntax as a @code{for} loop.  If your Octave
+session has a parallel processing pool enabled, the iterations of the
+@code{parfor} loop will be executed in parallel across the pool's workers.
+Otherwise, @code{parfor} will behave exactly as @code{for}.
+
+When operating in parallel mode, a @code{parfor} loop's iterations are not
+guaranteed to occur sequentially, and there are additional restrictions about
+the data access operations you can do inside the loop body.
+
+@strong{Warning:} parallel processing pools are currently unimplemented in
+Octave; @code{parfor} currently behaves exactly as a normal @code{for} loop.
+
 @example
 @group
 parfor i = 1:10