Skip to content

daft.functions.clip#

clip #

clip(expr: Expression, min: Expression | None = None, max: Expression | None = None) -> Expression

Clips an expression to the given minimum and maximum values.

Parameters:

Name Type Description Default
expr Expression

The expression to clip

 required
min Expression | None

Minimum value to clip to. If None (or column value is Null), no lower clipping is applied.

 None
max Expression | None

Maximum value to clip to. If None (or column value is Null), no upper clipping is applied.

 None
Source code in daft/functions/numeric.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
def clip(
    expr: Expression,
    min: Expression | None = None,
    max: Expression | None = None,
) -> Expression:
    """Clips an expression to the given minimum and maximum values.

    Args:
        expr: The expression to clip
        min: Minimum value to clip to. If None (or column value is Null), no lower clipping is applied.
        max: Maximum value to clip to. If None (or column value is Null), no upper clipping is applied.
    """
    return Expression._call_builtin_scalar_fn("clip", expr, min, max)