From d8437c9a95c1537d27c4ebff750e783edb0a1f97 Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Sun, 29 Mar 2020 00:06:28 -0700 Subject: [PATCH] Mention that ThreadsX.jl API is deterministic --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 52104a9c..d08bebe8 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,13 @@ when the time to process single item varies a lot from item to item. The default value of `basesize` for each function is currently an implementation detail. +ThreadsX.jl API is deterministic in the sense that the same input +produces the same output, independent of how `julia`'s task scheduler +decide to execute the tasks. However, note that `basesize` is a part +of the input which may be set based on `Threads.nthreads()`. To make +the result of the computation independent of `Threads.nthreads()` +value, `basesize` must be specified explicitly. + ## Limitations * Keyword argument `dims` is not supported yet.