diff options
author | Matti Picus <matti.picus@gmail.com> | 2020-07-02 23:12:15 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-07-02 13:12:15 -0700 |
commit | 942add94ed3bbe479c2e6f5ca8e2a8a6d4ca4831 (patch) | |
tree | 3f04d89ffbac45a7167ee4cea10b9e10ffc84c9c | |
parent | a87ee593c3f5da5dcb42a8033ecbab0f0c9b7903 (diff) | |
download | numpy-942add94ed3bbe479c2e6f5ca8e2a8a6d4ca4831.tar.gz |
DOC: reword random c-api introduction, cython is documented in Extending (#16731)
DOC: reword random c-api introduction, cython is documented in Extending
-rw-r--r-- | doc/source/reference/random/c-api.rst | 20 |
1 files changed, 7 insertions, 13 deletions
diff --git a/doc/source/reference/random/c-api.rst b/doc/source/reference/random/c-api.rst index 0d60f4d9e..63b0fdc2b 100644 --- a/doc/source/reference/random/c-api.rst +++ b/doc/source/reference/random/c-api.rst @@ -1,20 +1,14 @@ -Cython API for random ---------------------- +C API for random +---------------- .. currentmodule:: numpy.random -Typed versions of many of the `Generator` and `BitGenerator` methods as well as -the classes themselves can be accessed directly from Cython via - -.. code-block:: cython - - cimport numpy.random - -C API for random ----------------- +Access to various distributions below is available via Cython or C-wrapper +libraries like CFFI. All the functions accept a :c:type:`bitgen_t` as their +first argument. To access these from Cython or C, you must link with the +``npyrandom`` library which is part of the NumPy distribution, located in +``numpy/random/lib``. -Access to various distributions is available via Cython or C-wrapper libraries -like CFFI. All the functions accept a :c:type:`bitgen_t` as their first argument. .. c:type:: bitgen_t |