From 75c1ed846b0a6de02bba61837e6335f69728c0c6 Mon Sep 17 00:00:00 2001 From: jaimefrio Date: Thu, 25 Sep 2014 00:21:20 -0700 Subject: DOC: document NPY_BEGIN_THREADS_THRESHOLDED --- doc/source/reference/c-api.array.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'doc/source/reference/c-api.array.rst') diff --git a/doc/source/reference/c-api.array.rst b/doc/source/reference/c-api.array.rst index 7c8d7d5d0..e3723c46f 100644 --- a/doc/source/reference/c-api.array.rst +++ b/doc/source/reference/c-api.array.rst @@ -3113,6 +3113,12 @@ Group 1 Useful to regain the GIL in situations where it was released using the BEGIN form of this macro. + .. cfunction:: NPY_BEGIN_THREADS_THRESHOLDED(int loop_size) + + Useful to release the GIL only if *loop_size* exceeds a + minimum threshold, currently set to 500. Should be matched + with a .. cmacro::`NPY_END_THREADS` to regain the GIL. + Group 2 """"""" -- cgit v1.2.1