Skip to content

Relax type constraints xxxFor {} statistics functions #1430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 8, 2025
Merged

Relax type constraints xxxFor {} statistics functions #1430

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bf762a8
feat: relax type constraints for statistics functions
jetbrains-junie[bot] Sep 4, 2025
dd13f2e
[issue-1430] feat: revert Aggregators.kt and relax type constraints
junie-eap[bot] Sep 5, 2025
97f0388
improved maxFor implementation
Jolanrensen Sep 5, 2025
623bf18
added missing Comparable<X & Any>? -> Comparable<*>? in xxxFor statis…
Jolanrensen Sep 8, 2025
7772835
updated doc examples for xxFor {} statistics to show types can now be…
Jolanrensen Sep 8, 2025
4439015
[issue-1430] feat: update aggregation functions for consistency and s…
junie-eap[bot] Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/max.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,24 +81,24 @@ public fun <T> DataFrame<T>.max(skipNaN: Boolean = skipNaNDefault): DataRow<T> =

@Refine
@Interpretable("Max1")
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.maxFor(
public fun <T, C : Comparable<*>?> DataFrame<T>.maxFor(
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, C>,
): DataRow<T> = Aggregators.max<C>(skipNaN).aggregateFor(this, columns)
): DataRow<T> = Aggregators.max.invoke(skipNaN).aggregateFor(this, columns)
Comment on lines +84 to +87
Copy link

Copilot AI Sep 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent implementation approach compared to other statistical functions. This function uses direct invocation while minFor, medianFor, and percentileFor use explicit type casting with @Suppress(\"UNCHECKED_CAST\"). All functions should follow the same pattern for consistency.

Copilot uses AI. Check for mistakes.

public fun <T> DataFrame<T>.maxFor(vararg columns: String, skipNaN: Boolean = skipNaNDefault): DataRow<T> =
maxFor(skipNaN) { columns.toComparableColumns() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.maxFor(
public fun <T, C : Comparable<*>?> DataFrame<T>.maxFor(
vararg columns: ColumnReference<C>,
skipNaN: Boolean = skipNaNDefault,
): DataRow<T> = maxFor(skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.maxFor(
public fun <T, C : Comparable<*>?> DataFrame<T>.maxFor(
vararg columns: KProperty<C>,
skipNaN: Boolean = skipNaNDefault,
): DataRow<T> = maxFor(skipNaN) { columns.toColumnSet() }
Expand Down Expand Up @@ -212,24 +212,24 @@ public fun <T> Grouped<T>.max(skipNaN: Boolean = skipNaNDefault): DataFrame<T> =

@Refine
@Interpretable("GroupByMax0")
public fun <T, C : Comparable<C & Any>?> Grouped<T>.maxFor(
public fun <T, C : Comparable<*>?> Grouped<T>.maxFor(
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, C>,
): DataFrame<T> = Aggregators.max<C>(skipNaN).aggregateFor(this, columns)
): DataFrame<T> = Aggregators.max.invoke(skipNaN).aggregateFor(this, columns)

public fun <T> Grouped<T>.maxFor(vararg columns: String, skipNaN: Boolean = skipNaNDefault): DataFrame<T> =
maxFor(skipNaN) { columns.toComparableColumns() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> Grouped<T>.maxFor(
public fun <T, C : Comparable<*>?> Grouped<T>.maxFor(
vararg columns: ColumnReference<C>,
skipNaN: Boolean = skipNaNDefault,
): DataFrame<T> = maxFor(skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> Grouped<T>.maxFor(
public fun <T, C : Comparable<*>?> Grouped<T>.maxFor(
vararg columns: KProperty<C>,
skipNaN: Boolean = skipNaNDefault,
): DataFrame<T> = maxFor(skipNaN) { columns.toColumnSet() }
Expand Down Expand Up @@ -302,7 +302,7 @@ public inline fun <T, G, reified C : Comparable<C & Any>?> GroupBy<T, G>.maxBy(
public fun <T> Pivot<T>.max(separate: Boolean = false, skipNaN: Boolean = skipNaNDefault): DataRow<T> =
delegate { max(separate, skipNaN) }

public fun <T, R : Comparable<R & Any>?> Pivot<T>.maxFor(
public fun <T, R : Comparable<*>?> Pivot<T>.maxFor(
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, R>,
Expand All @@ -316,15 +316,15 @@ public fun <T> Pivot<T>.maxFor(

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, R : Comparable<R & Any>?> Pivot<T>.maxFor(
public fun <T, R : Comparable<*>?> Pivot<T>.maxFor(
vararg columns: ColumnReference<R>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
): DataRow<T> = maxFor(separate, skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, R : Comparable<R & Any>?> Pivot<T>.maxFor(
public fun <T, R : Comparable<*>?> Pivot<T>.maxFor(
vararg columns: KProperty<R>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
Expand Down Expand Up @@ -388,11 +388,11 @@ public inline fun <T, reified C : Comparable<C & Any>?> Pivot<T>.maxBy(
public fun <T> PivotGroupBy<T>.max(separate: Boolean = false, skipNaN: Boolean = skipNaNDefault): DataFrame<T> =
maxFor(separate, skipNaN, intraComparableColumns())

public fun <T, R : Comparable<R & Any>?> PivotGroupBy<T>.maxFor(
public fun <T, R : Comparable<*>?> PivotGroupBy<T>.maxFor(
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, R>,
): DataFrame<T> = Aggregators.max<R>(skipNaN).aggregateFor(this, separate, columns)
): DataFrame<T> = Aggregators.max.invoke(skipNaN).aggregateFor(this, separate, columns)

public fun <T> PivotGroupBy<T>.maxFor(
vararg columns: String,
Expand All @@ -402,15 +402,15 @@ public fun <T> PivotGroupBy<T>.maxFor(

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, R : Comparable<R & Any>?> PivotGroupBy<T>.maxFor(
public fun <T, R : Comparable<*>?> PivotGroupBy<T>.maxFor(
vararg columns: ColumnReference<R>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
): DataFrame<T> = maxFor(separate, skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, R : Comparable<R & Any>?> PivotGroupBy<T>.maxFor(
public fun <T, R : Comparable<*>?> PivotGroupBy<T>.maxFor(
vararg columns: KProperty<R>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
Expand Down Expand Up @@ -500,7 +500,7 @@ public inline fun <reified T : Comparable<T & Any>?> AnyRow.rowMaxOf(): T & Any
public fun <T> DataFrame<T>.max(): DataRow<T> = max(skipNaN = skipNaNDefault)

@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.maxFor(columns: ColumnsForAggregateSelector<T, C>): DataRow<T> =
public fun <T, C : Comparable<*>?> DataFrame<T>.maxFor(columns: ColumnsForAggregateSelector<T, C>): DataRow<T> =
maxFor(skipNaN = skipNaNDefault, columns = columns)

@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
Expand All @@ -509,12 +509,12 @@ public fun <T> DataFrame<T>.maxFor(vararg columns: String): DataRow<T> =

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.maxFor(vararg columns: ColumnReference<C>): DataRow<T> =
public fun <T, C : Comparable<*>?> DataFrame<T>.maxFor(vararg columns: ColumnReference<C>): DataRow<T> =
maxFor(columns = columns, skipNaN = skipNaNDefault)

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.maxFor(vararg columns: KProperty<C>): DataRow<T> =
public fun <T, C : Comparable<*>?> DataFrame<T>.maxFor(vararg columns: KProperty<C>): DataRow<T> =
maxFor(columns = columns, skipNaN = skipNaNDefault)

@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
Expand Down Expand Up @@ -608,7 +608,7 @@ public fun <T> Grouped<T>.max(): DataFrame<T> = max(skipNaN = skipNaNDefault)
@Refine
@Interpretable("GroupByMax0")
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, C : Comparable<C & Any>?> Grouped<T>.maxFor(columns: ColumnsForAggregateSelector<T, C>): DataFrame<T> =
public fun <T, C : Comparable<*>?> Grouped<T>.maxFor(columns: ColumnsForAggregateSelector<T, C>): DataFrame<T> =
maxFor(skipNaN = skipNaNDefault, columns = columns)

@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
Expand All @@ -617,12 +617,12 @@ public fun <T> Grouped<T>.maxFor(vararg columns: String): DataFrame<T> =

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, C : Comparable<C & Any>?> Grouped<T>.maxFor(vararg columns: ColumnReference<C>): DataFrame<T> =
public fun <T, C : Comparable<*>?> Grouped<T>.maxFor(vararg columns: ColumnReference<C>): DataFrame<T> =
maxFor(columns = columns, skipNaN = skipNaNDefault)

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, C : Comparable<C & Any>?> Grouped<T>.maxFor(vararg columns: KProperty<C>): DataFrame<T> =
public fun <T, C : Comparable<*>?> Grouped<T>.maxFor(vararg columns: KProperty<C>): DataFrame<T> =
maxFor(columns = columns, skipNaN = skipNaNDefault)

@Refine
Expand Down Expand Up @@ -684,7 +684,7 @@ public inline fun <T, G, reified C : Comparable<C & Any>?> GroupBy<T, G>.maxBy(
public fun <T> Pivot<T>.max(separate: Boolean = false): DataRow<T> = max(separate, skipNaN = skipNaNDefault)

@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, R : Comparable<R & Any>?> Pivot<T>.maxFor(
public fun <T, R : Comparable<*>?> Pivot<T>.maxFor(
separate: Boolean = false,
columns: ColumnsForAggregateSelector<T, R>,
): DataRow<T> = maxFor(separate, skipNaN = skipNaNDefault, columns = columns)
Expand All @@ -695,14 +695,14 @@ public fun <T> Pivot<T>.maxFor(vararg columns: String, separate: Boolean = false

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, R : Comparable<R & Any>?> Pivot<T>.maxFor(
public fun <T, R : Comparable<*>?> Pivot<T>.maxFor(
vararg columns: ColumnReference<R>,
separate: Boolean = false,
): DataRow<T> = maxFor(columns = columns, separate = separate, skipNaN = skipNaNDefault)

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, R : Comparable<R & Any>?> Pivot<T>.maxFor(
public fun <T, R : Comparable<*>?> Pivot<T>.maxFor(
vararg columns: KProperty<R>,
separate: Boolean = false,
): DataRow<T> = maxFor(columns = columns, separate = separate, skipNaN = skipNaNDefault)
Expand Down Expand Up @@ -748,7 +748,7 @@ public inline fun <T, reified C : Comparable<C & Any>?> Pivot<T>.maxBy(column: K
public fun <T> PivotGroupBy<T>.max(separate: Boolean = false): DataFrame<T> = max(separate, skipNaN = skipNaNDefault)

@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, R : Comparable<R & Any>?> PivotGroupBy<T>.maxFor(
public fun <T, R : Comparable<*>?> PivotGroupBy<T>.maxFor(
separate: Boolean = false,
columns: ColumnsForAggregateSelector<T, R>,
): DataFrame<T> = maxFor(separate, skipNaN = skipNaNDefault, columns = columns)
Expand All @@ -759,14 +759,14 @@ public fun <T> PivotGroupBy<T>.maxFor(vararg columns: String, separate: Boolean

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, R : Comparable<R & Any>?> PivotGroupBy<T>.maxFor(
public fun <T, R : Comparable<*>?> PivotGroupBy<T>.maxFor(
vararg columns: ColumnReference<R>,
separate: Boolean = false,
): DataFrame<T> = maxFor(columns = columns, separate = separate, skipNaN = skipNaNDefault)

@AccessApiOverload
@Deprecated(MAX_NO_SKIPNAN, level = DeprecationLevel.HIDDEN)
public fun <T, R : Comparable<R & Any>?> PivotGroupBy<T>.maxFor(
public fun <T, R : Comparable<*>?> PivotGroupBy<T>.maxFor(
vararg columns: KProperty<R>,
separate: Boolean = false,
): DataFrame<T> = maxFor(columns = columns, separate = separate, skipNaN = skipNaNDefault)
Expand Down
42 changes: 27 additions & 15 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/median.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,24 +138,28 @@ public fun <T> DataFrame<T>.median(skipNaN: Boolean = skipNaNDefault): DataRow<T

@Refine
@Interpretable("Median1")
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.medianFor(
public fun <T, C : Comparable<*>?> DataFrame<T>.medianFor(
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, C>,
): DataRow<T> = Aggregators.medianCommon<C>(skipNaN).aggregateFor(this, columns)
): DataRow<T> {
@Suppress("UNCHECKED_CAST")
return Aggregators.medianCommon<Comparable<Any>?>(skipNaN)
.aggregateFor(this, columns as ColumnsForAggregateSelector<T, Comparable<Any>?>)
}

public fun <T> DataFrame<T>.medianFor(vararg columns: String, skipNaN: Boolean = skipNaNDefault): DataRow<T> =
medianFor(skipNaN) { columns.toComparableColumns() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.medianFor(
public fun <T, C : Comparable<*>?> DataFrame<T>.medianFor(
vararg columns: ColumnReference<C>,
skipNaN: Boolean = skipNaNDefault,
): DataRow<T> = medianFor(skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> DataFrame<T>.medianFor(
public fun <T, C : Comparable<*>?> DataFrame<T>.medianFor(
vararg columns: KProperty<C>,
skipNaN: Boolean = skipNaNDefault,
): DataRow<T> = medianFor(skipNaN) { columns.toColumnSet() }
Expand Down Expand Up @@ -329,23 +333,27 @@ public fun <T> Grouped<T>.median(skipNaN: Boolean = skipNaNDefault): DataFrame<T

@Refine
@Interpretable("GroupByMedian0")
public fun <T, C : Comparable<C & Any>?> Grouped<T>.medianFor(
public fun <T, C : Comparable<*>?> Grouped<T>.medianFor(
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, C>,
): DataFrame<T> = Aggregators.medianCommon<C>(skipNaN).aggregateFor(this, columns)
): DataFrame<T> {
@Suppress("UNCHECKED_CAST")
return Aggregators.medianCommon<Comparable<Any>?>(skipNaN)
.aggregateFor(this, columns as ColumnsForAggregateSelector<T, Comparable<Any>?>)
}

public fun <T> Grouped<T>.medianFor(vararg columns: String): DataFrame<T> = medianFor { columns.toComparableColumns() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> Grouped<T>.medianFor(
public fun <T, C : Comparable<*>?> Grouped<T>.medianFor(
vararg columns: ColumnReference<C>,
skipNaN: Boolean = skipNaNDefault,
): DataFrame<T> = medianFor(skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> Grouped<T>.medianFor(
public fun <T, C : Comparable<*>?> Grouped<T>.medianFor(
vararg columns: KProperty<C>,
skipNaN: Boolean = skipNaNDefault,
): DataFrame<T> = medianFor(skipNaN) { columns.toColumnSet() }
Expand Down Expand Up @@ -418,7 +426,7 @@ public inline fun <T, G, reified C : Comparable<C & Any>?> GroupBy<T, G>.medianB
public fun <T> Pivot<T>.median(separate: Boolean = false, skipNaN: Boolean = skipNaNDefault): DataRow<T> =
medianFor(separate, skipNaN, intraComparableColumns())

public fun <T, C : Comparable<C & Any>?> Pivot<T>.medianFor(
public fun <T, C : Comparable<*>?> Pivot<T>.medianFor(
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, C>,
Expand All @@ -432,15 +440,15 @@ public fun <T> Pivot<T>.medianFor(

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> Pivot<T>.medianFor(
public fun <T, C : Comparable<*>?> Pivot<T>.medianFor(
vararg columns: ColumnReference<C>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
): DataRow<T> = medianFor(separate, skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> Pivot<T>.medianFor(
public fun <T, C : Comparable<*>?> Pivot<T>.medianFor(
vararg columns: KProperty<C>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
Expand Down Expand Up @@ -501,11 +509,15 @@ public inline fun <T, reified C : Comparable<C & Any>?> Pivot<T>.medianBy(
public fun <T> PivotGroupBy<T>.median(separate: Boolean = false, skipNaN: Boolean = skipNaNDefault): DataFrame<T> =
medianFor(separate, skipNaN, intraComparableColumns())

public fun <T, C : Comparable<C & Any>?> PivotGroupBy<T>.medianFor(
public fun <T, C : Comparable<*>?> PivotGroupBy<T>.medianFor(
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
columns: ColumnsForAggregateSelector<T, C>,
): DataFrame<T> = Aggregators.medianCommon<C>(skipNaN).aggregateFor(this, separate, columns)
): DataFrame<T> {
@Suppress("UNCHECKED_CAST")
return Aggregators.medianCommon<Comparable<Any>?>(skipNaN)
.aggregateFor(this, separate, columns as ColumnsForAggregateSelector<T, Comparable<Any>?>)
}

public fun <T> PivotGroupBy<T>.medianFor(
vararg columns: String,
Expand All @@ -515,15 +527,15 @@ public fun <T> PivotGroupBy<T>.medianFor(

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> PivotGroupBy<T>.medianFor(
public fun <T, C : Comparable<*>?> PivotGroupBy<T>.medianFor(
vararg columns: ColumnReference<C>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
): DataFrame<T> = medianFor(separate, skipNaN) { columns.toColumnSet() }

@Deprecated(DEPRECATED_ACCESS_API)
@AccessApiOverload
public fun <T, C : Comparable<C & Any>?> PivotGroupBy<T>.medianFor(
public fun <T, C : Comparable<*>?> PivotGroupBy<T>.medianFor(
vararg columns: KProperty<C>,
separate: Boolean = false,
skipNaN: Boolean = skipNaNDefault,
Expand Down
Loading
Loading