summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorJeff Epler <jepler@unpythonic.net>2020-02-27 14:14:05 -0600
committerJeff Epler <jepler@unpythonic.net>2020-02-27 14:14:05 -0600
commit39cfe32c345781b32d235353c2e59acacbc32dc6 (patch)
tree3c44adc3912bee347dd620febd13e7c1547fc4aa /shared-bindings
parent645df931ae64e775dfb9641e3d96e3a6d5779d3d (diff)
Update ulab from upstream again
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/ulab/__init__.rst63
1 files changed, 27 insertions, 36 deletions
diff --git a/shared-bindings/ulab/__init__.rst b/shared-bindings/ulab/__init__.rst
index 7e30f2a10..b2933be79 100644
--- a/shared-bindings/ulab/__init__.rst
+++ b/shared-bindings/ulab/__init__.rst
@@ -129,8 +129,6 @@ Array type codes
Basic Array defining functions
------------------------------
-See also `ulab.linalg.eye` and `ulab.numerical.linspace` for other useful
-array defining functions.
.. method:: ones(shape, \*, dtype=float)
@@ -158,6 +156,33 @@ array defining functions.
Return a new square array of size, with the diagonal elements set to 1
and the other elements set to 0.
+.. method:: linspace(start, stop, \*, dtype=float, num=50, endpoint=True)
+
+ .. param: start
+
+ First value in the array
+
+ .. param: stop
+
+ Final value in the array
+
+ .. param int: num
+
+ Count of values in the array
+
+ .. param: dtype
+
+ Type of values in the array
+
+ .. param bool: endpoint
+
+ Whether the ``stop`` value is included. Note that even when
+ endpoint=True, the exact ``stop`` value may not be included due to the
+ inaccuracy of floating point arithmetic.
+
+ Return a new 1-D array with ``num`` elements ranging from ``start`` to ``stop`` linearly.
+
+
:mod:`ulab.vector` --- Element-by-element functions
===================================================
@@ -288,14 +313,6 @@ much more efficient than expressing the same operation as a Python loop.
Computes the eigenvalues and eigenvectors of a square matrix
-
-.. method:: eye(size, \*, dtype=float)
-
- :param int: size - The number of rows and columns in the matrix
-
- Returns a square matrix with all the diagonal elements set to 1 and all
- other elements set to 0
-
.. method:: inv(m)
:param ~ulab.array m: a square matrix
@@ -387,32 +404,6 @@ operate over the flattened array (None), rows (0), or columns (1).
Returns a new array that reverses the order of the elements along the
given axis, or along all axes if axis is None.
-.. method:: linspace(start, stop, \*, dtype=float, num=50, endpoint=True)
-
- .. param: start
-
- First value in the array
-
- .. param: stop
-
- Final value in the array
-
- .. param int: num
-
- Count of values in the array
-
- .. param: dtype
-
- Type of values in the array
-
- .. param bool: endpoint
-
- Whether the ``stop`` value is included. Note that even when
- endpoint=True, the exact ``stop`` value may not be included due to the
- inaccuracy of floating point arithmetic.
-
- Return a new 1-D array with ``num`` elements ranging from ``start`` to ``stop`` linearly.
-
.. method:: max(array, \*, axis=None)
Return the maximum element of the 1D array, as an array with 1 element