summaryrefslogtreecommitdiff
path: root/numpy/lib/twodim_base.py
diff options
context:
space:
mode:
authorRalf Gommers <ralf.gommers@googlemail.com>2012-03-03 21:20:13 +0100
committerRalf Gommers <ralf.gommers@googlemail.com>2012-03-03 22:34:02 +0100
commitf4dd54aa614b263950b7a57329eb0ab9a2f2eadf (patch)
treeef7178a9b7801f42c31290624faf76a1cf5b969c /numpy/lib/twodim_base.py
parent91f87e1f613630ff0ad9864017f059afcd6e57f1 (diff)
downloadnumpy-f4dd54aa614b263950b7a57329eb0ab9a2f2eadf.tar.gz
DOC: merge wiki doc edits.
Diffstat (limited to 'numpy/lib/twodim_base.py')
-rw-r--r--numpy/lib/twodim_base.py23
1 files changed, 14 insertions, 9 deletions
diff --git a/numpy/lib/twodim_base.py b/numpy/lib/twodim_base.py
index 6fb348275..58d8250a1 100644
--- a/numpy/lib/twodim_base.py
+++ b/numpy/lib/twodim_base.py
@@ -358,7 +358,7 @@ def tri(N, M=None, k=0, dtype=float):
Returns
-------
- T : ndarray of shape (N, M)
+ tri : ndarray of shape (N, M)
Array with its lower triangle filled with ones and zero elsewhere;
in other words ``T[i,j] == 1`` for ``i <= j + k``, 0 otherwise.
@@ -396,7 +396,7 @@ def tril(m, k=0):
Returns
-------
- L : ndarray, shape (M, N)
+ tril : ndarray, shape (M, N)
Lower triangle of `m`, of same shape and data-type as `m`.
See Also
@@ -790,9 +790,10 @@ def triu_indices(n, k=0):
Returns
-------
- inds : tuple of arrays
+ inds : tuple, shape(2) of ndarrays, shape(`n`)
The indices for the triangle. The returned tuple contains two arrays,
- each with the indices along one dimension of the array.
+ each with the indices along one dimension of the array. Can be used
+ to slice a ndarray of shape(`n`, `n`).
See also
--------
@@ -852,17 +853,21 @@ def triu_indices(n, k=0):
def triu_indices_from(arr, k=0):
"""
- Return the indices for the upper-triangle of an (n, n) array.
+ Return the indices for the upper-triangle of a (N, N) array.
See `triu_indices` for full details.
Parameters
----------
- arr : array_like
- The indices will be valid for square arrays whose dimensions are
- the same as arr.
+ arr : ndarray, shape(N, N)
+ The indices will be valid for square arrays.
k : int, optional
- Diagonal offset (see `triu` for details).
+ Diagonal offset (see `triu` for details).
+
+ Returns
+ -------
+ triu_indices_from : tuple, shape(2) of ndarray, shape(N)
+ Indices for the upper-triangle of `arr`.
See Also
--------