diff options
author | Stefan van der Walt <stefan@sun.ac.za> | 2007-12-03 07:15:55 +0000 |
---|---|---|
committer | Stefan van der Walt <stefan@sun.ac.za> | 2007-12-03 07:15:55 +0000 |
commit | ec6e9424d0c194323faeb43a2197daf73ecf1415 (patch) | |
tree | f17998da0a869aa0074a9a9fa46409636c9336a3 /numpy/add_newdocs.py | |
parent | 0f4730e74c87e50c6ccc5b072ea733d9a3fe96f4 (diff) | |
download | numpy-ec6e9424d0c194323faeb43a2197daf73ecf1415.tar.gz |
Increase test code coverage. Add documentation.
Diffstat (limited to 'numpy/add_newdocs.py')
-rw-r--r-- | numpy/add_newdocs.py | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 2acef6b69..ce4b43107 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -379,25 +379,35 @@ add_newdoc('numpy.core.multiarray','lexsort', sort order, and so on). The keys argument must be a sequence of things that can be converted to arrays of the same shape. - Parameters: + *Parameters*: - a : array type + keys : (k,N) array or tuple of (N,) sequences Array containing values that the returned indices should sort. axis : integer - Axis to be indirectly sorted. None indicates that the flattened - array should be used. Default is -1. + Axis to be indirectly sorted. Default is -1 (i.e. last axis). - Returns: + *Returns*: - indices : integer array - Array of indices that sort the keys along the specified axis. The - array has the same shape as the keys. + indices : (N,) integer array + Array of indices that sort the keys along the specified axis. - SeeAlso: + *See Also*: + + `argsort` : indirect sort + `sort` : inplace sort + + *Examples* - argsort : indirect sort - sort : inplace sort + >>> a = [1,5,1,4,3,6,7] + >>> b = [9,4,0,4,0,4,3] + >>> ind = lexsort((b,a)) + >>> print ind + [2 0 4 3 1 5 6] + >>> print take(a,ind) + [1 1 3 4 5 6 7] + >>> print take(b,ind) + [0 9 0 4 4 4 3] """) |