djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc updates

Browse Source
This commit is contained in:
Jeff Epler 2020-04-13 20:10:02 -05:00
parent db01f88cc3
commit 693928d201
1 changed files with 23 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
shared-bindings/ulab/__init__.rst
View File

@ -79,26 +79,30 @@ ulab.array -- 1- and 2- dimensional array
.. method:: __add__()
Adds corresponding elements of the two arrays, or adds a number to all
elements of the array. A number must be on the right hand side. If
both arguments are arrays, their sizes must match.
elements of the array. If both arguments are arrays, their sizes must match.
.. method:: __sub__()
Subtracts corresponding elements of the two arrays, or subtracts a
number from all elements of the array. A number must be on the right
hand side. If both arguments are arrays, their sizes must match.
Subtracts corresponding elements of the two arrays, or adds a number to all
elements of the array. If both arguments are arrays, their sizes must match.
.. method:: __mul__()
Multiplies corresponding elements of the two arrays, or multiplies
all elements of the array by a number. A number must be on the right
hand side. If both arguments are arrays, their sizes must match.
all elements of the array by a number. If both arguments are arrays,
their sizes must match.
.. method:: __div__()
Multiplies corresponding elements of the two arrays, or divides
all elements of the array by a number. A number must be on the right
hand side. If both arguments are arrays, their sizes must match.
all elements of the array by a number. If both arguments are arrays,
their sizes must match.
.. method:: __pow__()
Computes the power (x**y) of corresponding elements of the the two arrays,
or one number and one array. If both arguments are arrays, their sizes
must match.
.. method:: __getitem__()
@ -348,6 +352,12 @@ much more efficient than expressing the same operation as a Python loop.
Return the total number of elements in the array, as an integer.
.. method:: trace(m)
:param m: a square matrix
Compute the trace of the matrix, the sum of its diagonal elements.
:mod:`ulab.filter` --- Filtering functions
==========================================
@ -404,11 +414,11 @@ operate over the flattened array (None), rows (0), or columns (1).
.. method:: argmax(array, \*, axis=None)
Return the index of the maximum element of the 1D array, as an array with 1 element
Return the index of the maximum element of the 1D array
.. method:: argmin(array, \*, axis=None)
Return the index of the minimum element of the 1D array, as an array with 1 element
Return the index of the minimum element of the 1D array
.. method:: argsort(array, \*, axis=None)
@ -426,7 +436,7 @@ operate over the flattened array (None), rows (0), or columns (1).
.. method:: max(array, \*, axis=None)
Return the maximum element of the 1D array, as an array with 1 element
Return the maximum element of the 1D array
.. method:: mean(array, \*, axis=None)
@ -434,7 +444,7 @@ operate over the flattened array (None), rows (0), or columns (1).
.. method:: min(array, \*, axis=None)
Return the minimum element of the 1D array, as an array with 1 element
Return the minimum element of the 1D array
.. method:: roll(array, distance, \*, axis=None)