Skip to content

Commit fe0a404

Browse files
koperagenkoperagen
committed
Split "diff" into "diff(value)" and "diffOrNull"
1 parent 846e351 commit fe0a404

File tree

14 files changed

+275
-19
lines changed

14 files changed

+275
-19
lines changed

‎core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataRowApi.kt‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ import org.jetbrains.kotlinx.dataframe.index
1515
import org.jetbrains.kotlinx.dataframe.indices
1616
import org.jetbrains.kotlinx.dataframe.ncol
1717
import org.jetbrains.kotlinx.dataframe.nrow
18+
import org.jetbrains.kotlinx.dataframe.util.DIFF_DEPRECATION_MESSAGE
19+
import org.jetbrains.kotlinx.dataframe.util.DIFF_OR_NULL_IMPORT
20+
import org.jetbrains.kotlinx.dataframe.util.DIFF_REPLACE_MESSAGE
1821
import kotlin.experimental.ExperimentalTypeInference
1922
import kotlin.reflect.KProperty
2023
import kotlin.reflect.KType
@@ -74,17 +77,122 @@ public operator fun AnyRow.contains(column: KProperty<*>): Boolean = containsKey
7477

7578
// endregion
7679

80+
/**
81+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
82+
*
83+
* @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
84+
*/
85+
internal interface DiffDocs
86+
87+
/**
88+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
89+
*
90+
* @return null for the first row; difference between expression computed for current and previous row for the following rows
91+
*/
92+
internal interface DiffOrNullDocs
93+
94+
@OptIn(ExperimentalTypeInference::class)
95+
@OverloadResolutionByLambdaReturnType
96+
/**
97+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
98+
*
99+
* @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
100+
*/
101+
public fun <T> DataRow<T>.diff(firstRowResult: Double, expression: RowExpression<T, Double>): Double =
102+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
103+
104+
// required to resolve `diff(0) { intValue }`
105+
@OptIn(ExperimentalTypeInference::class)
106+
@OverloadResolutionByLambdaReturnType
107+
/**
108+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
109+
*
110+
* @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
111+
*/
112+
public fun <T> DataRow<T>.diff(firstRowResult: Int, expression: RowExpression<T, Int>): Int =
113+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
114+
115+
/**
116+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
117+
*
118+
* @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
119+
*/
120+
public fun <T> DataRow<T>.diff(firstRowResult: Long, expression: RowExpression<T, Long>): Long =
121+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
122+
123+
/**
124+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
125+
*
126+
* @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
127+
*/
128+
public fun <T> DataRow<T>.diff(firstRowResult: Float, expression: RowExpression<T, Float>): Float =
129+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
130+
131+
@OptIn(ExperimentalTypeInference::class)
132+
@OverloadResolutionByLambdaReturnType
133+
/**
134+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
135+
*
136+
* @return null for the first row; difference between expression computed for current and previous row for the following rows
137+
*/
138+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Double>): Double? =
139+
prev()?.let { p -> expression(this, this) - expression(p, p) }
140+
141+
/**
142+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
143+
*
144+
* @return null for the first row; difference between expression computed for current and previous row for the following rows
145+
*/
146+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Int>): Int? =
147+
prev()?.let { p -> expression(this, this) - expression(p, p) }
148+
149+
/**
150+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
151+
*
152+
* @return null for the first row; difference between expression computed for current and previous row for the following rows
153+
*/
154+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Long>): Long? =
155+
prev()?.let { p -> expression(this, this) - expression(p, p) }
156+
157+
/**
158+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
159+
*
160+
* @return null for the first row; difference between expression computed for current and previous row for the following rows
161+
*/
162+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Float>): Float? =
163+
prev()?.let { p -> expression(this, this) - expression(p, p) }
164+
77165
@OptIn(ExperimentalTypeInference::class)
78166
@OverloadResolutionByLambdaReturnType
167+
@Deprecated(
168+
DIFF_DEPRECATION_MESSAGE,
169+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
170+
DeprecationLevel.WARNING
171+
)
79172
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Double>): Double? =
80173
prev()?.let { p -> expression(this, this) - expression(p, p) }
81174

175+
@Deprecated(
176+
DIFF_DEPRECATION_MESSAGE,
177+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
178+
DeprecationLevel.WARNING
179+
)
82180
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Int>): Int? =
83181
prev()?.let { p -> expression(this, this) - expression(p, p) }
84182

183+
@Deprecated(
184+
DIFF_DEPRECATION_MESSAGE,
185+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
186+
DeprecationLevel.WARNING
187+
)
85188
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Long>): Long? =
86189
prev()?.let { p -> expression(this, this) - expression(p, p) }
87190

191+
@Deprecated(
192+
DIFF_DEPRECATION_MESSAGE,
193+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
194+
DeprecationLevel.WARNING
195+
)
88196
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Float>): Float? =
89197
prev()?.let { p -> expression(this, this) - expression(p, p) }
90198

‎core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ internal const val DF_READ_DEPRECATION_MESSAGE = "Replaced with `unfold` operati
55
internal const val DF_READ_REPLACE_MESSAGE = "this.unfold(*columns)"
66

77
internal const val ITERABLE_COLUMNS_DEPRECATION_MESSAGE = "Replaced with `toColumnSet()` operation."
8+
9+
internal const val DIFF_DEPRECATION_MESSAGE = "Replaced to explicitly indicate nullable return value; added a new non-null overload."
10+
11+
internal const val DIFF_REPLACE_MESSAGE = "this.diffOrNull(expression)"
12+
13+
internal const val DIFF_OR_NULL_IMPORT = "org.jetbrains.kotlinx.dataframe.api.diffOrNull"

‎core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/puzzles/MediumTests.kt‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,32 @@
11
package org.jetbrains.kotlinx.dataframe.puzzles
22

33
import io.kotest.matchers.shouldBe
4-
import org.jetbrains.kotlinx.dataframe.api.*
4+
import org.jetbrains.kotlinx.dataframe.api.colsOf
55
import org.jetbrains.kotlinx.dataframe.api.column
66
import org.jetbrains.kotlinx.dataframe.api.columnOf
7+
import org.jetbrains.kotlinx.dataframe.api.convert
8+
import org.jetbrains.kotlinx.dataframe.api.countDistinct
79
import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
10+
import org.jetbrains.kotlinx.dataframe.api.diffOrNull
11+
import org.jetbrains.kotlinx.dataframe.api.filter
12+
import org.jetbrains.kotlinx.dataframe.api.groupBy
13+
import org.jetbrains.kotlinx.dataframe.api.isNaN
14+
import org.jetbrains.kotlinx.dataframe.api.map
15+
import org.jetbrains.kotlinx.dataframe.api.mapToColumn
16+
import org.jetbrains.kotlinx.dataframe.api.minBy
17+
import org.jetbrains.kotlinx.dataframe.api.name
18+
import org.jetbrains.kotlinx.dataframe.api.named
19+
import org.jetbrains.kotlinx.dataframe.api.namedValuesOf
20+
import org.jetbrains.kotlinx.dataframe.api.prev
21+
import org.jetbrains.kotlinx.dataframe.api.rowMean
22+
import org.jetbrains.kotlinx.dataframe.api.sortBy
23+
import org.jetbrains.kotlinx.dataframe.api.sortDesc
24+
import org.jetbrains.kotlinx.dataframe.api.sum
25+
import org.jetbrains.kotlinx.dataframe.api.take
26+
import org.jetbrains.kotlinx.dataframe.api.transpose
27+
import org.jetbrains.kotlinx.dataframe.api.transposeTo
28+
import org.jetbrains.kotlinx.dataframe.api.value
29+
import org.jetbrains.kotlinx.dataframe.api.with
830
import org.junit.Test
931
import kotlin.math.roundToInt
1032
import kotlin.random.Random
@@ -24,8 +46,8 @@ class MediumTests {
2446
df.filter { prev()?.get(a) != a() } shouldBe expected
2547
df.filter { prev()?.get("A") != "A"() } shouldBe expected
2648

27-
df.filter { diff { a() } != 0 } shouldBe expected
28-
df.filter { diff { "A"<Int>() } != 0 } shouldBe expected
49+
df.filter { diffOrNull { a() } != 0 } shouldBe expected
50+
df.filter { diffOrNull { "A"<Int>() } != 0 } shouldBe expected
2951
}
3052

3153
@Test

‎core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/DataRowApi.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package org.jetbrains.kotlinx.dataframe.samples.api
22

33
import org.jetbrains.kotlinx.dataframe.api.add
44
import org.jetbrains.kotlinx.dataframe.api.at
5-
import org.jetbrains.kotlinx.dataframe.api.diff
5+
import org.jetbrains.kotlinx.dataframe.api.diffOrNull
66
import org.jetbrains.kotlinx.dataframe.api.drop
77
import org.jetbrains.kotlinx.dataframe.api.filter
88
import org.jetbrains.kotlinx.dataframe.api.pivot
@@ -39,7 +39,7 @@ class DataRowApi : TestBase() {
3939
df.filter { index() % 5 == 0 }
4040

4141
// Row condition is used to drop rows where `age` is the same as in previous row
42-
df.drop { diff { age } == 0 }
42+
df.drop { diffOrNull { age } == 0 }
4343

4444
// Row condition is used to filter rows for value update
4545
df.update { weight }.where { index() > 4 && city != "Paris" }.withValue(50)

‎core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataRowTests.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import org.jetbrains.kotlinx.dataframe.api.by
55
import org.jetbrains.kotlinx.dataframe.api.columnNames
66
import org.jetbrains.kotlinx.dataframe.api.convert
77
import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
8-
import org.jetbrains.kotlinx.dataframe.api.diff
8+
import org.jetbrains.kotlinx.dataframe.api.diffOrNull
99
import org.jetbrains.kotlinx.dataframe.api.drop
1010
import org.jetbrains.kotlinx.dataframe.api.dropLast
1111
import org.jetbrains.kotlinx.dataframe.api.first
@@ -40,7 +40,7 @@ class DataRowTests : BaseTest() {
4040

4141
@Test
4242
fun diff() {
43-
typed.update { age }.with { diff { age } }.age.drop(1).values() shouldBe typed.age.values()
43+
typed.update { age }.with { diffOrNull { age } }.age.drop(1).values() shouldBe typed.age.values()
4444
.zipWithNext { curr, next -> next - curr }
4545
}
4646

‎core/generated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/weather/SeriesTests.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class SeriesTests {
4646
val withDiff = typed
4747
.sortBy { city and day }
4848
.groupBy { city }
49-
.add("diff") { diff { temp } ?: 0 }
49+
.add("diff") { diff(0) { temp } }
5050
.concat()
5151

5252
val srcData = typed.rows().map { (it.city to it.day) to it.temp }.toMap()

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/DataRowApi.kt‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ import org.jetbrains.kotlinx.dataframe.index
1515
import org.jetbrains.kotlinx.dataframe.indices
1616
import org.jetbrains.kotlinx.dataframe.ncol
1717
import org.jetbrains.kotlinx.dataframe.nrow
18+
import org.jetbrains.kotlinx.dataframe.util.DIFF_DEPRECATION_MESSAGE
19+
import org.jetbrains.kotlinx.dataframe.util.DIFF_OR_NULL_IMPORT
20+
import org.jetbrains.kotlinx.dataframe.util.DIFF_REPLACE_MESSAGE
1821
import kotlin.experimental.ExperimentalTypeInference
1922
import kotlin.reflect.KProperty
2023
import kotlin.reflect.KType
@@ -74,17 +77,106 @@ public operator fun AnyRow.contains(column: KProperty<*>): Boolean = containsKey
7477

7578
// endregion
7679

80+
/**
81+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
82+
*
83+
* @return [firstRowValue] for the first row; difference between expression computed for current and previous row for the following rows
84+
*/
85+
internal interface DiffDocs
86+
87+
/**
88+
* Calculates the difference between the results of a row expression computed on the current and previous DataRow.
89+
*
90+
* @return null for the first row; difference between expression computed for current and previous row for the following rows
91+
*/
92+
internal interface DiffOrNullDocs
93+
94+
@OptIn(ExperimentalTypeInference::class)
95+
@OverloadResolutionByLambdaReturnType
96+
/**
97+
* @include [DiffDocs]
98+
*/
99+
public fun <T> DataRow<T>.diff(firstRowResult: Double, expression: RowExpression<T, Double>): Double =
100+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
101+
102+
// required to resolve `diff(0) { intValue }`
103+
@OptIn(ExperimentalTypeInference::class)
104+
@OverloadResolutionByLambdaReturnType
105+
/**
106+
* @include [DiffDocs]
107+
*/
108+
public fun <T> DataRow<T>.diff(firstRowResult: Int, expression: RowExpression<T, Int>): Int =
109+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
110+
111+
/**
112+
* @include [DiffDocs]
113+
*/
114+
public fun <T> DataRow<T>.diff(firstRowResult: Long, expression: RowExpression<T, Long>): Long =
115+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
116+
117+
/**
118+
* @include [DiffDocs]
119+
*/
120+
public fun <T> DataRow<T>.diff(firstRowResult: Float, expression: RowExpression<T, Float>): Float =
121+
prev()?.let { p -> expression(this, this) - expression(p, p) } ?: firstRowResult
122+
123+
@OptIn(ExperimentalTypeInference::class)
124+
@OverloadResolutionByLambdaReturnType
125+
/**
126+
* @include [DiffOrNullDocs]
127+
*/
128+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Double>): Double? =
129+
prev()?.let { p -> expression(this, this) - expression(p, p) }
130+
131+
/**
132+
* @include [DiffOrNullDocs]
133+
*/
134+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Int>): Int? =
135+
prev()?.let { p -> expression(this, this) - expression(p, p) }
136+
137+
/**
138+
* @include [DiffOrNullDocs]
139+
*/
140+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Long>): Long? =
141+
prev()?.let { p -> expression(this, this) - expression(p, p) }
142+
143+
/**
144+
* @include [DiffOrNullDocs]
145+
*/
146+
public fun <T> DataRow<T>.diffOrNull(expression: RowExpression<T, Float>): Float? =
147+
prev()?.let { p -> expression(this, this) - expression(p, p) }
148+
77149
@OptIn(ExperimentalTypeInference::class)
78150
@OverloadResolutionByLambdaReturnType
151+
@Deprecated(
152+
DIFF_DEPRECATION_MESSAGE,
153+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
154+
DeprecationLevel.WARNING
155+
)
79156
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Double>): Double? =
80157
prev()?.let { p -> expression(this, this) - expression(p, p) }
81158

159+
@Deprecated(
160+
DIFF_DEPRECATION_MESSAGE,
161+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
162+
DeprecationLevel.WARNING
163+
)
82164
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Int>): Int? =
83165
prev()?.let { p -> expression(this, this) - expression(p, p) }
84166

167+
@Deprecated(
168+
DIFF_DEPRECATION_MESSAGE,
169+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
170+
DeprecationLevel.WARNING
171+
)
85172
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Long>): Long? =
86173
prev()?.let { p -> expression(this, this) - expression(p, p) }
87174

175+
@Deprecated(
176+
DIFF_DEPRECATION_MESSAGE,
177+
ReplaceWith(DIFF_REPLACE_MESSAGE, DIFF_OR_NULL_IMPORT),
178+
DeprecationLevel.WARNING
179+
)
88180
public fun <T> DataRow<T>.diff(expression: RowExpression<T, Float>): Float? =
89181
prev()?.let { p -> expression(this, this) - expression(p, p) }
90182

‎core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/util/deprecationMessages.kt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ internal const val DF_READ_DEPRECATION_MESSAGE = "Replaced with `unfold` operati
55
internal const val DF_READ_REPLACE_MESSAGE = "this.unfold(*columns)"
66

77
internal const val ITERABLE_COLUMNS_DEPRECATION_MESSAGE = "Replaced with `toColumnSet()` operation."
8+
9+
internal const val DIFF_DEPRECATION_MESSAGE = "Replaced to explicitly indicate nullable return value; added a new non-null overload."
10+
11+
internal const val DIFF_REPLACE_MESSAGE = "this.diffOrNull(expression)"
12+
13+
internal const val DIFF_OR_NULL_IMPORT = "org.jetbrains.kotlinx.dataframe.api.diffOrNull"

0 commit comments

Comments
 (0)