diff options
| author | jaimefrio <jaime.frio@gmail.com> | 2014-09-25 00:21:20 -0700 |
|---|---|---|
| committer | jaimefrio <jaime.frio@gmail.com> | 2014-09-25 00:21:54 -0700 |
| commit | 75c1ed846b0a6de02bba61837e6335f69728c0c6 (patch) | |
| tree | 5d766dd3139650f786c8feb20682081ccf697f16 /doc/source/reference/c-api.array.rst | |
| parent | f4fa7bd2a67a577eaa72af83028adcfbc71b7fd4 (diff) | |
| download | numpy-75c1ed846b0a6de02bba61837e6335f69728c0c6.tar.gz | |
DOC: document NPY_BEGIN_THREADS_THRESHOLDED
Diffstat (limited to 'doc/source/reference/c-api.array.rst')
| -rw-r--r-- | doc/source/reference/c-api.array.rst | 6 |
1 files changed, 6 insertions, 0 deletions
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 """"""" |