diff options
Diffstat (limited to 'doc/source/reference/c-api')
| -rw-r--r-- | doc/source/reference/c-api/array.rst | 60 | ||||
| -rw-r--r-- | doc/source/reference/c-api/dtype.rst | 16 |
2 files changed, 38 insertions, 38 deletions
diff --git a/doc/source/reference/c-api/array.rst b/doc/source/reference/c-api/array.rst index f22b41a85..f69c2bcb1 100644 --- a/doc/source/reference/c-api/array.rst +++ b/doc/source/reference/c-api/array.rst @@ -162,7 +162,7 @@ and its sub-types). Data access -^^^^^^^^^^^ +~~~~~~~~~~~ These functions and macros provide easy access to elements of the ndarray from C. These work for all arrays. You may need to take care @@ -208,7 +208,7 @@ Creating arrays From scratch -^^^^^^^^^^^^ +~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_NewFromDescr( \ PyTypeObject* subtype, PyArray_Descr* descr, int nd, npy_intp const* dims, \ @@ -404,7 +404,7 @@ From scratch to another value. From other objects -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_FromAny( \ PyObject* op, PyArray_Descr* dtype, int min_depth, int max_depth, \ @@ -805,7 +805,7 @@ Dealing with types General check of Python Type -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_Check(PyObject *op) @@ -877,7 +877,7 @@ General check of Python Type Data-type checking -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ For the typenum macros, the argument is an integer representing an enumerated array data type. For the array type checking macros the @@ -1048,7 +1048,7 @@ argument must be a :c:expr:`PyObject *` that can be directly interpreted as a Converting data types -^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_Cast(PyArrayObject* arr, int typenum) @@ -1268,7 +1268,7 @@ Converting data types User-defined data types -^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: void PyArray_InitArrFuncs(PyArray_ArrFuncs* f) @@ -1321,7 +1321,7 @@ User-defined data types Only works for user-defined data-types. Special functions for NPY_OBJECT -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_INCREF(PyArrayObject* op) @@ -1399,7 +1399,7 @@ PyArray_FromAny function. Basic Array Flags -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ An ndarray can have a data segment that is not a simple contiguous chunk of well-behaved memory you can manipulate. It may not be aligned @@ -1482,7 +1482,7 @@ for ``flags`` which can be any of :c:data:`NPY_ARRAY_C_CONTIGUOUS`, Combinations of array flags -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:macro:: NPY_ARRAY_BEHAVED @@ -1514,7 +1514,7 @@ Combinations of array flags Flag-like constants -^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~ These constants are used in :c:func:`PyArray_FromAny` (and its macro forms) to specify desired properties of the new array. @@ -1534,7 +1534,7 @@ specify desired properties of the new array. Flag checking -^^^^^^^^^^^^^ +~~~~~~~~~~~~~ For all of these macros *arr* must be an instance of a (subclass of) :c:data:`PyArray_Type`. @@ -1640,7 +1640,7 @@ Array method alternative API Conversion -^^^^^^^^^^ +~~~~~~~~~~ .. c:function:: PyObject* PyArray_GetField( \ PyArrayObject* self, PyArray_Descr* dtype, int offset) @@ -1749,7 +1749,7 @@ Conversion Shape Manipulation -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_Newshape( \ PyArrayObject* self, PyArray_Dims* newshape, NPY_ORDER order) @@ -1833,7 +1833,7 @@ Shape Manipulation Item selection and manipulation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. c:function:: PyObject* PyArray_TakeFrom( \ PyArrayObject* self, PyObject* indices, int axis, PyArrayObject* ret, \ @@ -2013,7 +2013,7 @@ Item selection and manipulation Calculation -^^^^^^^^^^^ +~~~~~~~~~~~ .. tip:: @@ -2173,7 +2173,7 @@ Functions Array Functions -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:function:: int PyArray_AsCArray( \ PyObject** op, void* ptr, npy_intp* dims, int nd, \ @@ -2324,7 +2324,7 @@ Array Functions Other functions -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:function:: npy_bool PyArray_CheckStrides( \ int elsize, int nd, npy_intp numbytes, npy_intp const* dims, \ @@ -2969,7 +2969,7 @@ Conversion Utilities For use with :c:func:`PyArg_ParseTuple` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All of these functions can be used in :c:func:`PyArg_ParseTuple` (...) with the "O&" format specifier to automatically convert any Python object @@ -3097,7 +3097,7 @@ to. to help functions allow a different clipmode for each dimension. Other conversions -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_PyIntAsInt(PyObject* op) @@ -3138,7 +3138,7 @@ Miscellaneous Importing the API -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ In order to make use of the C-API from another extension module, the :c:func:`import_array` function must be called. If the extension module is @@ -3209,7 +3209,7 @@ the C-API is needed then some additional steps must be taken. #defined to. Checking the API Version -^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~ Because python extensions are not used in the same way as usual libraries on most platforms, some errors cannot be automatically detected at build time or @@ -3264,7 +3264,7 @@ extension with the lowest :c:data:`NPY_FEATURE_VERSION` as possible. function is added). A changed value does not always require a recompile. Internal Flexibility -^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_SetNumericOps(PyObject* dict) @@ -3321,7 +3321,7 @@ Internal Flexibility Memory management -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ .. c:function:: char* PyDataMem_NEW(size_t nbytes) @@ -3368,7 +3368,7 @@ Memory management Returns 0 if nothing was done, -1 on error, and 1 if action was taken. Threading support -^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~ These macros are only meaningful if :c:data:`NPY_ALLOW_THREADS` evaluates True during compilation of the extension module. Otherwise, @@ -3475,7 +3475,7 @@ Group 2 Priority -^^^^^^^^ +~~~~~~~~ .. c:macro:: NPY_PRIORITY @@ -3498,7 +3498,7 @@ Priority Default buffers -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:macro:: NPY_BUFSIZE @@ -3514,7 +3514,7 @@ Default buffers Other constants -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ .. c:macro:: NPY_NUM_FLOATTYPE @@ -3548,7 +3548,7 @@ Other constants Miscellaneous Macros -^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~ .. c:function:: int PyArray_SAMESHAPE(PyArrayObject *a1, PyArrayObject *a2) @@ -3610,7 +3610,7 @@ Miscellaneous Macros Enumerated Types -^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~ .. c:enum:: NPY_SORTKIND diff --git a/doc/source/reference/c-api/dtype.rst b/doc/source/reference/c-api/dtype.rst index 382e45dc0..642f62749 100644 --- a/doc/source/reference/c-api/dtype.rst +++ b/doc/source/reference/c-api/dtype.rst @@ -219,7 +219,7 @@ Defines ------- Max and min values for integers -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ``NPY_MAX_INT{bits}``, ``NPY_MAX_UINT{bits}``, ``NPY_MIN_INT{bits}`` These are defined for ``{bits}`` = 8, 16, 32, 64, 128, and 256 and provide @@ -238,7 +238,7 @@ Max and min values for integers Number of bits in data types -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All ``NPY_SIZEOF_{CTYPE}`` constants have corresponding ``NPY_BITSOF_{CTYPE}`` constants defined. The ``NPY_BITSOF_{CTYPE}`` @@ -250,7 +250,7 @@ the available ``{CTYPE}s`` are Bit-width references to enumerated typenums -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All of the numeric data types (integer, floating point, and complex) have constants that are defined to be a specific enumerated type @@ -265,7 +265,7 @@ types are available. Integer that can hold a pointer -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The constants **NPY_INTP** and **NPY_UINTP** refer to an enumerated integer type that is large enough to hold a pointer on the @@ -283,7 +283,7 @@ types. Boolean -^^^^^^^ +~~~~~~~ .. c:type:: npy_bool @@ -292,7 +292,7 @@ Boolean (Un)Signed Integer -^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~ Unsigned versions of the integers can be defined by pre-pending a 'u' to the front of the integer name. @@ -373,7 +373,7 @@ to the front of the integer name. (Complex) Floating point -^^^^^^^^^^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~~~~~~~~~~ .. c:type:: npy_half @@ -408,7 +408,7 @@ that order). Bit-width names -^^^^^^^^^^^^^^^ +~~~~~~~~~~~~~~~ There are also typedefs for signed integers, unsigned integers, floating point, and complex floating point types of specific bit- |