cpython: c59b2c4f4cac (original) (raw)

Mercurial > cpython

changeset 97328:c59b2c4f4cac

Stefan Krah skrah@bytereef.org
date	Sat, 08 Aug 2015 14:34:17 +0200
parents	c7c4b8411037(current diff)d1ef54751412(diff)
children	3eb4f96a3b30
files
diffstat	4 files changed, 30 insertions(+), 13 deletions(-)[+] [-] Doc/c-api/buffer.rst 15 Doc/c-api/memoryview.rst 2 Doc/glossary.rst 18 Doc/library/stdtypes.rst 8

line wrap: on

line diff

--- a/Doc/c-api/buffer.rst +++ b/Doc/c-api/buffer.rst @@ -96,8 +96,8 @@ a buffer, see :c:func:PyObject_GetBuffe[](#l1.3) block of the exporter. For example, with negative :c:member:~Py_buffer.strides` the value may point to the end of the memory block.

 For contiguous arrays, the value points to the beginning of the memory[](#l1.7)

```
 block.[](#l1.8)
```

 For :term:`contiguous` arrays, the value points to the beginning of[](#l1.9)

```
 the memory block.[](#l1.10)
```

.. c:member:: void *obj @@ -281,11 +281,14 @@ of the flags below it. +-----------------------------+-------+---------+------------+ +.. index:: contiguous, C-contiguous, Fortran contiguous + contiguity requests

~~~~~~~~~~~~~~~~~~~ -C or Fortran contiguity can be explicitly requested, with and without stride -information. Without stride information, the buffer must be C-contiguous. +C or Fortran :term:contiguity <contiguous> can be explicitly requested, +with and without stride information. Without stride information, the buffer +must be C-contiguous. .. tabularcolumns:: |p{0.35\linewidth}|l|l|l|l| @@ -466,13 +469,13 @@ Buffer-related functions .. c:function:: int PyBuffer_IsContiguous(Py_buffer *view, char order) Return 1 if the memory defined by the view is C-style (order is

'C') or Fortran-style (order is 'F') contiguous or either one

'C') or Fortran-style (order is 'F') :term:contiguous or either one (order is 'A'). Return 0 otherwise.

.. c:function:: void PyBuffer_FillContiguousStrides(int ndim, Py_ssize_t *shape, Py_ssize_t *strides, Py_ssize_t itemsize, char order)

Fill the strides array with byte-strides of a contiguous (C-style if

Fill the strides array with byte-strides of a :term:contiguous (C-style if order is 'C' or Fortran-style if order is 'F') array of the given shape with the given number of bytes per element.

--- a/Doc/c-api/memoryview.rst +++ b/Doc/c-api/memoryview.rst @@ -35,7 +35,7 @@ any other object. .. c:function:: PyObject *PyMemoryView_GetContiguous(PyObject *obj, int buffertype, char order)

Create a memoryview object to a contiguous chunk of memory (in either

Create a memoryview object to a :term:contiguous chunk of memory (in either 'C' or 'F'ortran order) from an object that defines the buffer interface. If memory is contiguous, the memoryview object points to the original memory. Otherwise, a copy is made and the memoryview points to a

--- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -109,8 +109,10 @@ Glossary A :term:text file reads and writes :class:str objects. bytes-like object

 An object that supports the :ref:`bufferobjects`, like :class:`bytes`,[](#l3.7)

 :class:`bytearray` or :class:`memoryview`.  Bytes-like objects can[](#l3.8)

 An object that supports the :ref:`bufferobjects` and can[](#l3.9)

 export a C-:term:`contiguous` buffer. This includes all :class:`bytes`,[](#l3.10)

 :class:`bytearray`, and :class:`array.array` objects, as well as many[](#l3.11)

 common :class:`memoryview` objects.  Bytes-like objects can[](#l3.12)
 be used for various operations that work with binary data; these include[](#l3.13)
 compression, saving to a binary file, and sending over a socket.[](#l3.14)

@@ -169,6 +171,18 @@ Glossary statement by defining :meth:__enter__ and :meth:__exit__ methods. See :pep:343.

contiguous

 .. index:: C-contiguous, Fortran contiguous[](#l3.21)

 A buffer is considered contiguous exactly if it is either[](#l3.23)

 *C-contiguous* or *Fortran contiguous*.  Zero-dimensional buffers are[](#l3.24)

 C and Fortran contiguous.  In one-dimensional arrays, the items[](#l3.25)

 must be layed out in memory next to each other, in order of[](#l3.26)

 increasing indexes starting from zero.  In multidimensional[](#l3.27)

 C-contiguous arrays, the last index varies the fastest when[](#l3.28)

 visiting items in order of memory address.  However, in[](#l3.29)

 Fortran contiguous arrays, the first index varies the fastest.[](#l3.30)

+ coroutine Coroutines is a more generalized form of subroutines. Subroutines are entered at one point and exited at another point. Coroutines can be

--- a/Doc/library/stdtypes.rst +++ b/Doc/library/stdtypes.rst @@ -3561,7 +3561,7 @@ copying. Cast a memoryview to a new format or shape. shape defaults to [byte_length//new_itemsize], which means that the result view will be one-dimensional. The return value is a new memoryview, but

 the buffer itself is not copied. Supported casts are 1D -> C-contiguous[](#l4.7)

 the buffer itself is not copied. Supported casts are 1D -> C-:term:`contiguous`[](#l4.8)
 and C-contiguous -> 1D.[](#l4.9)

The destination format is restricted to a single element native format in @@ -3752,19 +3752,19 @@ copying. .. attribute:: c_contiguous

 A bool indicating whether the memory is C-contiguous.[](#l4.16)

 A bool indicating whether the memory is C-:term:`contiguous`.[](#l4.17)

.. versionadded:: 3.3 .. attribute:: f_contiguous

 A bool indicating whether the memory is Fortran contiguous.[](#l4.23)

 A bool indicating whether the memory is Fortran :term:`contiguous`.[](#l4.24)

.. versionadded:: 3.3 .. attribute:: contiguous

 A bool indicating whether the memory is contiguous.[](#l4.30)

 A bool indicating whether the memory is :term:`contiguous`.[](#l4.31)

.. versionadded:: 3.3