diff options
| author | vrindaaa <48102157+vrindaaa@users.noreply.github.com> | 2019-04-03 21:36:50 +0530 |
|---|---|---|
| committer | Matti Picus <matti.picus@gmail.com> | 2019-04-03 19:06:50 +0300 |
| commit | c1bf6a600cb4c8c7261a000f47b11ef8fd9f792d (patch) | |
| tree | 82bb9bcefd8fbeff814bf38311b5dfd3fda0ffde /doc | |
| parent | 9eb9c35766fadb0fa3267fb8e16e0d5135d33a17 (diff) | |
| download | numpy-c1bf6a600cb4c8c7261a000f47b11ef8fd9f792d.tar.gz | |
DOC : PyArray_Descr.names undocumented (#13234)
* Updating the definition of PyArray_Descr struct
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/reference/c-api.types-and-structures.rst | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/doc/source/reference/c-api.types-and-structures.rst b/doc/source/reference/c-api.types-and-structures.rst index f04d65ee1..f411ebc44 100644 --- a/doc/source/reference/c-api.types-and-structures.rst +++ b/doc/source/reference/c-api.types-and-structures.rst @@ -203,14 +203,17 @@ PyArrayDescr_Type char kind; char type; char byteorder; - char unused; - int flags; + char flags; int type_num; int elsize; int alignment; PyArray_ArrayDescr *subarray; PyObject *fields; + PyObject *names; PyArray_ArrFuncs *f; + PyObject *metadata; + NpyAuxData *c_metadata; + npy_hash_t hash; } PyArray_Descr; .. c:member:: PyTypeObject *PyArray_Descr.typeobj @@ -242,7 +245,7 @@ PyArrayDescr_Type endian), '=' (native), '\|' (irrelevant, ignore). All builtin data- types have byteorder '='. -.. c:member:: int PyArray_Descr.flags +.. c:member:: char PyArray_Descr.flags A data-type bit-flag that determines if the data-type exhibits object- array like behavior. Each bit in this member is a flag which are named @@ -377,6 +380,11 @@ PyArrayDescr_Type normally a Python string. These tuples are placed in this dictionary keyed by name (and also title if given). +.. c:member:: PyObject *PyArray_Descr.names + + An ordered tuple of field names. It is NULL if no field is + defined. + .. c:member:: PyArray_ArrFuncs *PyArray_Descr.f A pointer to a structure containing functions that the type needs @@ -384,6 +392,20 @@ PyArrayDescr_Type thing as the universal functions (ufuncs) described later. Their signatures can vary arbitrarily. +.. c:member:: PyObject *PyArray_Descr.metadata + + Metadata about this dtype. + +.. c:member:: NpyAuxData *PyArray_Descr.c_metadata + + Metadata specific to the C implementation + of the particular dtype. Added for NumPy 1.7.0. + +.. c:member:: Npy_hash_t *PyArray_Descr.hash + + Currently unused. Reserved for future use in caching + hash values. + .. c:type:: PyArray_ArrFuncs Functions implementing internal features. Not all of these |