parent
51dbe9109f
commit
b87af3b071
@ -191,6 +191,38 @@ Basic Array defining functions
|
||||
Return a new 1-D array with ``num`` elements ranging from ``start`` to ``stop`` linearly.
|
||||
|
||||
|
||||
:mod:`ulab.compare` --- Comparison functions
|
||||
============================================
|
||||
|
||||
.. module::ulab.compare
|
||||
|
||||
.. method:: clip(x1, x2, x3)
|
||||
|
||||
Constrain the values from ``x1`` to be between ``x2`` and ``x3``.
|
||||
``x2`` is assumed to be less than or equal to ``x3``.
|
||||
|
||||
Arguments may be ulab arrays or numbers. All array arguments
|
||||
must be the same size. If the inputs are all scalars, a 1-element
|
||||
array is returned.
|
||||
|
||||
Shorthand for ``ulab.maximum(x2, ulab.minimum(x1, x3))``
|
||||
|
||||
.. method:: maximum(x1, x2)
|
||||
|
||||
Compute the element by element maximum of the arguments.
|
||||
|
||||
Arguments may be ulab arrays or numbers. All array arguments
|
||||
must be the same size. If the inputs are both scalars, a number is
|
||||
returned
|
||||
|
||||
.. method:: minimum(x1, x2)
|
||||
|
||||
Compute the element by element minimum of the arguments.
|
||||
|
||||
Arguments may be ulab arrays or numbers. All array arguments
|
||||
must be the same size. If the inputs are both scalars, a number is
|
||||
returned
|
||||
|
||||
|
||||
:mod:`ulab.vector` --- Element-by-element functions
|
||||
===================================================
|
||||
|
Loading…
Reference in New Issue
Block a user