small API change

Author: Jolanrensen

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/ColumnDataHolder.kt

@@ -1,9 +1,16 @@
+@file:OptIn(ExperimentalUnsignedTypes::class)
+
 package org.jetbrains.kotlinx.dataframe
 
 import org.jetbrains.kotlinx.dataframe.impl.columns.ColumnDataHolderImpl
+import org.jetbrains.kotlinx.dataframe.impl.columns.of
 import kotlin.reflect.KType
 import kotlin.reflect.typeOf
 
+/**
+ * Represents the contents of a column, however it may be implemented.
+ * The default implementation is found at [ColumnDataHolderImpl].
+ */
 public interface ColumnDataHolder<T> : Iterable<T> {
 
     public val size: Int
@@ -24,49 +31,49 @@ public interface ColumnDataHolder<T> : Iterable<T> {
 }
 
 public fun <T> Collection<T>.toColumnDataHolder(type: KType, distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> =
-    ColumnDataHolderImpl.of(this, type, distinct)
+    ColumnDataHolder.of(this, type, distinct)
 
 public inline fun <reified T> Collection<T>.toColumnDataHolder(distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> =
     this.toColumnDataHolder(typeOf<T>(), distinct)
 
 public fun <T> Array<T>.toColumnDataHolder(type: KType, distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> =
-    ColumnDataHolderImpl.of(this, type, distinct)
+    ColumnDataHolder.of(this, type, distinct)
 
 public inline fun <reified T> Array<T>.toColumnDataHolder(distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> =
     this.toColumnDataHolder(typeOf<T>(), distinct)
 
 public fun BooleanArray.asColumnDataHolder(distinct: Lazy<Set<Boolean>>? = null): ColumnDataHolder<Boolean> =
-    ColumnDataHolderImpl.of(this, typeOf<Boolean>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Boolean>(), distinct)
 
 public fun ByteArray.asColumnDataHolder(distinct: Lazy<Set<Byte>>? = null): ColumnDataHolder<Byte> =
-    ColumnDataHolderImpl.of(this, typeOf<Byte>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Byte>(), distinct)
 
 public fun ShortArray.asColumnDataHolder(distinct: Lazy<Set<Short>>? = null): ColumnDataHolder<Short> =
-    ColumnDataHolderImpl.of(this, typeOf<Short>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Short>(), distinct)
 
 public fun IntArray.asColumnDataHolder(distinct: Lazy<Set<Int>>? = null): ColumnDataHolder<Int> =
-    ColumnDataHolderImpl.of(this, typeOf<Int>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Int>(), distinct)
 
 public fun LongArray.asColumnDataHolder(distinct: Lazy<Set<Long>>? = null): ColumnDataHolder<Long> =
-    ColumnDataHolderImpl.of(this, typeOf<Long>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Long>(), distinct)
 
 public fun FloatArray.asColumnDataHolder(distinct: Lazy<Set<Float>>? = null): ColumnDataHolder<Float> =
-    ColumnDataHolderImpl.of(this, typeOf<Float>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Float>(), distinct)
 
 public fun DoubleArray.asColumnDataHolder(distinct: Lazy<Set<Double>>? = null): ColumnDataHolder<Double> =
-    ColumnDataHolderImpl.of(this, typeOf<Double>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Double>(), distinct)
 
 public fun CharArray.asColumnDataHolder(distinct: Lazy<Set<Char>>? = null): ColumnDataHolder<Char> =
-    ColumnDataHolderImpl.of(this, typeOf<Char>(), distinct)
+    ColumnDataHolder.of(this, typeOf<Char>(), distinct)
 
 public fun UByteArray.asColumnDataHolder(distinct: Lazy<Set<UByte>>? = null): ColumnDataHolder<UByte> =
-    ColumnDataHolderImpl.of(this, typeOf<UByte>(), distinct)
+    ColumnDataHolder.of(this, typeOf<UByte>(), distinct)
 
 public fun UShortArray.asColumnDataHolder(distinct: Lazy<Set<UShort>>? = null): ColumnDataHolder<UShort> =
-    ColumnDataHolderImpl.of(this, typeOf<UShort>(), distinct)
+    ColumnDataHolder.of(this, typeOf<UShort>(), distinct)
 
 public fun UIntArray.asColumnDataHolder(distinct: Lazy<Set<UInt>>? = null): ColumnDataHolder<UInt> =
-    ColumnDataHolderImpl.of(this, typeOf<UInt>(), distinct)
+    ColumnDataHolder.of(this, typeOf<UInt>(), distinct)
 
 public fun ULongArray.asColumnDataHolder(distinct: Lazy<Set<ULong>>? = null): ColumnDataHolder<ULong> =
-    ColumnDataHolderImpl.of(this, typeOf<ULong>(), distinct)
+    ColumnDataHolder.of(this, typeOf<ULong>(), distinct)

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/impl/columns/ColumnDataHolderImpl.kt

@@ -8,117 +8,23 @@ import org.jetbrains.kotlinx.dataframe.impl.isPrimitiveArray
 import kotlin.reflect.KType
 import kotlin.reflect.typeOf
 
-internal class ColumnDataHolderImpl<T> private constructor(
-    private val list: List<T>,
-    distinct: Lazy<Set<T>>?,
-) : ColumnDataHolder<T> {
+internal class ColumnDataHolderImpl<T>(private val list: List<T>, distinct: Lazy<Set<T>>?) : ColumnDataHolder<T> {
 
     override val distinct = distinct ?: lazy { list.toSet() }
+
     override val size: Int get() = list.size
 
     override fun toSet(): Set<T> = distinct.value
+
     override fun toList(): List<T> = list
+
     override fun get(index: Int): T = list[index]
+
     override fun get(range: IntRange): List<T> = list.subList(range.first, range.last + 1)
+
     override fun contains(value: T): Boolean = list.contains(value)
-    override fun iterator(): Iterator<T> = list.iterator()
 
-    companion object {
-
-        /**
-         * Constructs [ColumnDataHolderImpl] using an [asList] wrapper around the [list].
-         */
-        @Suppress("UNCHECKED_CAST")
-        internal fun <T> of(list: Collection<T>, type: KType, distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> {
-            if (list is ColumnDataHolder<*>) return list as ColumnDataHolder<T>
-
-            try {
-                val newList = when (type) {
-                    BOOLEAN -> (list as Collection<Boolean>).toBooleanArray().asList()
-                    BYTE -> (list as Collection<Byte>).toByteArray().asList()
-                    SHORT -> (list as Collection<Short>).toShortArray().asList()
-                    INT -> (list as Collection<Int>).toIntArray().asList()
-                    LONG -> (list as Collection<Long>).toLongArray().asList()
-                    FLOAT -> (list as Collection<Float>).toFloatArray().asList()
-                    DOUBLE -> (list as Collection<Double>).toDoubleArray().asList()
-                    CHAR -> (list as Collection<Char>).toCharArray().asList()
-                    UBYTE -> (list as Collection<UByte>).toUByteArray().asList()
-                    USHORT -> (list as Collection<UShort>).toUShortArray().asList()
-                    UINT -> (list as Collection<UInt>).toUIntArray().asList()
-                    ULONG -> (list as Collection<ULong>).toULongArray().asList()
-                    else -> list.asList()
-                } as List<T>
-
-                return ColumnDataHolderImpl(newList, distinct)
-            } catch (e: Exception) {
-                throw IllegalArgumentException("Can't create ColumnDataHolder from $list and type $type", e)
-            }
-        }
-
-        /**
-         * Constructs [ColumnDataHolderImpl] using an [asList] wrapper around the [array].
-         * If [array] is an array of primitives, it will be converted to a primitive array first before being
-         * wrapped with [asList].
-         */
-        @Suppress("UNCHECKED_CAST")
-        internal fun <T> of(array: Array<T>, type: KType, distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> {
-            try {
-                val list = when (type) {
-                    BOOLEAN -> (array as Array<Boolean>).toBooleanArray().asList()
-                    BYTE -> (array as Array<Byte>).toByteArray().asList()
-                    SHORT -> (array as Array<Short>).toShortArray().asList()
-                    INT -> (array as Array<Int>).toIntArray().asList()
-                    LONG -> (array as Array<Long>).toLongArray().asList()
-                    FLOAT -> (array as Array<Float>).toFloatArray().asList()
-                    DOUBLE -> (array as Array<Double>).toDoubleArray().asList()
-                    CHAR -> (array as Array<Char>).toCharArray().asList()
-                    UBYTE -> (array as Array<UByte>).toUByteArray().asList()
-                    USHORT -> (array as Array<UShort>).toUShortArray().asList()
-                    UINT -> (array as Array<UInt>).toUIntArray().asList()
-                    ULONG -> (array as Array<ULong>).toULongArray().asList()
-                    else -> array.asList()
-                } as List<T>
-
-                return ColumnDataHolderImpl(list, distinct)
-            } catch (e: Exception) {
-                throw IllegalArgumentException(
-                    "Can't create ColumnDataHolder from $array and mismatching type $type",
-                    e
-                )
-            }
-        }
-
-        /**
-         * Constructs [ColumnDataHolderImpl] using an [asList] wrapper around the [primitiveArray].
-         * [primitiveArray] must be an array of primitives, returns `null` if something goes wrong.
-         */
-        @Suppress("UNCHECKED_CAST")
-        internal fun <T> of(primitiveArray: Any, type: KType, distinct: Lazy<Set<T>>? = null): ColumnDataHolder<T> {
-            val newList = when {
-                type == BOOLEAN && primitiveArray is BooleanArray -> primitiveArray.asList()
-                type == BYTE && primitiveArray is ByteArray -> primitiveArray.asList()
-                type == SHORT && primitiveArray is ShortArray -> primitiveArray.asList()
-                type == INT && primitiveArray is IntArray -> primitiveArray.asList()
-                type == LONG && primitiveArray is LongArray -> primitiveArray.asList()
-                type == FLOAT && primitiveArray is FloatArray -> primitiveArray.asList()
-                type == DOUBLE && primitiveArray is DoubleArray -> primitiveArray.asList()
-                type == CHAR && primitiveArray is CharArray -> primitiveArray.asList()
-                type == UBYTE && primitiveArray is UByteArray -> primitiveArray.asList()
-                type == USHORT && primitiveArray is UShortArray -> primitiveArray.asList()
-                type == UINT && primitiveArray is UIntArray -> primitiveArray.asList()
-                type == ULONG && primitiveArray is ULongArray -> primitiveArray.asList()
-                !primitiveArray.isPrimitiveArray -> throw IllegalArgumentException(
-                    "Can't create ColumnDataHolder from non primitive array $primitiveArray and type $type"
-                )
-
-                else -> throw IllegalArgumentException(
-                    "Can't create ColumnDataHolder from primitive array $primitiveArray and type $type"
-                )
-            } as List<T>
-
-            return ColumnDataHolderImpl(newList, distinct)
-        }
-    }
+    override fun iterator(): Iterator<T> = list.iterator()
 }
 
 private val BOOLEAN = typeOf<Boolean>()
@@ -133,3 +39,121 @@ private val UBYTE = typeOf<UByte>()
 private val USHORT = typeOf<UShort>()
 private val UINT = typeOf<UInt>()
 private val ULONG = typeOf<ULong>()
+
+/**
+ * Constructs [ColumnDataHolderImpl] using an [asList] wrapper around the [list].
+ */
+@Suppress("UNCHECKED_CAST")
+internal fun <T> ColumnDataHolder.Companion.of(
+    list: Collection<T>,
+    type: KType,
+    distinct: Lazy<Set<T>>? = null,
+): ColumnDataHolder<T> {
+    if (list is ColumnDataHolder<*>) return list as ColumnDataHolder<T>
+
+    try {
+        val newList = when (type) {
+            BOOLEAN -> (list as Collection<Boolean>).toBooleanArray().asList()
+            BYTE -> (list as Collection<Byte>).toByteArray().asList()
+            SHORT -> (list as Collection<Short>).toShortArray().asList()
+            INT -> (list as Collection<Int>).toIntArray().asList()
+            LONG -> (list as Collection<Long>).toLongArray().asList()
+            FLOAT -> (list as Collection<Float>).toFloatArray().asList()
+            DOUBLE -> (list as Collection<Double>).toDoubleArray().asList()
+            CHAR -> (list as Collection<Char>).toCharArray().asList()
+            UBYTE -> (list as Collection<UByte>).toUByteArray().asList()
+            USHORT -> (list as Collection<UShort>).toUShortArray().asList()
+            UINT -> (list as Collection<UInt>).toUIntArray().asList()
+            ULONG -> (list as Collection<ULong>).toULongArray().asList()
+            else -> list.asList()
+        } as List<T>
+
+        return ColumnDataHolderImpl(newList, distinct)
+    } catch (e: Exception) {
+        throw IllegalArgumentException("Can't create ColumnDataHolder from $list and type $type", e)
+    }
+}
+
+/**
+ * Constructs [ColumnDataHolderImpl] using an [asList] wrapper around the [array].
+ * If [array] is an array of primitives, it will be converted to a primitive array first before being
+ * wrapped with [asList].
+ */
+@Suppress("UNCHECKED_CAST")
+internal fun <T> ColumnDataHolder.Companion.of(
+    array: Array<T>,
+    type: KType,
+    distinct: Lazy<Set<T>>? = null,
+): ColumnDataHolder<T> {
+    try {
+        val list = when (type) {
+            BOOLEAN -> (array as Array<Boolean>).toBooleanArray().asList()
+            BYTE -> (array as Array<Byte>).toByteArray().asList()
+            SHORT -> (array as Array<Short>).toShortArray().asList()
+            INT -> (array as Array<Int>).toIntArray().asList()
+            LONG -> (array as Array<Long>).toLongArray().asList()
+            FLOAT -> (array as Array<Float>).toFloatArray().asList()
+            DOUBLE -> (array as Array<Double>).toDoubleArray().asList()
+            CHAR -> (array as Array<Char>).toCharArray().asList()
+            UBYTE -> (array as Array<UByte>).toUByteArray().asList()
+            USHORT -> (array as Array<UShort>).toUShortArray().asList()
+            UINT -> (array as Array<UInt>).toUIntArray().asList()
+            ULONG -> (array as Array<ULong>).toULongArray().asList()
+            else -> array.asList()
+        } as List<T>
+
+        return ColumnDataHolderImpl(list, distinct)
+    } catch (e: Exception) {
+        throw IllegalArgumentException(
+            "Can't create ColumnDataHolder from $array and mismatching type $type",
+            e,
+        )
+    }
+}
+
+/**
+ * Constructs [ColumnDataHolderImpl] using an [asList] wrapper around the [primitiveArray].
+ * [primitiveArray] must be an array of primitives, returns `null` if something goes wrong.
+ */
+@Suppress("UNCHECKED_CAST")
+internal fun <T> ColumnDataHolder.Companion.of(
+    primitiveArray: Any,
+    type: KType,
+    distinct: Lazy<Set<T>>? = null,
+): ColumnDataHolder<T> {
+    val newList = when {
+        type == BOOLEAN && primitiveArray is BooleanArray -> primitiveArray.asList()
+
+        type == BYTE && primitiveArray is ByteArray -> primitiveArray.asList()
+
+        type == SHORT && primitiveArray is ShortArray -> primitiveArray.asList()
+
+        type == INT && primitiveArray is IntArray -> primitiveArray.asList()
+
+        type == LONG && primitiveArray is LongArray -> primitiveArray.asList()
+
+        type == FLOAT && primitiveArray is FloatArray -> primitiveArray.asList()
+
+        type == DOUBLE && primitiveArray is DoubleArray -> primitiveArray.asList()
+
+        type == CHAR && primitiveArray is CharArray -> primitiveArray.asList()
+
+        type == UBYTE && primitiveArray is UByteArray -> primitiveArray.asList()
+
+        type == USHORT && primitiveArray is UShortArray -> primitiveArray.asList()
+
+        type == UINT && primitiveArray is UIntArray -> primitiveArray.asList()
+
+        type == ULONG && primitiveArray is ULongArray -> primitiveArray.asList()
+
+        !primitiveArray.isPrimitiveArray -> throw IllegalArgumentException(
+            "Can't create ColumnDataHolder from non primitive array $primitiveArray and type $type",
+        )
+
+        else -> throw IllegalArgumentException(
+            "Can't create ColumnDataHolder from primitive array $primitiveArray and type $type",
+        )
+    } as List<T>
+
+    return ColumnDataHolderImpl(newList, distinct)
+}