Some final cleanup for numpy tutorial
authorFrancesc Alted <faltet@gmail.com>
Sat, 2 Apr 2011 11:17:47 +0000 (13:17 +0200)
committerDag Sverre Seljebotn <dagss@student.matnat.uio.no>
Sat, 2 Apr 2011 15:37:30 +0000 (17:37 +0200)
docs/src/tutorial/index.rst
docs/src/tutorial/numpy.rst

index d7972a602d748f1ec8a53c21b1124bc4c373d098..3d1a6aa7fccc08dc2904d41752e438ff656b7fb2 100644 (file)
@@ -10,9 +10,9 @@ Tutorials
    pxd_files
    caveats
    profiling_tutorial
-   numpy
    strings
    pure
+   numpy
    readings
    related_work
    appendix
index ea05cf146bcba5ffcaf3f0e41af8502ea13f397b..fec107f9bf442a0faeac8cb0e726175ba6650c04 100644 (file)
@@ -1,14 +1,17 @@
-Using Cython with NumPy
+=======================
+Working with NumPy
 =======================
 
-Cython has support for fast access to NumPy arrays. Let's see how this
-works with a simple example.
+You can use NumPy from Cython exactly the same as in regular Python, but by
+doing so you are loosing potentially high speedups because Cython has support
+for fast access to NumPy arrays. Let's see how this works with a simple
+example.
 
 The code below does 2D discrete convolution of an image with a filter (and I'm
 sure you can do better!, let it serve for demonstration purposes). It is both
 valid Python and valid Cython code. I'll refer to it as both
-:file:`convolve_py.py` for the Python version and :file:`convolve1.pyx` for the
-Cython version -- Cython uses ".pyx" as its file suffix.
+:file:`convolve_py.py` for the Python version and :file:`convolve1.pyx` for
+the Cython version -- Cython uses ".pyx" as its file suffix.
 
 .. code-block:: python
 
@@ -94,7 +97,7 @@ Adding types
 =============
 
 To add types we use custom Cython syntax, so we are now breaking Python source
-compatibility. Here's :file:`convolve2.pyx`. *Read the comments!*  ::
+compatibility. Consider this code (*read the comments!*) ::
 
     from __future__ import division
     import numpy as np
@@ -187,9 +190,7 @@ We do this with a special "buffer" syntax which must be told the datatype
 (first argument) and number of dimensions ("ndim" keyword-only argument, if
 not provided then one-dimensional is assumed).
 
-More information on this syntax [:enhancements/buffer:can be found here].
-
-Showing the changes needed to produce :file:`convolve3.pyx` only::
+These are the needed changes::
 
     ...
     def naive_convolve(np.ndarray[DTYPE_t, ndim=2] f, np.ndarray[DTYPE_t, ndim=2] g):