Skip to content

Commit 0cb3431

Browse files
authored
Merge pull request #2802 from jepler/update-ulab
ulab: Update from upstream
2 parents 51dbe91 + b87af3b commit 0cb3431

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

shared-bindings/ulab/__init__.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,38 @@ Basic Array defining functions
191191
Return a new 1-D array with ``num`` elements ranging from ``start`` to ``stop`` linearly.
192192

193193

194+
:mod:`ulab.compare` --- Comparison functions
195+
============================================
196+
197+
.. module::ulab.compare
198+
199+
.. method:: clip(x1, x2, x3)
200+
201+
Constrain the values from ``x1`` to be between ``x2`` and ``x3``.
202+
``x2`` is assumed to be less than or equal to ``x3``.
203+
204+
Arguments may be ulab arrays or numbers. All array arguments
205+
must be the same size. If the inputs are all scalars, a 1-element
206+
array is returned.
207+
208+
Shorthand for ``ulab.maximum(x2, ulab.minimum(x1, x3))``
209+
210+
.. method:: maximum(x1, x2)
211+
212+
Compute the element by element maximum of the arguments.
213+
214+
Arguments may be ulab arrays or numbers. All array arguments
215+
must be the same size. If the inputs are both scalars, a number is
216+
returned
217+
218+
.. method:: minimum(x1, x2)
219+
220+
Compute the element by element minimum of the arguments.
221+
222+
Arguments may be ulab arrays or numbers. All array arguments
223+
must be the same size. If the inputs are both scalars, a number is
224+
returned
225+
194226

195227
:mod:`ulab.vector` --- Element-by-element functions
196228
===================================================

0 commit comments

Comments
 (0)