Remove forEachColumn and forEachColumnIndexed. Rename forEachRow into forEach.

nikitinas · nikitinas · commit c5462feb11e3 · 2022-05-31T22:27:44.000+03:00
diff --git a/docs/StardustDocs/topics/iterate.md b/docs/StardustDocs/topics/iterate.md
@@ -13,7 +13,7 @@ for (row in df) {
     println(row.age)
 }
 
-df.forEachRow {
+df.forEach {
     println(it.age)
 }
 
@@ -32,7 +32,7 @@ for (row in df) {
     println(row[age])
 }
 
-df.forEachRow {
+df.forEach {
     println(it[age])
 }
 
@@ -49,7 +49,7 @@ for (row in df) {
     println(row["age"])
 }
 
-df.forEachRow {
+df.forEach {
     println(it["age"])
 }
 
@@ -66,10 +66,6 @@ Iterate over columns:
 <!---FUN forColumn-->
 
 ```kotlin
-df.forEachColumn {
-    println(it.name())
-}
-
 df.columns().forEach {
     println(it.name())
 }
diff --git a/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/forEach.kt b/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/forEach.kt
@@ -1,6 +1,5 @@
 package org.jetbrains.kotlinx.dataframe.api
 
-import org.jetbrains.kotlinx.dataframe.AnyCol
 import org.jetbrains.kotlinx.dataframe.DataColumn
 import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.DataRow
@@ -17,12 +16,7 @@ public fun <T> DataColumn<T>.forEachIndexed(action: (Int, T) -> Unit): Unit = va
 
 // region DataFrame
 
-public fun <T> DataFrame<T>.forEachRow(action: RowExpression<T, Unit>): Unit = rows().forEach { action(it, it) }
-
-public fun <T> DataFrame<T>.forEachColumn(action: (AnyCol) -> Unit): Unit = columns().forEach(action)
-
-public fun <T> DataFrame<T>.forEachColumnIndexed(action: (Int, AnyCol) -> Unit): Unit =
-    columns().forEachIndexed(action)
+public fun <T> DataFrame<T>.forEach(action: RowExpression<T, Unit>): Unit = rows().forEach { action(it, it) }
 
 // endregion
 
@@ -34,7 +28,7 @@ public fun <T, G> GroupBy<T, G>.forEach(body: (GroupBy.Entry<T, G>) -> Unit): Un
     )
 }
 public fun <T, G> GroupBy<T, G>.forEach(body: (key: DataRow<T>, group: DataFrame<G>?) -> Unit): Unit =
-    keys.forEachRow { row ->
+    keys.forEach { row ->
         val group = groups[row.index()]
         body(row, group)
     }
diff --git a/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/csv.kt b/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/csv.kt
@@ -331,7 +331,7 @@ public fun AnyFrame.writeCSV(
 ) {
     format.print(writer).use { printer ->
         printer.printRecord(columnNames())
-        forEachRow {
+        forEach {
             val values = it.values.map {
                 when (it) {
                     is AnyRow -> it.toJson()
diff --git a/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/xlsx.kt b/src/main/kotlin/org/jetbrains/kotlinx/dataframe/io/xlsx.kt
@@ -19,7 +19,7 @@ import org.jetbrains.kotlinx.dataframe.ColumnsSelector
 import org.jetbrains.kotlinx.dataframe.DataColumn
 import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
-import org.jetbrains.kotlinx.dataframe.api.forEachRow
+import org.jetbrains.kotlinx.dataframe.api.forEach
 import org.jetbrains.kotlinx.dataframe.api.select
 import org.jetbrains.kotlinx.dataframe.codeGen.DefaultReadDfMethod
 import org.jetbrains.kotlinx.dataframe.codeGen.DefaultReadExcelMethod
@@ -189,7 +189,7 @@ public fun <T> DataFrame<T>.writeExcel(
         i++
     }
 
-    columns.forEachRow {
+    columns.forEach {
         val row = sheet.createRow(i)
         it.values().forEachIndexed { index, any ->
             // In file created by LibreOffice Calc (empty_cell.xls)
diff --git a/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataFrameTests.kt b/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataFrameTests.kt
@@ -57,7 +57,6 @@ import org.jetbrains.kotlinx.dataframe.api.fillNulls
 import org.jetbrains.kotlinx.dataframe.api.filter
 import org.jetbrains.kotlinx.dataframe.api.first
 import org.jetbrains.kotlinx.dataframe.api.forEach
-import org.jetbrains.kotlinx.dataframe.api.forEachColumn
 import org.jetbrains.kotlinx.dataframe.api.forEachIndexed
 import org.jetbrains.kotlinx.dataframe.api.frameColumn
 import org.jetbrains.kotlinx.dataframe.api.gather
@@ -2040,7 +2039,7 @@ class DataFrameTests : BaseTest() {
     @Test
     fun `pivot grouped max`() {
         val pivoted = typed.pivot { name }.groupBy { city }.max()
-        pivoted.getColumnGroup("name").forEachColumn {
+        pivoted.getColumnGroup("name").columns().forEach {
             it.kind() shouldBe ColumnKind.Group
             val group = it.asColumnGroup()
             group.columnNames() shouldBe listOf("age", "weight")
diff --git a/tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Access.kt b/tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Access.kt
@@ -509,7 +509,7 @@ class Access : TestBase() {
     @Test
     fun iterableApi() {
         // SampleStart
-        df.forEachRow { println(it) }
+        df.forEach { println(it) }
         df.take(5)
         df.drop(2)
         df.chunked(10)
@@ -815,7 +815,7 @@ class Access : TestBase() {
             println(row.age)
         }
 
-        df.forEachRow {
+        df.forEach {
             println(it.age)
         }
 
@@ -834,7 +834,7 @@ class Access : TestBase() {
             println(row[age])
         }
 
-        df.forEachRow {
+        df.forEach {
             println(it[age])
         }
 
@@ -851,7 +851,7 @@ class Access : TestBase() {
             println(row["age"])
         }
 
-        df.forEachRow {
+        df.forEach {
             println(it["age"])
         }
 
@@ -864,10 +864,6 @@ class Access : TestBase() {
     @Test
     fun forColumn() {
         // SampleStart
-        df.forEachColumn {
-            println(it.name())
-        }
-
         df.columns().forEach {
             println(it.name())
         }
diff --git a/tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataFrameTreeTests.kt b/tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/DataFrameTreeTests.kt
@@ -40,7 +40,7 @@ import org.jetbrains.kotlinx.dataframe.api.explode
 import org.jetbrains.kotlinx.dataframe.api.expr
 import org.jetbrains.kotlinx.dataframe.api.filter
 import org.jetbrains.kotlinx.dataframe.api.forEach
-import org.jetbrains.kotlinx.dataframe.api.forEachRow
+import org.jetbrains.kotlinx.dataframe.api.forEach
 import org.jetbrains.kotlinx.dataframe.api.frameColumn
 import org.jetbrains.kotlinx.dataframe.api.getColumnGroup
 import org.jetbrains.kotlinx.dataframe.api.getColumnPath
@@ -138,7 +138,7 @@ class DataFrameTreeTests : BaseTest() {
         val groups by id.map { typed[it..it] }
         val df = dataFrameOf(id, groups)
         df.rowsCount() shouldBe typed.rowsCount()
-        df.forEachRow {
+        df.forEach {
             val rowId = it[id]
             groups() shouldBe typed[rowId..rowId]
         }
@@ -572,7 +572,7 @@ class DataFrameTreeTests : BaseTest() {
         joined.select { cols(0, 1) } shouldBe left.toDataFrame()
         joined.select { cols(2, 1) }.rename(name1).into(typed.name) shouldBe right.toDataFrame()
         joined.name shouldBe left.keys.name
-        joined.forEachRow { it[name1] shouldBe it.name.reversed() }
+        joined.forEach { it[name1] shouldBe it.name.reversed() }
     }
 
     @Test
diff --git a/tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/PivotTests.kt b/tests/src/test/kotlin/org/jetbrains/kotlinx/dataframe/testSets/person/PivotTests.kt
@@ -21,7 +21,6 @@ import org.jetbrains.kotlinx.dataframe.api.explodeLists
 import org.jetbrains.kotlinx.dataframe.api.expr
 import org.jetbrains.kotlinx.dataframe.api.filter
 import org.jetbrains.kotlinx.dataframe.api.first
-import org.jetbrains.kotlinx.dataframe.api.forEachColumn
 import org.jetbrains.kotlinx.dataframe.api.frames
 import org.jetbrains.kotlinx.dataframe.api.gather
 import org.jetbrains.kotlinx.dataframe.api.getColumnGroup
@@ -437,7 +436,7 @@ class PivotTests {
             value.last() into "last value"
             "unused"
         }
-        pivoted.getColumnGroup("key").forEachColumn {
+        pivoted.getColumnGroup("key").columns().forEach {
             it.kind() shouldBe ColumnKind.Group
             it.asColumnGroup().columnNames() shouldBe listOf("first value", "last value")
         }
@@ -451,7 +450,7 @@ class PivotTests {
             typed.add(type) { value?.javaClass?.kotlin ?: Unit::class }
                 .pivot { key }.groupBy { name }.values { value and (type default Any::class) into "data" }
 
-        pivoted.getColumnGroup("key").forEachColumn {
+        pivoted.getColumnGroup("key").columns().forEach {
             val group = it.asColumnGroup()
             group.columnNames() shouldBe listOf("data")
             group["data"].asColumnGroup().columnNames() shouldBe listOf("value", "type")

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ for (row in df) {`
`13`	`13`	`println(row.age)`
`14`	`14`	`}`
`15`	`15`
`16`		`-df.forEachRow {`
	`16`	`+df.forEach {`
`17`	`17`	`println(it.age)`
`18`	`18`	`}`
`19`	`19`
`@@ -32,7 +32,7 @@ for (row in df) {`
`32`	`32`	`println(row[age])`
`33`	`33`	`}`
`34`	`34`
`35`		`-df.forEachRow {`
	`35`	`+df.forEach {`
`36`	`36`	`println(it[age])`
`37`	`37`	`}`
`38`	`38`
`@@ -49,7 +49,7 @@ for (row in df) {`
`49`	`49`	`println(row["age"])`
`50`	`50`	`}`
`51`	`51`
`52`		`-df.forEachRow {`
	`52`	`+df.forEach {`
`53`	`53`	`println(it["age"])`
`54`	`54`	`}`
`55`	`55`
`@@ -66,10 +66,6 @@ Iterate over columns:`
`66`	`66`	`<!---FUN forColumn-->`
`67`	`67`
`68`	`68`	```kotlin
`69`		`-df.forEachColumn {`
`70`		`- println(it.name())`
`71`		`-}`
`72`		`-`
`73`	`69`	`df.columns().forEach {`
`74`	`70`	`println(it.name())`
`75`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -509,7 +509,7 @@ class Access : TestBase() {`
`509`	`509`	`@Test`
`510`	`510`	`fun iterableApi() {`
`511`	`511`	`// SampleStart`
`512`		`- df.forEachRow { println(it) }`
	`512`	`+ df.forEach { println(it) }`
`513`	`513`	`df.take(5)`
`514`	`514`	`df.drop(2)`
`515`	`515`	`df.chunked(10)`
`@@ -815,7 +815,7 @@ class Access : TestBase() {`
`815`	`815`	`println(row.age)`
`816`	`816`	`}`
`817`	`817`
`818`		`- df.forEachRow {`
	`818`	`+ df.forEach {`
`819`	`819`	`println(it.age)`
`820`	`820`	`}`
`821`	`821`
`@@ -834,7 +834,7 @@ class Access : TestBase() {`
`834`	`834`	`println(row[age])`
`835`	`835`	`}`
`836`	`836`
`837`		`- df.forEachRow {`
	`837`	`+ df.forEach {`
`838`	`838`	`println(it[age])`
`839`	`839`	`}`
`840`	`840`
`@@ -851,7 +851,7 @@ class Access : TestBase() {`
`851`	`851`	`println(row["age"])`
`852`	`852`	`}`
`853`	`853`
`854`		`- df.forEachRow {`
	`854`	`+ df.forEach {`
`855`	`855`	`println(it["age"])`
`856`	`856`	`}`
`857`	`857`
`@@ -864,10 +864,6 @@ class Access : TestBase() {`
`864`	`864`	`@Test`
`865`	`865`	`fun forColumn() {`
`866`	`866`	`// SampleStart`
`867`		`- df.forEachColumn {`
`868`		`- println(it.name())`
`869`		`- }`
`870`		`-`
`871`	`867`	`df.columns().forEach {`
`872`	`868`	`println(it.name())`
`873`	`869`	`}`