summaryrefslogtreecommitdiff
path: root/numpy/add_newdocs.py
diff options
context:
space:
mode:
authorPauli Virtanen <pav@iki.fi>2009-10-02 19:27:46 +0000
committerPauli Virtanen <pav@iki.fi>2009-10-02 19:27:46 +0000
commit1521f6689a3cc48d60a75097a7ffcf4d51f9dc47 (patch)
treea0f048838717b7ee43177007ec42c3102ea7be25 /numpy/add_newdocs.py
parent8c7d1bc554e6b5bbb7900a2f6d976d72795bb454 (diff)
downloadnumpy-1521f6689a3cc48d60a75097a7ffcf4d51f9dc47.tar.gz
Docstring updates, part 1
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r--numpy/add_newdocs.py45
1 files changed, 42 insertions, 3 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py
index 86f8461e5..d63b99ee9 100644
--- a/numpy/add_newdocs.py
+++ b/numpy/add_newdocs.py
@@ -18,6 +18,45 @@ from lib import add_newdoc
add_newdoc('numpy.core', 'flatiter',
"""
+ Flat iterator object to iterate over arrays.
+
+ A `flatiter` iterator is returned by ``x.flat`` for any array `x`.
+ It allows iterating over the array as if it were a 1-D array,
+ either in a for-loop or by calling its `next` method.
+
+ Iteration is done in C-contiguous style, with the last index varying the
+ fastest. The iterator can also be indexed using basic slicing or
+ advanced indexing.
+
+ See Also
+ --------
+ ndarray.flat : Return a flat iterator over an array.
+ ndarray.flatten : Returns a flattened copy of an array.
+
+ Notes
+ -----
+ A `flatiter` iterator can not be constructed directly from Python code
+ by calling the `flatiter` constructor.
+
+ Examples
+ --------
+ >>> x = np.arange(6).reshape(2, 3)
+ >>> fl = x.flat
+ >>> type(fl)
+ <type 'numpy.flatiter'>
+ >>> for item in fl:
+ ... print item
+ ...
+ 0
+ 1
+ 2
+ 3
+ 4
+ 5
+
+ >>> fl[2:4]
+ array([2, 3])
+
""")
# flatiter attributes
@@ -228,11 +267,11 @@ add_newdoc('numpy.core.multiarray', 'empty',
"""
empty(shape, dtype=float, order='C')
- Return a new array of given shape and type, without initialising entries.
+ Return a new array of given shape and type, without initializing entries.
Parameters
----------
- shape : {tuple of int, int}
+ shape : int or tuple of int
Shape of the empty array
dtype : data-type, optional
Desired output data-type.
@@ -242,7 +281,7 @@ add_newdoc('numpy.core.multiarray', 'empty',
See Also
--------
- empty_like, zeros
+ empty_like, zeros, ones
Notes
-----