core/org.jetbrains.kotlinx.dataframe.impl

Package-level declarations

Types

internal open class ColumnDataCollector(initCapacity: Int = 0, val typeOf: (KClass<*>) -> KType) : DataCollectorBase<Any?>

ColumnNameGenerator

class ColumnNameGenerator(columnNames: List<String> = emptyList())

Counts

internal class Counts(val value: Any?, val count: Int)

DataCollector

interface DataCollector<T>

DataCollectorBase

internal abstract class DataCollectorBase<T>(initCapacity: Int) : DataCollector<T>

DataFrameImpl

internal open class DataFrameImpl<T>(cols: List<AnyCol>, val nrow: Int) : DataFrame<T> , AggregatableInternal<T>

DataFrameReceiver

internal open class DataFrameReceiver<T>(source: DataFrame<T>, unresolvedColumnsPolicy: UnresolvedColumnsPolicy) : DataFrameReceiverBase<T> , SingleColumn<DataRow<T>>

DataFrameReceiverBase

internal abstract class DataFrameReceiverBase<T>(val df: DataFrame<T>) : DataFrameImpl<T>

DataFrameSize

data class DataFrameSize(val ncol: Int, val nrow: Int)

DataRowImpl

internal open class DataRowImpl<T>(index: Int, df: DataFrame<T>) : DataRow<T>

DirectedAcyclicGraph

internal class DirectedAcyclicGraph<T>

Represents a directed acyclic graph (DAG) of generic type T.

GroupByImpl

internal class GroupByImpl<T, G>(val df: DataFrame<T>, val groups: FrameColumn<G>, val keyColumnsInGroups: ColumnsSelector<G, *>) : GroupBy<T, G> , AggregatableInternal<G>

Info

internal class Info(val df: AnyFrame)

IsBetterThan

internal typealias IsBetterThan<C> = C.(other: C) -> Boolean

Type alias for a function representing a reduction over a sequence of values trying to find the "best" value.

LazyMap

internal class LazyMap<K, out V>(actualMap: Map<K, Lazy<V>>) : Map<K, V>

Map that resolves values lazily.

TypedColumnDataCollector

internal class TypedColumnDataCollector<T>(initCapacity: Int = 0, val type: KType, val checkTypes: Boolean = true) : DataCollectorBase<T?>

UnifiedNumberTypeOptions

internal data class UnifiedNumberTypeOptions(val useBigNumbers: Boolean, val allowLongToDoubleConversion: Boolean)

Properties

CAMEL_DEFAULT_DELIMITERS_REGEX

internal val CAMEL_DEFAULT_DELIMITERS_REGEX: Regex

CAMEL_LETTERS_REGEX

internal val CAMEL_LETTERS_REGEX: Regex

canBeNaN

internal val KType.canBeNaN: Boolean

columnName

@PublishedApi

internal val KCallable<*>.columnName: String

@PublishedApi

internal val KFunction<*>.columnName: String

@PublishedApi

internal val KProperty<*>.columnName: String

Returns the column name for this callable. If the callable contains the ColumnName annotation, its ColumnName.name is returned. Otherwise, the name of the callable is returned with proper getter-trimming if it's a KFunction.

getterName

internal val KCallable<*>.getterName: String

internal val KFunction<*>.getterName: String

internal val KProperty<*>.getterName: String

Returns the getter name for this callable. The name of the callable is returned with proper getter-trimming if it's a KFunction.

isArray

internal val Any.isArray: Boolean

Returns true if this object is an array, either a primitive array like XArray or Array<>.

internal val KClass<*>.isArray: Boolean

Returns true if this class is an array, either a primitive array like XArray or Array<>.

internal val KType.isArray: Boolean

Returns true if this type is of an array, either a primitive array like XArray or Array<>.

isJavaRecord

internal val KClass<*>.isJavaRecord: Boolean

Returns true if this class is a Java record.

isNothing

internal val KType.isNothing: Boolean

isPrimitiveArray

internal val Any.isPrimitiveArray: Boolean

Returns true if this object is a primitive array like XArray.

internal val KClass<*>.isPrimitiveArray: Boolean

Returns true if this class is a primitive array class like XArray.

internal val KType.isPrimitiveArray: Boolean

Returns true if this type is of a primitive array like XArray.

nothingType

internal val nothingType: KType

nullableNothingType

internal val nullableNothingType: KType

owner

internal val <T> DataRow<T>.owner: DataFrame<T>

primitiveNumberTypes

@PublishedApi

internal val primitiveNumberTypes: Set<KType>

recordComponentNames

internal val KClass<*>.recordComponentNames: Set<String>

UNNAMED_COLUMN_PREFIX

internal const val UNNAMED_COLUMN_PREFIX: String

Functions

aggregateGroupBy

internal fun <T, G, R> aggregateGroupBy(df: DataFrame<T>, selector: ColumnSelector<T, DataFrame<G>?>, removeColumns: Boolean, body: AggregateGroupedBody<G, R>): DataFrame<T>

and

internal infix fun <T> Predicate<T>?.and(other: Predicate<T>): Predicate<T>

anyNull

@PublishedApi

internal fun <T> Iterable<T>.anyNull(): Boolean

asArrayAsListOrNull

internal fun Any.asArrayAsListOrNull(): List<*>?

If this is an array of any kind, the function returns it as a list of values, else it returns null.

asList

fun <T> Iterable<T>.asList(): List<T>

asNullable

internal fun <T> T.asNullable(): T?

bestBy

internal inline fun <C> Sequence<C>.bestBy(isBetterThan: IsBetterThan<C>): C

bestByOrElse

internal inline fun <C : R, R> Sequence<C>.bestByOrElse(isBetterThan: IsBetterThan<C>, ifEmpty: () -> R): R

bestByOrNull

internal inline fun <C> Sequence<C>.bestByOrNull(isBetterThan: IsBetterThan<C>): C?

bestNotNaBy

internal inline fun <C : Any> Sequence<C?>.bestNotNaBy(isBetterThan: IsBetterThan<C>): C

bestNotNaByOrElse

internal inline fun <C : R, R> Sequence<C?>.bestNotNaByOrElse(isBetterThan: IsBetterThan<C & Any>, ifEmptyOrAllNa: () -> R): R

bestNotNaByOrNull

internal inline fun <C : Any> Sequence<C?>.bestNotNaByOrNull(isBetterThan: IsBetterThan<C>): C?

bestNotNullBy

internal inline fun <C : Any> Sequence<C?>.bestNotNullBy(isBetterThan: IsBetterThan<C>): C

bestNotNullByOrElse

internal inline fun <C : R, R> Sequence<C?>.bestNotNullByOrElse(isBetterThan: IsBetterThan<C & Any>, ifEmptyOrAllNull: () -> R): R

bestNotNullByOrNull

internal inline fun <C : Any> Sequence<C?>.bestNotNullByOrNull(isBetterThan: IsBetterThan<C>): C?

between

internal fun <T : Comparable<T>> T.between(left: T, right: T, includeBoundaries: Boolean = true): Boolean

buildDag

internal fun <T> buildDag(builder: DirectedAcyclicGraph.Builder<T>.() -> Unit): DirectedAcyclicGraph<T>

Builds a new DirectedAcyclicGraph using the provided builder function.

cast

internal inline fun <reified T : Any> Int.cast(): T

catchSilent

internal fun <T> catchSilent(body: () -> T): T?

classes

internal fun Iterable<Any?>.classes(): Set<KClass<*>>

Returns a set containing the KClass of each element in the iterable.

commonParent

internal fun commonParent(classes: Iterable<KClass<*>>): KClass<*>?

internal fun commonParent(vararg classes: KClass<*>): KClass<*>?

commonParents

internal fun commonParents(classes: Iterable<KClass<*>>): List<KClass<*>>

internal fun commonParents(vararg classes: KClass<*>): List<KClass<*>>

commonType

@JvmName(name = "commonTypeOverload")

internal fun commonType(types: Iterable<KType?>, useStar: Boolean = true): KType

commonType

internal fun Iterable<KType?>.commonType(useStar: Boolean = true): KType

Returns the common supertype of the given types.

internal fun Iterable<KClass<*>>.commonType(nullable: Boolean, upperBound: KType? = null): KType

commonTypeListifyValues

internal fun Iterable<KType>.commonTypeListifyValues(useStar: Boolean = true): KType

Returns the common type of the given types including "listify" behaviour. Values and nulls will be wrapped in a list if they appear among other lists. For example: [Int, Nothing?, List<Int>] will become List<Int> instead of Any?. If there is another collection in there, it will become Any? anyway.

convert

internal fun <T : Any> convert(src: Int, tartypeOf: KClass<T>): T

convertToUnifiedNumberType

@JvmName(name = "convertNullableIterableToUnifiedNumberType")

internal fun Iterable<Number?>.convertToUnifiedNumberType(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT, commonNumberType: KType? = null): Iterable<Number?>

@JvmName(name = "convertIterableToUnifiedNumberType")

internal fun Iterable<Number>.convertToUnifiedNumberType(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT, commonNumberType: KType? = null): Iterable<Number>

@JvmName(name = "convertNullableSequenceToUnifiedNumberType")

internal fun Sequence<Number?>.convertToUnifiedNumberType(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT, commonNumberType: KType? = null): Sequence<Number?>

@JvmName(name = "convertSequenceToUnifiedNumberType")

internal fun Sequence<Number>.convertToUnifiedNumberType(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT, commonNumberType: KType? = null): Sequence<Number>

Converts the elements of the given iterable of numbers into a common numeric type based on complexity. The common numeric type is determined using the provided commonNumberType parameter or calculated with Iterable.unifiedNumberTypeOrNull from the iterable's elements if not explicitly specified.

createDataCollector

internal fun createDataCollector(initCapacity: Int = 0): ColumnDataCollector

internal fun createDataCollector(initCapacity: Int = 0, typeOf: (KClass<*>) -> KType): ColumnDataCollector

internal fun <T> createDataCollector(initCapacity: Int = 0, type: KType): TypedColumnDataCollector<T>

createStarProjectedType

internal fun createStarProjectedType(klass: KClass<*>, nullable: Boolean): KType

createStarProjectedType

@JvmName(name = "createStarProjectedTypeExt")

internal fun KClass<*>.createStarProjectedType(nullable: Boolean): KType

createType

internal fun Iterable<KClass<*>>.createType(nullable: Boolean, upperBound: KType? = null): KType

createTypeUsing

internal inline fun <reified T> KClass<*>.createTypeUsing(): KType

createTypeWithArgument

internal inline fun <reified T> createTypeWithArgument(typeArgument: KType? = null): KType

createTypeWithArgument

internal fun KClass<*>.createTypeWithArgument(argument: KType? = null, nullable: Boolean = false): KType

dagOf

internal fun <T> dagOf(vararg edges: Pair<T, T>): DirectedAcyclicGraph<T>

Builds a new DirectedAcyclicGraph using the provided edges.

emptyPath

@PublishedApi

internal fun emptyPath(): ColumnPath

equalsByElement

internal fun <T> Iterable<T>.equalsByElement(other: Iterable<T>): Boolean

getColumnPaths

internal fun <T, C> DataFrame<T>.getColumnPaths(unresolvedColumnsPolicy: UnresolvedColumnsPolicy, selector: ColumnsSelector<T, C>): List<ColumnPath>

getColumnsImpl

internal fun <T, C> DataFrame<T>.getColumnsImpl(unresolvedColumnsPolicy: UnresolvedColumnsPolicy, selector: ColumnsSelector<T, C>): List<DataColumn<C>>

getColumnsWithPaths

internal fun <T, C> DataFrame<T>.getColumnsWithPaths(unresolvedColumnsPolicy: UnresolvedColumnsPolicy, selector: ColumnsSelector<T, C>): List<ColumnWithPath<C>>

getListType

@PublishedApi

internal fun getListType(valueType: KType): KType

getTrueIndices

internal fun BooleanArray.getTrueIndices(): List<Int>

internal fun List<Boolean>.getTrueIndices(): List<Int>

getUnifiedNumberClassGraph

internal fun getUnifiedNumberClassGraph(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT): DirectedAcyclicGraph<KClass<*>>

Number type graph, structured in terms of number complexity. A number can always be expressed losslessly by a number of a more complex type (any of its parents).

getUnifiedNumberClassOrNull

internal fun getUnifiedNumberClassOrNull(first: KClass<*>?, second: KClass<*>, options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT): KClass<*>?

Determines the nearest common numeric type, in terms of complexity, between two given classes/types.

getUnifiedNumberTypeGraph

internal fun getUnifiedNumberTypeGraph(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT): DirectedAcyclicGraph<KType>

Number type graph, structured in terms of number complexity. A number can always be expressed losslessly by a number of a more complex type (any of its parents).

getUnifiedNumberTypeOrNull

internal fun getUnifiedNumberTypeOrNull(first: KType?, second: KType, options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT): KType?

Determines the nearest common numeric type, in terms of complexity, between two given classes/types.

getValuesType

@PublishedApi

internal fun <T> getValuesType(values: List<T>, type: KType, infer: Infer): KType

guessValueType

@PublishedApi

internal fun guessValueType(values: Sequence<Any?>, upperBound: KType? = null, listifyValues: Boolean = false, allColsMakesRow: Boolean = false, unifyNumbers: Boolean = false): KType

Returns the guessed value type of the given values sequence.

headPlusArray

@PublishedApi

internal inline fun <reified C> headPlusArray(head: C, cols: Array<out C>): Array<C>

@PublishedApi

internal fun headPlusArray(head: Boolean, cols: BooleanArray): BooleanArray

@PublishedApi

internal fun headPlusArray(head: Byte, cols: ByteArray): ByteArray

@PublishedApi

internal fun headPlusArray(head: Char, cols: CharArray): CharArray

@PublishedApi

internal fun headPlusArray(head: Double, cols: DoubleArray): DoubleArray

@PublishedApi

internal fun headPlusArray(head: Float, cols: FloatArray): FloatArray

@PublishedApi

internal fun headPlusArray(head: Int, cols: IntArray): IntArray

@PublishedApi

internal fun headPlusArray(head: Long, cols: LongArray): LongArray

@PublishedApi

internal fun headPlusArray(head: Short, cols: ShortArray): ShortArray

headPlusIterable

@PublishedApi

internal inline fun <reified C> headPlusIterable(head: C, cols: Iterable<C>): Iterable<C>

indexOfBestBy

internal inline fun <C> Sequence<C>.indexOfBestBy(isBetterThan: IsBetterThan<C>): Int

Returns the index of the first element in this sequence that is better than all previous elements.

indexOfBestNotNaBy

internal inline fun <C> Sequence<C>.indexOfBestNotNaBy(isBetterThan: IsBetterThan<C & Any>): Int

Returns the index of the first element in this sequence that is not NA (null or NaN) and is better than all previous elements.

indexOfBestNotNullBy

internal inline fun <C> Sequence<C>.indexOfBestNotNullBy(isBetterThan: IsBetterThan<C & Any>): Int

Returns the index of the first element in this sequence that is not null and is better than all previous elements.

inheritanceChain

internal fun inheritanceChain(subClass: KClass<*>, superClass: KClass<*>): List<Pair<KClass<*>, KType>>

isBigNumber

internal fun Any.isBigNumber(): Boolean

isGetterLike

internal fun KCallable<*>.isGetterLike(): Boolean

internal fun KFunction<*>.isGetterLike(): Boolean

internal fun KProperty<*>.isGetterLike(): Boolean

Returns true if this callable is a getter-like function.

isIntraComparable

internal fun KType.isIntraComparable(): Boolean

Checks whether this KType adheres to T : Comparable<T & Any>?, aka, it is mutually comparable with itself.

isMixedNumber

@PublishedApi

internal fun KType.isMixedNumber(): Boolean

Returns true only when this type is exactly Number or Number?.

isPrimitiveNumber

internal fun Number.isPrimitiveNumber(): Boolean

@PublishedApi

internal fun KType.isPrimitiveNumber(): Boolean

Returns true when this type is one of the following (nullable) types: Byte, Short, Int, Long, Float, or Double.

isPrimitiveOrMixedNumber

@PublishedApi

internal fun KType.isPrimitiveOrMixedNumber(): Boolean

Returns true when this type is one of the following (nullable) types: Byte, Short, Int, Long, Float, Double, or Number.

isSubtypeWithNullabilityOf

internal fun KType.isSubtypeWithNullabilityOf(type: KType): Boolean

javaDurationCanParse

internal fun javaDurationCanParse(value: String): Boolean

Checks if the string can be parsed as a java duration without throwing an exception.

last

internal fun <T> List<T>.last(count: Int): List<T>

lazyMapOf

internal fun <K, V> lazyMapOf(vararg entries: Pair<K, () -> V>): LazyMap<K, V>

Creates a Map that resolves values lazily.

namedValues

internal fun AnyRow.namedValues(): Sequence<NamedValue>

nameGenerator

internal fun nameGenerator(vararg usedNames: String): ColumnNameGenerator

nameGenerator

internal fun AnyFrame.nameGenerator(): ColumnNameGenerator

nothingType

internal fun nothingType(nullable: Boolean): KType

projectDownTo

internal fun KType.projectDownTo(subClass: KClass<*>): KType

projectTo

internal fun KType.projectTo(targetClass: KClass<*>): KType

projectUpTo

internal fun KType.projectUpTo(superClass: KClass<*>): KType

removeAt

internal fun <T> List<T>.removeAt(index: Int): List<T>

render

internal fun DataFrame<ValueCount>.render(): List<Counts>

renderSchema

internal fun renderSchema(df: AnyFrame): String

internal fun renderSchema(schema: DataFrameSchema): String

renderShort

internal fun AnyCol.renderShort(): String

renderType

internal fun renderType(type: KType?): String

internal fun renderType(column: AnyCol): String

internal fun renderType(column: ColumnSchema): String

replace

internal fun KType.replace(substitution: Map<KTypeParameter, KType?>): KType

replaceGenericTypeParametersWithUpperbound

@PublishedApi

internal fun KType.replaceGenericTypeParametersWithUpperbound(): KType

Changes generic type parameters to its upperbound, like List<T> -> List<Any?> and Comparable<T> -> Comparable<Nothing>. Works recursively as well.

resolve

internal fun resolve(actualType: KType, declaredType: KType): Map<KTypeParameter, KType?>

rollingHash

internal fun <T> Iterable<T>.rollingHash(): Int

scale

internal fun Double.scale(): Int

internal fun Float.scale(): Int

internal fun Number.scale(): Int

internal fun <T : Number> DataColumn<T?>.scale(): Int

splitByIndices

@JvmName(name = "splitByIndicesOverload")

internal fun <T> splitByIndices(list: List<T>, startIndices: Sequence<Int>): Sequence<List<T>>

splitByIndices

internal fun <T> List<T>.splitByIndices(startIndices: Sequence<Int>): Sequence<List<T>>

internal fun <T> DataFrame<T>.splitByIndices(startIndices: Sequence<Int>): Sequence<DataFrame<T>>

throwAndSuggestIfNull

@PublishedApi

internal fun <T> T?.throwAndSuggestIfNull(operation: String): T

throwAndSuggestWhenNoElements

@PublishedApi

internal fun throwAndSuggestWhenNoElements(operation: String): Nothing

toCamelCaseByDelimiters

fun String.toCamelCaseByDelimiters(delimiters: Regex = CAMEL_DEFAULT_DELIMITERS_REGEX, numberSeparator: String = "_"): String

Converts a string into lowerCamelCase using delimiters.

toIterable

internal fun <T> T.toIterable(getNext: (T) -> T?): Iterable<T>

toSnakeCase

internal fun String.toSnakeCase(): String

truncate

internal fun String.truncate(limit: Int): RenderedContent

types

internal fun Iterable<Any?>.types(): Set<KType>

Returns a set of KType objects representing the star-projected types of the runtime classes of all unique elements in the iterable.

unifiedNumberClassOrNull

internal fun Iterable<KClass<*>>.unifiedNumberClassOrNull(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT): KClass<*>?

Determines the nearest common numeric type, in terms of complexity, all types in this.

unifiedNumberTypeOrNull

internal fun Iterable<KType>.unifiedNumberTypeOrNull(options: UnifiedNumberTypeOptions = UnifiedNumberTypeOptions.DEFAULT): KType?

Determines the nearest common numeric type, in terms of complexity, all types in this.

valuesImpl

internal fun <T, C> DataFrame<T>.valuesImpl(byRow: Boolean, columns: ColumnsSelector<T, C>): Sequence<C>

withMostSuperclasses

internal fun Iterable<KClass<*>>.withMostSuperclasses(): KClass<*>?