diff options
author | MSeifert04 <michaelseifert04@yahoo.de> | 2019-09-22 15:52:48 +0200 |
---|---|---|
committer | MSeifert04 <michaelseifert04@yahoo.de> | 2019-09-22 15:56:05 +0200 |
commit | c25cce56f3a9fd8b232304abf583f9552dc9331b (patch) | |
tree | afaef1e851b42e47985fe0bd976adeeb741c3dd4 /doc/source/reference/c-api | |
parent | 2d1bc73d667ae6ac425cfd05a85d3727b0570115 (diff) | |
download | numpy-c25cce56f3a9fd8b232304abf583f9552dc9331b.tar.gz |
DOC: Document the NPY_SCALARKIND values as C variables.
Currently the ":c:data:" links could not resolve these because the
values were not explicitly documented.
Diffstat (limited to 'doc/source/reference/c-api')
-rw-r--r-- | doc/source/reference/c-api/array.rst | 23 |
1 files changed, 15 insertions, 8 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index 4dd556e97..08bf06b00 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -2797,10 +2797,7 @@ Array Scalars *arr* is not ``NULL`` and the first element is negative then :c:data:`NPY_INTNEG_SCALAR` is returned, otherwise :c:data:`NPY_INTPOS_SCALAR` is returned. The possible return values - are :c:data:`NPY_{kind}_SCALAR` where ``{kind}`` can be **INTPOS**, - **INTNEG**, **FLOAT**, **COMPLEX**, **BOOL**, or **OBJECT**. - :c:data:`NPY_NOSCALAR` is also an enumerated value - :c:type:`NPY_SCALARKIND` variables can take on. + are the enumerated values in :c:type:`NPY_SCALARKIND`. .. c:function:: int PyArray_CanCoerceScalar( \ char thistype, char neededtype, NPY_SCALARKIND scalar) @@ -3596,11 +3593,21 @@ Enumerated Types A special variable type indicating the number of "kinds" of scalars distinguished in determining scalar-coercion rules. This - variable can take on the values :c:data:`NPY_{KIND}` where ``{KIND}`` can be + variable can take on the values: - **NOSCALAR**, **BOOL_SCALAR**, **INTPOS_SCALAR**, - **INTNEG_SCALAR**, **FLOAT_SCALAR**, **COMPLEX_SCALAR**, - **OBJECT_SCALAR** + .. c:var:: NPY_NOSCALAR + + .. c:var:: NPY_BOOL_SCALAR + + .. c:var:: NPY_INTPOS_SCALAR + + .. c:var:: NPY_INTNEG_SCALAR + + .. c:var:: NPY_FLOAT_SCALAR + + .. c:var:: NPY_COMPLEX_SCALAR + + .. c:var:: NPY_OBJECT_SCALAR .. c:var:: NPY_NSCALARKINDS |