diff options
| author | Mark Wiebe <mwwiebe@gmail.com> | 2011-07-11 13:57:43 -0500 |
|---|---|---|
| committer | Mark Wiebe <mwwiebe@gmail.com> | 2011-07-11 13:57:43 -0500 |
| commit | 2ad4a7138ac6500649ac501ea8314be439c0ede9 (patch) | |
| tree | 87e18046f0906a87935b551343dc6c9fe7a7c835 /numpy | |
| parent | 92ede9cc86fe112d0e9335a1fe94dc66cc5ad6ca (diff) | |
| download | numpy-2ad4a7138ac6500649ac501ea8314be439c0ede9.tar.gz | |
DOC: core: Improve some documentation of internal functions
Diffstat (limited to 'numpy')
| -rw-r--r-- | numpy/core/src/multiarray/lowlevel_strided_loops.c.src | 3 | ||||
| -rw-r--r-- | numpy/core/src/private/lowlevel_strided_loops.h | 10 |
2 files changed, 8 insertions, 5 deletions
diff --git a/numpy/core/src/multiarray/lowlevel_strided_loops.c.src b/numpy/core/src/multiarray/lowlevel_strided_loops.c.src index f33e39861..4476e0a35 100644 --- a/numpy/core/src/multiarray/lowlevel_strided_loops.c.src +++ b/numpy/core/src/multiarray/lowlevel_strided_loops.c.src @@ -921,6 +921,7 @@ PyArray_GetStridedNumericCastFn(int aligned, npy_intp src_stride, /****************** PRIMITIVE FLAT TO/FROM NDIM FUNCTIONS ******************/ +/* See documentation of arguments in lowlevel_strided_loops.h */ NPY_NO_EXPORT npy_intp PyArray_TransferNDimToStrided(npy_intp ndim, char *dst, npy_intp dst_stride, @@ -1039,6 +1040,7 @@ PyArray_TransferNDimToStrided(npy_intp ndim, } } +/* See documentation of arguments in lowlevel_strided_loops.h */ NPY_NO_EXPORT npy_intp PyArray_TransferStridedToNDim(npy_intp ndim, char *dst, npy_intp *dst_strides, npy_intp dst_strides_inc, @@ -1157,6 +1159,7 @@ PyArray_TransferStridedToNDim(npy_intp ndim, } } +/* See documentation of arguments in lowlevel_strided_loops.h */ NPY_NO_EXPORT npy_intp PyArray_TransferMaskedStridedToNDim(npy_intp ndim, char *dst, npy_intp *dst_strides, npy_intp dst_strides_inc, diff --git a/numpy/core/src/private/lowlevel_strided_loops.h b/numpy/core/src/private/lowlevel_strided_loops.h index 088b15040..b5b8159e6 100644 --- a/numpy/core/src/private/lowlevel_strided_loops.h +++ b/numpy/core/src/private/lowlevel_strided_loops.h @@ -228,6 +228,7 @@ PyArray_CastRawArrays(npy_intp count, npy_intp src_stride, npy_intp dst_stride, PyArray_Descr *src_dtype, PyArray_Descr *dst_dtype, int move_references); + /* * These two functions copy or convert the data of an n-dimensional array * to/from a 1-dimensional strided buffer. These functions will only call @@ -241,9 +242,9 @@ PyArray_CastRawArrays(npy_intp count, * * ndim: * The number of dimensions of the n-dimensional array. - * dst/src: - * The destination or src starting pointer. - * dst_stride/src_stride: + * dst/src/mask: + * The destination, source or mask starting pointer. + * dst_stride/src_stride/mask_stride: * The stride of the 1-dimensional strided buffer * dst_strides/src_strides: * The strides of the n-dimensional array. @@ -268,8 +269,7 @@ PyArray_CastRawArrays(npy_intp count, * The strided transfer function. * transferdata: * An auxiliary data pointer passed to the strided transfer function. - * If a non-NULL value is returned, it must be deallocated with the - * function PyArray_FreeStridedTransferData. + * This follows the conventions of NpyAuxData objects. */ NPY_NO_EXPORT npy_intp PyArray_TransferNDimToStrided(npy_intp ndim, |