diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2021-04-21 07:33:50 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-21 07:33:50 -0600 |
| commit | 59d476764e9739a9875022869e6f9f557c6e7936 (patch) | |
| tree | 33d17b86fafaeec814cbd9febf83654d94fb4ff2 /doc/source/reference | |
| parent | 9281027bfa90fd82b896dbe7745acfc532865a68 (diff) | |
| parent | 8f10be19469eefba16446172132f9f68389fd31c (diff) | |
| download | numpy-59d476764e9739a9875022869e6f9f557c6e7936.tar.gz | |
Merge pull request #18797 from zoj613/zig_doc
DOC: Update random c-api documentation
Diffstat (limited to 'doc/source/reference')
| -rw-r--r-- | doc/source/reference/random/c-api.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/source/reference/random/c-api.rst b/doc/source/reference/random/c-api.rst index a79da7a49..7c7996115 100644 --- a/doc/source/reference/random/c-api.rst +++ b/doc/source/reference/random/c-api.rst @@ -40,9 +40,9 @@ The functions are named with the following conventions: - The functions without "standard" in their name require additional parameters to describe the distributions. -- ``zig`` in the name are based on a ziggurat lookup algorithm is used instead - of calculating the ``log``, which is significantly faster. The non-ziggurat - variants are used in corner cases and for legacy compatibility. +- Functions with ``inv`` in their name are based on the slower inverse method + instead of a ziggurat lookup algorithm, which is significantly faster. The + non-ziggurat variants are used in corner cases and for legacy compatibility. .. c:function:: double random_standard_uniform(bitgen_t *bitgen_state) @@ -53,6 +53,8 @@ The functions are named with the following conventions: .. c:function:: void random_standard_exponential_fill(bitgen_t *bitgen_state, npy_intp cnt, double *out) +.. c:function:: void random_standard_exponential_inv_fill(bitgen_t *bitgen_state, npy_intp cnt, double *out) + .. c:function:: double random_standard_normal(bitgen_t* bitgen_state) .. c:function:: void random_standard_normal_fill(bitgen_t *bitgen_state, npy_intp count, double *out) @@ -69,6 +71,8 @@ The functions are named with the following conventions: .. c:function:: void random_standard_exponential_fill_f(bitgen_t *bitgen_state, npy_intp cnt, float *out) +.. c:function:: void random_standard_exponential_inv_fill_f(bitgen_t *bitgen_state, npy_intp cnt, float *out) + .. c:function:: float random_standard_normal_f(bitgen_t* bitgen_state) .. c:function:: float random_standard_gamma_f(bitgen_t *bitgen_state, float shape) |