Skip to content

Commit 71a49a0

Browse files
Automated commit of generated code
1 parent 7aac08c commit 71a49a0

File tree

2 files changed

+32
-9
lines changed

2 files changed

+32
-9
lines changed

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

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -261,6 +261,24 @@ public inline fun <reified T> columnOf(vararg values: T): DataColumn<T> =
261261

262262
public fun columnOf(vararg values: AnyBaseCol): DataColumn<AnyRow> = columnOf(values.asIterable()).forceResolve()
263263

264+
/**
265+
* Example:
266+
* ```kotlin
267+
* val columnGroup = columnOf(
268+
* "a" to columnOf("a1", "a2", "a3"),
269+
* "b" to columnOf(1, 2, 3),
270+
* )
271+
* ```
272+
*/
273+
@Refine
274+
@Interpretable("ColumnOfPairs")
275+
public fun columnOf(vararg columns: Pair<String, AnyBaseCol>): ColumnGroup<*> =
276+
dataFrameOf(
277+
columns.map { (name, col) ->
278+
col.rename(name)
279+
},
280+
).asColumnGroup()
281+
264282
public fun <T> columnOf(vararg frames: DataFrame<T>): FrameColumn<T> = columnOf(frames.asIterable()).forceResolve()
265283

266284
public fun columnOf(columns: Iterable<AnyBaseCol>): DataColumn<AnyRow> =
@@ -284,15 +302,6 @@ public inline fun <reified T> column(values: Iterable<T>): DataColumn<T> =
284302
allColsMakesColGroup = true,
285303
).forceResolve()
286304

287-
@Refine
288-
@Interpretable("ColumnOfPairs")
289-
public fun columnOf(vararg columns: Pair<String, AnyBaseCol>): ColumnGroup<*> =
290-
dataFrameOf(
291-
columns.map { (name, col) ->
292-
col.rename(name)
293-
},
294-
).asColumnGroup()
295-
296305
// endregion
297306

298307
// region create DataFrame
@@ -314,6 +323,18 @@ public fun dataFrameOf(columns: Iterable<AnyBaseCol>): DataFrame<*> {
314323
return DataFrameImpl<Unit>(cols, nrow)
315324
}
316325

326+
/**
327+
* Example:
328+
* ```kotlin
329+
* val df = dataFrameOf(
330+
* "a" to columnOf(1, 2),
331+
* "b" to columnOf(1.0, 2.0),
332+
* "group" to columnOf(
333+
* "nestedA" to columnOf("42", "abc"),
334+
* )
335+
* )
336+
* ```
337+
*/
317338
@Refine
318339
@JvmName("dataFrameOfColumns")
319340
@Interpretable("DataFrameOfPairs")

core/generated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/columns/BaseColumn.kt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ import kotlin.reflect.KType
1818
* Column operations that doesn't clash by signature with [DataFrame] operations can be defined for [BaseColumn]
1919
*
2020
* @param T type of values contained in column.
21+
* @see [org.jetbrains.kotlinx.dataframe.api.columnOf]
22+
* @see [org.jetbrains.kotlinx.dataframe.DataColumn.createByType]
2123
*/
2224
public interface BaseColumn<out T> : ColumnReference<T> {
2325

0 commit comments

Comments
 (0)