Interface Cumulative<T>

A trait for cumulative operations.

interface Cumulative<T> {
    cumCount(reverse?: boolean): T;
    cumCount(__namedParameters: { reverse: boolean }): T;
    cumMax(reverse?: boolean): T;
    cumMax(__namedParameters: { reverse: boolean }): T;
    cumMin(reverse?: boolean): T;
    cumMin(__namedParameters: { reverse: boolean }): T;
    cumProd(reverse?: boolean): T;
    cumProd(__namedParameters: { reverse: boolean }): T;
    cumSum(reverse?: boolean): T;
    cumSum(__namedParameters: { reverse: boolean }): T;
}

Type Parameters

Hierarchy (View Summary)

Cumulative
- pl.Expr
- pl.Series

Index

Methods - Cumulative

cumCount cumMax cumMin cumProd cumSum

Methods - Cumulative

cumCount

cumCount(reverse?: boolean): T
Get an array with the cumulative count computed at every element.
Parameters
- Optionalreverse: boolean
Returns T
- Defined in polars/shared_traits.ts:140
cumCount(__namedParameters: { reverse: boolean }): T
Parameters
- __namedParameters: { reverse: boolean }
Returns T
- Defined in polars/shared_traits.ts:141

cumMax

cumMax(reverse?: boolean): T
Get an array with the cumulative max computes at every element.
Parameters
- Optionalreverse: boolean
  reverse the operation
Returns T
Example
```
>  const s = pl.Series("a", [1, 2, 3])
>  s.cumMax()
shape: (3,)
Series: 'b' [i64]
[
        1
        2
        3
]
```
- Defined in polars/shared_traits.ts:160
cumMax(__namedParameters: { reverse: boolean }): T
Parameters
- __namedParameters: { reverse: boolean }
Returns T
- Defined in polars/shared_traits.ts:161

cumMin

cumMin(reverse?: boolean): T
Get an array with the cumulative min computed at every element.
Parameters
- Optionalreverse: boolean
  reverse the operation
Returns T
Example
```
>  const s = pl.Series("a", [1, 2, 3])
>  s.cumMin()
shape: (3,)
Series: 'b' [i64]
[
        1
        1
        1
]
```
- Defined in polars/shared_traits.ts:180
cumMin(__namedParameters: { reverse: boolean }): T
Parameters
- __namedParameters: { reverse: boolean }
Returns T
- Defined in polars/shared_traits.ts:181

cumProd

cumProd(reverse?: boolean): T
Get an array with the cumulative product computed at every element.
Parameters
- Optionalreverse: boolean
  reverse the operation
Returns T
Example
```
>  const s = pl.Series("a", [1, 2, 3])
>  s.cumProd()
shape: (3,)
Series: 'b' [i64]
[
        1
        2
        6
]
```
- Defined in polars/shared_traits.ts:200
cumProd(__namedParameters: { reverse: boolean }): T
Parameters
- __namedParameters: { reverse: boolean }
Returns T
- Defined in polars/shared_traits.ts:201

cumSum

cumSum(reverse?: boolean): T
Get an array with the cumulative sum computed at every element.
Parameters
- Optionalreverse: boolean
  reverse the operation
Returns T
Example
```
>  const s = pl.Series("a", [1, 2, 3])
>  s.cumSum()
shape: (3,)
Series: 'b' [i64]
[
        1
        3
        6
]
```
- Defined in polars/shared_traits.ts:220
cumSum(__namedParameters: { reverse: boolean }): T
Parameters
- __namedParameters: { reverse: boolean }
Returns T
- Defined in polars/shared_traits.ts:221

Interface Cumulative<T>

Type Parameters

Hierarchy (View Summary)

Index

Methods - Cumulative

Methods - Cumulative

cumCount

Parameters

Returns T

Parameters

Returns T

cumMax

Parameters

Returns T

Example

Parameters

Returns T

cumMin

Parameters

Returns T

Example

Parameters

Returns T

cumProd

Parameters

Returns T

Example

Parameters

Returns T

cumSum

Parameters

Returns T

Example

Parameters

Returns T

Settings

On This Page