summaryrefslogtreecommitdiff
path: root/shared-bindings/ulab/compare/__init__.pyi
diff options
context:
space:
mode:
Diffstat (limited to 'shared-bindings/ulab/compare/__init__.pyi')
-rw-r--r--shared-bindings/ulab/compare/__init__.pyi38
1 files changed, 38 insertions, 0 deletions
diff --git a/shared-bindings/ulab/compare/__init__.pyi b/shared-bindings/ulab/compare/__init__.pyi
new file mode 100644
index 000000000..1606e43c2
--- /dev/null
+++ b/shared-bindings/ulab/compare/__init__.pyi
@@ -0,0 +1,38 @@
+"""Comparison functions"""
+
+def 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))``"""
+ ...
+
+def 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"""
+ ...
+
+def 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"""
+ ...
+
+def equal(x1, x2):
+ """Return an array of bool which is true where x1[i] == x2[i] and false elsewhere"""
+ ...
+
+def not_equal(x1, x2):
+ """Return an array of bool which is false where x1[i] == x2[i] and true elsewhere"""
+ ...