MathOperations

Namespace for mathematical operations.

This class cannot be instantiated directly. It can only be accessed using the math attribute of a cell.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1]);
    out column.transform((cell) -> cell.math.abs());
}

Stub code in MathOperations.sdsstub

class MathOperations {
    /**
     * Get the absolute value.
     *
     * @result cell The absolute value.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [1, -2, null]);
     *     out column.transform((cell) -> cell.math.abs());
     * }
     */
    @Pure
    fun abs() -> cell: Cell<Any>

    /**
     * Get the inverse cosine.
     *
     * @result cell The inverse cosine.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.acos());
     * }
     */
    @Pure
    fun acos() -> cell: Cell<Any>

    /**
     * Get the inverse hyperbolic cosine.
     *
     * @result cell The inverse hyperbolic cosine.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.acosh());
     * }
     */
    @Pure
    fun acosh() -> cell: Cell<Any>

    /**
     * Get the inverse sine.
     *
     * @result cell The inverse sine.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.asin());
     * }
     */
    @Pure
    fun asin() -> cell: Cell<Any>

    /**
     * Get the inverse hyperbolic sine.
     *
     * @result cell The inverse hyperbolic sine.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.asinh());
     * }
     */
    @Pure
    fun asinh() -> cell: Cell<Any>

    /**
     * Get the inverse tangent.
     *
     * @result cell The inverse tangent.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.atan());
     * }
     */
    @Pure
    fun atan() -> cell: Cell<Any>

    /**
     * Get the inverse hyperbolic tangent.
     *
     * @result cell The inverse hyperbolic tangent.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.atanh());
     * }
     */
    @Pure
    fun atanh() -> cell: Cell<Any>

    /**
     * Get the cube root.
     *
     * @result cell The cube root.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [1, 8, null]);
     *     out column.transform((cell) -> cell.math.cbrt());
     * }
     */
    @Pure
    fun cbrt() -> cell: Cell<Any>

    /**
     * Round up to the nearest integer.
     *
     * @result cell The rounded value.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [1.1, 3.0, null]);
     *     out column.transform((cell) -> cell.math.ceil());
     * }
     */
    @Pure
    fun ceil() -> cell: Cell<Any>

    /**
     * Get the cosine.
     *
     * @result cell The cosine.
     *
     * @example
     * from math import pi
     * pipeline example {
     *     val column = Column("a", [0, pi / 2, pi, 3 * pi / 2, null]);
     *     out column.transform((cell) -> cell.math.cos());
     * }
     */
    @Pure
    fun cos() -> cell: Cell<Any>

    /**
     * Get the hyperbolic cosine.
     *
     * @result cell The hyperbolic cosine.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.cosh());
     * }
     */
    @Pure
    fun cosh() -> cell: Cell<Any>

    /**
     * Convert degrees to radians.
     *
     * @result cell The value in radians.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [0, 90, 180, 270, null]);
     *     out column.transform((cell) -> cell.math.degreesToRadians());
     * }
     */
    @Pure
    @PythonName("degrees_to_radians")
    fun degreesToRadians() -> cell: Cell<Any>

    /**
     * Get the exponential.
     *
     * @result cell The exponential.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.exp());
     * }
     */
    @Pure
    fun exp() -> cell: Cell<Any>

    /**
     * Round down to the nearest integer.
     *
     * @result cell The rounded value.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [1.1, 3.0, null]);
     *     out column.transform((cell) -> cell.math.floor());
     * }
     */
    @Pure
    fun floor() -> cell: Cell<Any>

    /**
     * Get the natural logarithm.
     *
     * @result cell The natural logarithm.
     *
     * @example
     * from math import e
     * pipeline example {
     *     val column = Column("a", [0, 1, e, null]);
     *     out column.transform((cell) -> cell.math.ln());
     * }
     */
    @Pure
    fun ln() -> cell: Cell<Any>

    /**
     * Get the logarithm to the specified base.
     *
     * @param base The base of the logarithm. Must be positive and not equal to 1.
     *
     * @result cell The logarithm.
     *
     * @example
     * from math import e
     * pipeline example {
     *     val column1 = Column("a", [0, 1, e, null]);
     *     out column1.transform((cell) -> cell.math.log(e));
     * }
     *
     * @example
     * pipeline example {
     *     val column2 = Column("a", [0, 1, 10, null]);
     *     out column2.transform((cell) -> cell.math.log(10));
     * }
     */
    @Pure
    fun log(
        base: Float
    ) -> cell: Cell<Any>

    /**
     * Get the common logarithm (base 10).
     *
     * @result cell The common logarithm.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [0, 1, 10, null]);
     *     out column.transform((cell) -> cell.math.log10());
     * }
     */
    @Pure
    fun log10() -> cell: Cell<Any>

    /**
     * Convert radians to degrees.
     *
     * @result cell The value in degrees.
     *
     * @example
     * from math import pi
     * pipeline example {
     *     val column = Column("a", [0, pi / 2, pi, 3 * pi / 2, null]);
     *     out column.transform((cell) -> cell.math.radiansToDegrees());
     * }
     */
    @Pure
    @PythonName("radians_to_degrees")
    fun radiansToDegrees() -> cell: Cell<Any>

    /**
     * Round to the specified number of decimal places.
     *
     * @param decimalPlaces The number of decimal places to round to. Must be greater than or equal to 0.
     *
     * @result cell The rounded value.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [0.999, 1.123, 3.456, null]);
     *     out column.transform((cell) -> cell.math.roundToDecimalPlaces(0));
     *     out column.transform((cell) -> cell.math.roundToDecimalPlaces(2));
     * }
     */
    @Pure
    @PythonName("round_to_decimal_places")
    fun roundToDecimalPlaces(
        @PythonName("decimal_places") const decimalPlaces: Int
    ) -> cell: Cell<Any> where {
        decimalPlaces >= 0
    }

    /**
     * Round to the specified number of significant figures.
     *
     * @param significantFigures The number of significant figures to round to. Must be greater than or equal to 1.
     *
     * @result cell The rounded value.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [0.999, 1.123, 3.456, null]);
     *     out column.transform((cell) -> cell.math.roundToSignificantFigures(1));
     *     out column.transform((cell) -> cell.math.roundToSignificantFigures(2));
     * }
     */
    @Pure
    @PythonName("round_to_significant_figures")
    fun roundToSignificantFigures(
        @PythonName("significant_figures") const significantFigures: Int
    ) -> cell: Cell<Any> where {
        significantFigures >= 1
    }

    /**
     * Get the sign (-1 if negative, 0 for zero, and 1 if positive).
     *
     * Note that IEEE 754 defines a negative zero (-0) and a positive zero (+0). This method return a negative zero
     * for -0 and a positive zero for +0.
     *
     * @result cell The sign.
     *
     * @example
     * pipeline example {
     *     val column1 = Column("a", [-1, 0, 1, null]);
     *     out column1.transform((cell) -> cell.math.sign());
     * }
     *
     * @example
     * pipeline example {
     *     val column2 = Column("a", [-1.0, -0.0, 0.0, 1.0, null]);
     *     out column2.transform((cell) -> cell.math.sign());
     * }
     */
    @Pure
    fun sign() -> cell: Cell<Any>

    /**
     * Get the sine.
     *
     * @result cell The sine.
     *
     * @example
     * from math import pi
     * pipeline example {
     *     val column = Column("a", [0, pi / 2, pi, 3 * pi / 2, null]);
     *     out column.transform((cell) -> cell.math.sin());
     * }
     */
    @Pure
    fun sin() -> cell: Cell<Any>

    /**
     * Get the hyperbolic sine.
     *
     * @result cell The hyperbolic sine.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.sinh());
     * }
     */
    @Pure
    fun sinh() -> cell: Cell<Any>

    /**
     * Get the square root.
     *
     * @result cell The square root.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [1, 4, null]);
     *     out column.transform((cell) -> cell.math.sqrt());
     * }
     */
    @Pure
    fun sqrt() -> cell: Cell<Any>

    /**
     * Get the tangent.
     *
     * @result cell The tangent.
     *
     * @example
     * from math import pi
     * pipeline example {
     *     val column = Column("a", [0, pi / 4, 3 * pi / 4, null]);
     *     out column.transform((cell) -> cell.math.tan());
     * }
     */
    @Pure
    fun tan() -> cell: Cell<Any>

    /**
     * Get the hyperbolic tangent.
     *
     * @result cell The hyperbolic tangent.
     *
     * @example
     * pipeline example {
     *     val column = Column("a", [-1, 0, 1, null]);
     *     out column.transform((cell) -> cell.math.tanh());
     * }
     */
    @Pure
    fun tanh() -> cell: Cell<Any>
}

abs

Get the absolute value.

Results:

Name	Type	Description
cell	Cell<Any>	The absolute value.

Examples:

pipeline example {
    val column = Column("a", [1, -2, null]);
    out column.transform((cell) -> cell.math.abs());
}

Stub code in MathOperations.sdsstub

@Pure
fun abs() -> cell: Cell<Any>

acos

Get the inverse cosine.

Results:

Name	Type	Description
cell	Cell<Any>	The inverse cosine.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.acos());
}

Stub code in MathOperations.sdsstub

@Pure
fun acos() -> cell: Cell<Any>

acosh

Get the inverse hyperbolic cosine.

Results:

Name	Type	Description
cell	Cell<Any>	The inverse hyperbolic cosine.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.acosh());
}

Stub code in MathOperations.sdsstub

@Pure
fun acosh() -> cell: Cell<Any>

asin

Get the inverse sine.

Results:

Name	Type	Description
cell	Cell<Any>	The inverse sine.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.asin());
}

Stub code in MathOperations.sdsstub

@Pure
fun asin() -> cell: Cell<Any>

asinh

Get the inverse hyperbolic sine.

Results:

Name	Type	Description
cell	Cell<Any>	The inverse hyperbolic sine.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.asinh());
}

Stub code in MathOperations.sdsstub

@Pure
fun asinh() -> cell: Cell<Any>

atan

Get the inverse tangent.

Results:

Name	Type	Description
cell	Cell<Any>	The inverse tangent.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.atan());
}

Stub code in MathOperations.sdsstub

@Pure
fun atan() -> cell: Cell<Any>

atanh

Get the inverse hyperbolic tangent.

Results:

Name	Type	Description
cell	Cell<Any>	The inverse hyperbolic tangent.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.atanh());
}

Stub code in MathOperations.sdsstub

@Pure
fun atanh() -> cell: Cell<Any>

cbrt

Get the cube root.

Results:

Name	Type	Description
cell	Cell<Any>	The cube root.

Examples:

pipeline example {
    val column = Column("a", [1, 8, null]);
    out column.transform((cell) -> cell.math.cbrt());
}

Stub code in MathOperations.sdsstub

@Pure
fun cbrt() -> cell: Cell<Any>

ceil

Round up to the nearest integer.

Results:

Name	Type	Description
cell	Cell<Any>	The rounded value.

Examples:

pipeline example {
    val column = Column("a", [1.1, 3.0, null]);
    out column.transform((cell) -> cell.math.ceil());
}

Stub code in MathOperations.sdsstub

@Pure
fun ceil() -> cell: Cell<Any>

cos

Get the cosine.

Results:

Name	Type	Description
cell	Cell<Any>	The cosine.

Examples:

from math import pi
pipeline example {
    val column = Column("a", [0, pi / 2, pi, 3 * pi / 2, null]);
    out column.transform((cell) -> cell.math.cos());
}

Stub code in MathOperations.sdsstub

@Pure
fun cos() -> cell: Cell<Any>

cosh

Get the hyperbolic cosine.

Results:

Name	Type	Description
cell	Cell<Any>	The hyperbolic cosine.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.cosh());
}

Stub code in MathOperations.sdsstub

@Pure
fun cosh() -> cell: Cell<Any>

degreesToRadians

Convert degrees to radians.

Results:

Name	Type	Description
cell	Cell<Any>	The value in radians.

Examples:

pipeline example {
    val column = Column("a", [0, 90, 180, 270, null]);
    out column.transform((cell) -> cell.math.degreesToRadians());
}

Stub code in MathOperations.sdsstub

@Pure
@PythonName("degrees_to_radians")
fun degreesToRadians() -> cell: Cell<Any>

exp

Get the exponential.

Results:

Name	Type	Description
cell	Cell<Any>	The exponential.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.exp());
}

Stub code in MathOperations.sdsstub

@Pure
fun exp() -> cell: Cell<Any>

floor

Round down to the nearest integer.

Results:

Name	Type	Description
cell	Cell<Any>	The rounded value.

Examples:

pipeline example {
    val column = Column("a", [1.1, 3.0, null]);
    out column.transform((cell) -> cell.math.floor());
}

Stub code in MathOperations.sdsstub

@Pure
fun floor() -> cell: Cell<Any>

ln

Get the natural logarithm.

Results:

Name	Type	Description
cell	Cell<Any>	The natural logarithm.

Examples:

from math import e
pipeline example {
    val column = Column("a", [0, 1, e, null]);
    out column.transform((cell) -> cell.math.ln());
}

Stub code in MathOperations.sdsstub

@Pure
fun ln() -> cell: Cell<Any>

log

Get the logarithm to the specified base.

Parameters:

Name	Type	Description	Default
base	Float	The base of the logarithm. Must be positive and not equal to 1.	-

Results:

Name	Type	Description
cell	Cell<Any>	The logarithm.

Examples:

from math import e
pipeline example {
    val column1 = Column("a", [0, 1, e, null]);
    out column1.transform((cell) -> cell.math.log(e));
}

pipeline example {
    val column2 = Column("a", [0, 1, 10, null]);
    out column2.transform((cell) -> cell.math.log(10));
}

Stub code in MathOperations.sdsstub

@Pure
fun log(
    base: Float
) -> cell: Cell<Any>

log10

Get the common logarithm (base 10).

Results:

Name	Type	Description
cell	Cell<Any>	The common logarithm.

Examples:

pipeline example {
    val column = Column("a", [0, 1, 10, null]);
    out column.transform((cell) -> cell.math.log10());
}

Stub code in MathOperations.sdsstub

@Pure
fun log10() -> cell: Cell<Any>

radiansToDegrees

Convert radians to degrees.

Results:

Name	Type	Description
cell	Cell<Any>	The value in degrees.

Examples:

from math import pi
pipeline example {
    val column = Column("a", [0, pi / 2, pi, 3 * pi / 2, null]);
    out column.transform((cell) -> cell.math.radiansToDegrees());
}

Stub code in MathOperations.sdsstub

@Pure
@PythonName("radians_to_degrees")
fun radiansToDegrees() -> cell: Cell<Any>

roundToDecimalPlaces

Round to the specified number of decimal places.

Parameters:

Name	Type	Description	Default
decimalPlaces	Int	The number of decimal places to round to. Must be greater than or equal to 0.	-

Results:

Name	Type	Description
cell	Cell<Any>	The rounded value.

Examples:

pipeline example {
    val column = Column("a", [0.999, 1.123, 3.456, null]);
    out column.transform((cell) -> cell.math.roundToDecimalPlaces(0));
    out column.transform((cell) -> cell.math.roundToDecimalPlaces(2));
}

Stub code in MathOperations.sdsstub

@Pure
@PythonName("round_to_decimal_places")
fun roundToDecimalPlaces(
    @PythonName("decimal_places") const decimalPlaces: Int
) -> cell: Cell<Any> where {
    decimalPlaces >= 0
}

roundToSignificantFigures

Round to the specified number of significant figures.

Parameters:

Name	Type	Description	Default
significantFigures	Int	The number of significant figures to round to. Must be greater than or equal to 1.	-

Results:

Name	Type	Description
cell	Cell<Any>	The rounded value.

Examples:

pipeline example {
    val column = Column("a", [0.999, 1.123, 3.456, null]);
    out column.transform((cell) -> cell.math.roundToSignificantFigures(1));
    out column.transform((cell) -> cell.math.roundToSignificantFigures(2));
}

Stub code in MathOperations.sdsstub

@Pure
@PythonName("round_to_significant_figures")
fun roundToSignificantFigures(
    @PythonName("significant_figures") const significantFigures: Int
) -> cell: Cell<Any> where {
    significantFigures >= 1
}

sign

Get the sign (-1 if negative, 0 for zero, and 1 if positive).

Note that IEEE 754 defines a negative zero (-0) and a positive zero (+0). This method return a negative zero for -0 and a positive zero for +0.

Results:

Name	Type	Description
cell	Cell<Any>	The sign.

Examples:

pipeline example {
    val column1 = Column("a", [-1, 0, 1, null]);
    out column1.transform((cell) -> cell.math.sign());
}

pipeline example {
    val column2 = Column("a", [-1.0, -0.0, 0.0, 1.0, null]);
    out column2.transform((cell) -> cell.math.sign());
}

Stub code in MathOperations.sdsstub

@Pure
fun sign() -> cell: Cell<Any>

sin

Get the sine.

Results:

Name	Type	Description
cell	Cell<Any>	The sine.

Examples:

from math import pi
pipeline example {
    val column = Column("a", [0, pi / 2, pi, 3 * pi / 2, null]);
    out column.transform((cell) -> cell.math.sin());
}

Stub code in MathOperations.sdsstub

@Pure
fun sin() -> cell: Cell<Any>

sinh

Get the hyperbolic sine.

Results:

Name	Type	Description
cell	Cell<Any>	The hyperbolic sine.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.sinh());
}

Stub code in MathOperations.sdsstub

@Pure
fun sinh() -> cell: Cell<Any>

sqrt

Get the square root.

Results:

Name	Type	Description
cell	Cell<Any>	The square root.

Examples:

pipeline example {
    val column = Column("a", [1, 4, null]);
    out column.transform((cell) -> cell.math.sqrt());
}

Stub code in MathOperations.sdsstub

@Pure
fun sqrt() -> cell: Cell<Any>

tan

Get the tangent.

Results:

Name	Type	Description
cell	Cell<Any>	The tangent.

Examples:

from math import pi
pipeline example {
    val column = Column("a", [0, pi / 4, 3 * pi / 4, null]);
    out column.transform((cell) -> cell.math.tan());
}

Stub code in MathOperations.sdsstub

@Pure
fun tan() -> cell: Cell<Any>

tanh

Get the hyperbolic tangent.

Results:

Name	Type	Description
cell	Cell<Any>	The hyperbolic tangent.

Examples:

pipeline example {
    val column = Column("a", [-1, 0, 1, null]);
    out column.transform((cell) -> cell.math.tanh());
}

Stub code in MathOperations.sdsstub

@Pure
fun tanh() -> cell: Cell<Any>