core/org.jetbrains.kotlinx.dataframe.api/cumSum

cumSum

@JvmName(name = "cumSumShort")
fun DataColumn<Short>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int>
@JvmName(name = "cumSumNullableShort")
fun DataColumn<Short?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int?>
@JvmName(name = "cumSumByte")
fun DataColumn<Byte>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int>
@JvmName(name = "cumSumNullableByte")
fun DataColumn<Byte?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int?>
@JvmName(name = "cumSumDouble")
fun DataColumn<Double?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Double>
@JvmName(name = "cumSumFloat")
fun DataColumn<Float?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Float>
fun <T : Number?> DataColumn<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<T>

The CumSum Operation

Computes the cumulative sums of the values in each column from the DataColumn from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new DataColumn of the same type with the cumulative sums.

Parameters

skipNA

Whether to skip null and NaN values (default: true).

See also

fun <T, C : Number?> DataFrame<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA, columns: ColumnsSelector<T, C>): DataFrame<T>
fun <T> DataFrame<T>.cumSum(vararg columns: String, skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T>

The CumSum Operation

Computes the cumulative sums of the values in each column from the DataFrame from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new DataFrame of the same type with the cumulative sums.

Parameters

columns

The selection of the columns to apply the cumSum operation to. If not provided, cumSum will be applied to all primitive columns at any depth.

skipNA

Whether to skip null and NaN values (default: true).

See also

fun <T> DataFrame<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T>

The CumSum Operation

Computes the cumulative sums of the values in each column from the DataFrame from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new DataFrame of the same type with the cumulative sums.

Parameters

skipNA

Whether to skip null and NaN values (default: true).

See also

fun <T, G, C : Number?> GroupBy<T, G>.cumSum(skipNA: Boolean = defaultCumSumSkipNA, columns: ColumnsSelector<G, C>): GroupBy<T, G>
fun <T, G> GroupBy<T, G>.cumSum(vararg columns: String, skipNA: Boolean = defaultCumSumSkipNA): GroupBy<T, G>

The CumSum Operation

Computes the cumulative sums of the values in each column from the GroupBy from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new GroupBy of the same type with the cumulative sums.

Parameters

columns

The selection of the columns to apply the cumSum operation to. If not provided, cumSum will be applied to all primitive columns at any depth.

skipNA

Whether to skip null and NaN values (default: true).

See also

fun <T, G> GroupBy<T, G>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): GroupBy<T, G>

The CumSum Operation

Computes the cumulative sums of the values in each column from the GroupBy from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new GroupBy of the same type with the cumulative sums.

Parameters

skipNA

Whether to skip null and NaN values (default: true).

See also

fun <T> DataFrame<T>.cumSum(vararg columns: ColumnReference<Number?>, skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T>
fun <T> DataFrame<T>.cumSum(vararg columns: KProperty<Number?>, skipNA: Boolean = defaultCumSumSkipNA): DataFrame<T>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

The CumSum Operation

Computes the cumulative sums of the values in each column from the DataFrame from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new DataFrame of the same type with the cumulative sums.

Parameters

columns

The selection of the columns to apply the cumSum operation to. If not provided, cumSum will be applied to all primitive columns at any depth.

skipNA

Whether to skip null and NaN values (default: true).

See also

fun <T, G> GroupBy<T, G>.cumSum(vararg columns: ColumnReference<Number?>, skipNA: Boolean = defaultCumSumSkipNA): GroupBy<T, G>
fun <T, G> GroupBy<T, G>.cumSum(vararg columns: KProperty<Number?>, skipNA: Boolean = defaultCumSumSkipNA): GroupBy<T, G>

Deprecated

It's recommended to migrate to the String or Extension Properties Access API https://kotlin.github.io/dataframe/apilevels.html

The CumSum Operation

Computes the cumulative sums of the values in each column from the GroupBy from the first cell to the last cell.

NOTE: If the column contains nullable values and skipNA is set to true, null and NaN values are skipped when computing the cumulative sum. When false, all values after the first NA will be NaN (for Double and Float columns) or null (for other columns).

cumSum only works on columns that contain solely primitive numbers.

Similar to sum, Byte- and Short-columns are converted to Int.

Return

A new GroupBy of the same type with the cumulative sums.

Parameters

columns

The selection of the columns to apply the cumSum operation to. If not provided, cumSum will be applied to all primitive columns at any depth.

skipNA

Whether to skip null and NaN values (default: true).

See also

Generated by Dokka
© 2021–2026 JetBrains s.r.o. and contributors. Licensed under Apache 2.0. | Documentation | GitHub | Slack Community | X | YouTube