nodejs-polars
    Preparing search index...

    Interface Round<T>

    interface Round<T> {
        ceil(): T;
        clip(min: number, max: number): T;
        clip(options: { max: number; min: number }): any;
        floor(): T;
        round(decimals: number, mode?: RoundMode): T;
        round(options: { decimals: number; mode?: RoundMode }): T;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Methods - Math

    ceil clip floor round

    Methods - Math

    • Ceil underlying floating point array to the highest integers smaller or equal to the float value. Only works on floating point Series

      Returns T

    • Clip (limit) the values in an array to any value that fits in 64 floating point range. Only works for the following dtypes: {Int32, Int64, Float32, Float64, UInt32}. If you want to clip other dtypes, consider writing a when -> then -> otherwise expression

      Parameters

      • min: number

        Minimum value

      • max: number

        Maximum value

      Returns T

    • Parameters

      • options: { max: number; min: number }

      Returns any

    • Floor underlying floating point array to the lowest integers smaller or equal to the float value. Only works on floating point Series

      Returns T

    • Round underlying floating point data by decimals digits.

      Similar functionality to javascript toFixed

      Parameters

      • decimals: number

        number of decimals to round by.

      • Optionalmode: RoundMode

        Rounding mode, the default is "half to even" (also known as "bankers' rounding"). RoundMode. * halftoeven round to the nearest even number * halfawayfromzero round to the nearest number away from zero

      Returns T

    • Parameters

      • options: { decimals: number; mode?: RoundMode }

      Returns T

    Settings

    Member Visibility

    On This Page

    Methods - Math