8000 DOC, API: improve the C-API/Cython documentation and interfaces for random by mattip · Pull Request #15007 · numpy/numpy · GitHub
[go: up one dir, main page]
Skip to content

DOC, API: improve the C-API/Cython documentation and interfaces for random #15007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 3, 2019
Merged

DOC, API: improve the C-API/Cython documentation and interfaces for random #15007

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
16e8059
DOC: improve the C-API/Cython documentation for random
mattip Nov 29, 2019
bcd950f
DOC, TST: refactor CFFI test, add file names to documentation
mattip Nov 29, 2019
a2acfa6
API: rename functions in distributions.c,h
mattip Nov 29, 2019
aeaee5e
DOC: sphinx does not like breaking function declarations over lines
mattip Nov 29, 2019
2b791a5
API: revert changes to standard_t, cauchy
mattip Nov 30, 2019
b2f2700
DOC: fixes from review
mattip Dec 3, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
DOC: fixes from review
  • Loading branch information
@mattip
mattip committed Dec 3, 2019
commit b2f2700469dbda3c791fb6a3a1dad1f95c4f7a8a
16 changes: 7 additions & 9 deletions doc/source/reference/random/c-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ like CFFI. All the functions accept a :c:type:`bitgen_t` as their first argument

See :doc:`extending` for examples of using these functions.

The functions are named with the following cconventions:
The functions are named with the following conventions:

- "standard" refers to the reference values for any parameters. For instance
"standard_uniform" means a uniform distribution on the interval ``0.0`` to
Expand Down Expand Up @@ -98,13 +98,14 @@ The functions are named with the following cconventions:
.. c:function:: double random_exponential(bitgen_t *bitgen_state, double scale)

.. c:function:: double random_uniform(bitgen_t *bitgen_state, double lower, double range)

.. c:function:: double random_beta(bitgen_t *bitgen_state, double a, double b)

.. c:function:: double random_chisquare(bitgen_t *bitgen_state, double df)

.. c:function:: double random_f(bitgen_t *bitgen_state, double dfnum, double dfden)

.. c:function:: double random_cauchy(bitgen_t *bitgen_state)
.. c:function:: double random_standard_cauchy(bitgen_t *bitgen_state)

.. c:function:: double random_pareto(bitgen_t *bitgen_state, double a)

Expand All @@ -122,18 +123,15 @@ The functions are named with the following cconventions:

.. c:function:: double random_rayleigh(bitgen_t *bitgen_state, double mode)

.. c:function:: double random_student_t(bitgen_t *bitgen_state, double df)
.. c:function:: double random_standard_t(bitgen_t *bitgen_state, double df)

.. c:function:: double random_noncentral_chisquare(bitgen_t *bitgen_state, double df,
double nonc)
.. c:function:: double random_noncentral_f(bitgen_t *bitgen_state, double dfnum,
double dfden, double nonc)
.. c:function:: double random_noncentral_chisquare(bitgen_t *bitgen_state, double df, double nonc)
.. c:function:: double random_noncentral_f(bitgen_t *bitgen_state, double dfnum, double dfden, double nonc)
.. c:function:: double random_wald(bitgen_t *bitgen_state, double mean, double scale)

.. c:function:: double random_vonmises(bitgen_t *bitgen_state, double mu, double kappa)

.. c:function:: double random_triangular(bitgen_t *bitgen_state, double left, double mode,
double right)
.. c:function:: double random_triangular(bitgen_t *bitgen_state, double left, double mode, double right)

.. c:function:: npy_int64 random_poisson(bitgen_t *bitgen_state, double lam)

Expand Down
2 changes: 0 additions & 2 deletions doc/source/reference/random/examples/cffi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Extending via CFFI
------------------

The source of ``numpy/random/_examples/cffi/extending.py``

.. literalinclude:: ../../../../../numpy/random/_examples/cffi/extending.py
:language: python
2 changes: 0 additions & 2 deletions doc/source/reference/random/examples/numba.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Extending via Numba
-------------------

The source of ``numpy/random/_examples/numba/extending.py``

.. literalinclude:: ../../../../../numpy/random/_examples/numba/extending.py
:language: python
2 changes: 0 additions & 2 deletions doc/source/reference/random/examples/numba_cffi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
Extending via Numba and CFFI
----------------------------

The source of ``numpy/random/_examples/numba/extending_distributions.py``

.. literalinclude:: ../../../../../numpy/random/_examples/numba/extending_distributions.py
:language: python
0