summaryrefslogtreecommitdiff
path: root/shared-bindings/ulab/compare/__init__.pyi
blob: 00a9eae1e62fd2dad956e0198c703ac3de262d0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"""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"""
    ...