Wrapper

class Wrapper<T>(val source: ValueColumn<T>) : ValueColumn<T> , ValueColumnInternal<T>

Tiny wrapper for ValueColumns that are not ValueColumnImpl, which can occur in case a user implements the ValueColumn interface.

Constructors

Link copied to clipboard
constructor(source: ValueColumn<T>)

Properties

Link copied to clipboard
internal val AnyCol.canHaveNA: Boolean

Is true when this column can have NA values.

Link copied to clipboard
internal val AnyCol.canHaveNaN: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
internal val AnyBaseCol.isEmpty: Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
internal val AnyBaseCol.size: Int
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
Link copied to clipboard
fun DataColumn<*>.addId(columnName: String = "id"): DataFrame<*>
Link copied to clipboard
internal fun <T> BaseColumn<T>.addParent(parent: ColumnGroup<*>): DataColumn<T>
Link copied to clipboard
Link copied to clipboard
internal fun <T> BaseColumn<T>.addPath(): ColumnWithPath<T>
internal fun <T> BaseColumn<T>.addPath(path: ColumnPath): ColumnWithPath<T>
Link copied to clipboard
fun <T> DataColumn<T>.all(predicate: Predicate<T>): Boolean

Returns true if all values match the given predicate or values is empty.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.allAfterInternal(crossinline colByPredicate: ColumnFilter<*>): ColumnSet<*>

Returns a new ColumnSet containing all columns after the first column that matches the given predicate.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.allBeforeInternal(crossinline colByPredicate: ColumnFilter<*>): ColumnSet<*>

Returns a new ColumnSet containing all columns before the first column that satisfies the given predicate.

Link copied to clipboard

Returns a new ColumnSet that contains all columns from inside the receiver column group except those specified in the "other" ColumnsResolver.

Link copied to clipboard

If this is a SingleColumn containing a single ColumnGroup (like SingleColumn<AnyRow> or ColumnsSelectionDsl), it returns a (transformable) ColumnSet containing the children of this ColumnGroup, else it simply returns a (transformable) ColumnSet from this (like when this is a ColumnSet).

Link copied to clipboard
internal inline fun ColumnsResolver<*>.allFromInternal(crossinline colByPredicate: ColumnFilter<*>): ColumnSet<*>

Returns a column set containing all columns from the internal column set that satisfy the given predicate.

Link copied to clipboard

Returns true if all values are null or values is empty.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.allUpToInternal(crossinline colByPredicate: ColumnFilter<*>): ColumnSet<*>

Returns a ColumnSet containing all columns up to (and including) the first column that satisfies the given predicate.

Link copied to clipboard
fun <T> DataColumn<T>.any(predicate: Predicate<T>): Boolean

Returns true if at least one element in this DataColumn satisfies the given predicate.

Link copied to clipboard
Link copied to clipboard
@JvmName(name = "asColumnGroupUntyped")
fun DataColumn<*>.asColumnGroup(): ColumnGroup<*>
@JvmName(name = "asGroupedT")
fun <T> DataColumn<DataRow<T>>.asColumnGroup(): ColumnGroup<T>

@JvmName(name = "asColumnGroupDataRow")
fun <C> SingleColumn<DataRow<C>>.asColumnGroup(): SingleColumn<DataRow<C>>

Creates a ColumnAccessor<DataRow<C>> from this. This is especially useful when you want to use ColumnGroup functions in the ColumnsSelectionDsl but your column type is not recognized as a ColumnGroup. If you're not sure whether a column is recognized as ColumnGroup or not, you can always call asColumnGroup and it will return the same type if it is already a ColumnGroup.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@JvmName(name = "asFrameColumnUntyped")
fun DataColumn<*>.asFrameColumn(): FrameColumn<*>
Link copied to clipboard

Returns an Iterable over the values of this DataColumn.

Link copied to clipboard
@JvmName(name = "asNumberAnyNullable")
fun DataColumn<Any?>.asNumbers(): ValueColumn<Number?>
@JvmName(name = "asNumberAny")
fun DataColumn<Any>.asNumbers(): ValueColumn<Number>
@JvmName(name = "asNumbersAnyNullable")
fun SingleColumn<Any?>.asNumbers(): SingleColumn<Number?>
@JvmName(name = "asNumbersAny")
fun SingleColumn<Any>.asNumbers(): SingleColumn<Number>
Link copied to clipboard

Returns a Sequence over the values of this DataColumn.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
internal fun <T> AnyCol.asValues(): ValueColumn<T>
Link copied to clipboard
fun <T : Comparable<T>> DataColumn<T>.between(left: T, right: T, includeBoundaries: Boolean = true): DataColumn<Boolean>

Returns a DataColumn of Boolean values indicating whether each element in this column lies between left and right.

Link copied to clipboard
Link copied to clipboard
open override fun changeType(type: KType): ValueColumn<T>

Changes column type. Doesn't change column values.

Link copied to clipboard
internal fun <T> BaseColumn<T>.checkEquals(other: Any?): Boolean
Link copied to clipboard

Groups consecutive values of this DataColumn into lists of at most size elements.

Splits a DataColumn of DataRow into a FrameColumn of sub-dataframes with up to size rows in each chunk.

Link copied to clipboard

Returns all columns inside this ColumnsResolver at any depth if they satisfy the given predicate.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.colsInternal(crossinline predicate: ColumnFilter<*>): TransformableColumnSet<*>

If this ColumnsResolver is a SingleColumn, it returns a new ColumnSet containing the columns inside of this SingleColumn that match the given predicate.

Link copied to clipboard
inline fun <reified C> SingleColumn<DataRow<*>>.colsOf(noinline filter: (ColumnWithPath<C>) -> Boolean = { true }): ColumnSet<C>
fun <C> SingleColumn<DataRow<*>>.colsOf(type: KType, filter: (ColumnWithPath<C>) -> Boolean = { true }): ColumnSet<C>

Returns a ColumnSet of columns from this that are a subtype of the given type C, optionally filtered by filter.

Link copied to clipboard
internal inline fun <C> ColumnsResolver<*>.colsOfInternal(type: KType, crossinline filter: ColumnFilter<C>): TransformableColumnSet<C>

If this ColumnsResolver is a SingleColumn, it returns a new ColumnSet containing the columns inside of this SingleColumn that match the given filter and are the given type.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.columnGroupsInternal(crossinline filter: (ColumnGroup<*>) -> Boolean): ColumnSet<DataRow<*>>

Returns a ColumnSet containing the column groups that satisfy the given filter.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.columnsOfKindInternal(kinds: Set<ColumnKind>, crossinline filter: ColumnFilter<*>): TransformableColumnSet<*>

Returns a TransformableColumnSet containing the columns of given kind(s) that satisfy the given filter.

Link copied to clipboard

Returns a List containing the elements of every Collection stored in this column.

Returns a DataFrame containing the rows from every DataFrame stored in this column.

fun <T> DataColumn<T>.concat(vararg other: DataColumn<T>): DataColumn<T>

Returns a DataColumn containing the values of this column followed by the values of other.

Link copied to clipboard
open operator override fun contains(value: T): Boolean
Link copied to clipboard
inline fun <reified C> DataColumn<*>.convertTo(): DataColumn<C>

Converts values in this column to the specified type C.

fun DataColumn<*>.convertTo(newType: KType): DataColumn<*>

Converts values in this column to the specified type.

inline fun <reified C> DataColumn<String?>.convertTo(parserOptions: ParserOptions? = null): DataColumn<C>

Converts values in this String column to the specified type C.

fun DataColumn<String?>.convertTo(newType: KType, parserOptions: ParserOptions? = null): DataColumn<*>

Converts values in this String column to the specified type.

Link copied to clipboard

Converts values in this column to BigDecimal. Preserves null values.

@JvmName(name = "convertToBigDecimalFromT")
fun <T : Any> DataColumn<T>.convertToBigDecimal(): DataColumn<BigDecimal>

Converts values in this column to BigDecimal.

Link copied to clipboard

Converts values in this column to BigInteger. Preserves null values.

@JvmName(name = "convertToBigIntegerFromT")
fun <T : Any> DataColumn<T>.convertToBigInteger(): DataColumn<BigInteger>

Converts values in this column to BigInteger.

Link copied to clipboard

Converts values in this column to Boolean. Preserves null values.

@JvmName(name = "convertToBooleanFromT")
fun <T : Any> DataColumn<T>.convertToBoolean(): DataColumn<Boolean>

Converts values in this column to Boolean.

Link copied to clipboard

Converts values in this column to Byte. Preserves null values.

@JvmName(name = "convertToByteFromT")
fun <T : Any> DataColumn<T>.convertToByte(): DataColumn<Byte>

Converts values in this column to Byte.

Link copied to clipboard
@JvmName(name = "convertToDateTimeComponentsFromStringNullablePattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String?>.convertToDateTimeComponents(pattern: String): DataColumn<DateTimeComponents?>
@JvmName(name = "convertToDateTimeComponentsFromStringNullable")
fun DataColumn<String?>.convertToDateTimeComponents(format: DateTimeFormat<DateTimeComponents>? = null): DataColumn<DateTimeComponents?>

Converts values in this String column to DateTimeComponents. Preserves null values.

@JvmName(name = "convertToDateTimeComponentsFromStringPattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String>.convertToDateTimeComponents(pattern: String): DataColumn<DateTimeComponents>
@JvmName(name = "convertToDateTimeComponentsFromString")
fun DataColumn<String>.convertToDateTimeComponents(format: DateTimeFormat<DateTimeComponents>? = null): DataColumn<DateTimeComponents>

Converts values in this String column to DateTimeComponents.

Link copied to clipboard
@JvmName(name = "convertToDeprecatedInstantFromStringNullable")
fun DataColumn<String?>.convertToDeprecatedInstant(): DataColumn<Instant?>

Converts values in this String column to the deprecated kotlinx.datetime.Instant. Preserves null values.

Converts values in this String column to the deprecated kotlinx.datetime.Instant.

Link copied to clipboard

Converts values in this column to Double. Preserves null values.

@JvmName(name = "convertToDoubleFromT")
fun <T : Any> DataColumn<T>.convertToDouble(): DataColumn<Double>

Converts values in this column to Double.

@JvmName(name = "convertToDoubleFromStringNullable")
fun DataColumn<String?>.convertToDouble(locale: Locale? = null): DataColumn<Double?>
@JvmName(name = "convertToDoubleFromString")
fun DataColumn<String>.convertToDouble(locale: Locale? = null): DataColumn<Double>
@JvmName(name = "convertToDoubleFromStringNullable")
fun DataColumn<String?>.convertToDouble(locale: Locale? = null, nullStrings: Set<String>?, useFastDoubleParser: Boolean?): DataColumn<Double?>
@JvmName(name = "convertToDoubleFromString")
fun DataColumn<String>.convertToDouble(locale: Locale? = null, nullStrings: Set<String>?, useFastDoubleParser: Boolean?): DataColumn<Double>

Converts values in this String column to Double considering locale (number format).

Link copied to clipboard

Converts values in this column to Duration. Preserves null values.

@JvmName(name = "convertToDurationFromT")
fun <T : Any> DataColumn<T>.convertToDuration(): DataColumn<Duration>

Converts values in this column to Duration.

Link copied to clipboard

Converts values in this column to Float. Preserves null values.

@JvmName(name = "convertToFloatFromT")
fun <T : Any> DataColumn<T>.convertToFloat(): DataColumn<Float>

Converts values in this column to Float.

Link copied to clipboard
@JvmName(name = "convertToInstantFromStringNullable")
fun DataColumn<String?>.convertToInstant(): DataColumn<Instant?>

Deprecated:

Link copied to clipboard

Converts values in this column to Int. Preserves null values.

@JvmName(name = "convertToIntFromT")
fun <T : Any> DataColumn<T>.convertToInt(): DataColumn<Int>

Converts values in this column to Int.

Link copied to clipboard

Converts values in this column to JavaDuration. Preserves null values.

@JvmName(name = "convertToJavaDurationFromT")
fun <T : Any> DataColumn<T>.convertToJavaDuration(): DataColumn<Duration>

Converts values in this column to JavaDuration.

Link copied to clipboard

Converts values in this column to JavaInstant. Preserves null values.

@JvmName(name = "convertToJavaInstantFromT")
fun <T : Any> DataColumn<T>.convertToJavaInstant(): DataColumn<Instant>

Converts values in this column to JavaInstant.

Link copied to clipboard

Converts values in this column to JavaLocalDate. Preserves null values.

@JvmName(name = "convertToJavaLocalDateFromT")
fun <T : Any> DataColumn<T>.convertToJavaLocalDate(): DataColumn<LocalDate>

Converts values in this column to JavaLocalDate.

@JvmName(name = "convertToJavaLocalDateFromStringNullable")
fun DataColumn<String?>.convertToJavaLocalDate(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataColumn<LocalDate?>
@JvmName(name = "convertToJavaLocalDateFromStringNullablePattern")
fun DataColumn<String?>.convertToJavaLocalDate(pattern: String, locale: Locale? = null): DataColumn<LocalDate?>

Converts values in this nullable String column to JavaLocalDate. Preserves null values.

@JvmName(name = "convertToJavaLocalDateFromString")
fun DataColumn<String>.convertToJavaLocalDate(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataColumn<LocalDate>
@JvmName(name = "convertToJavaLocalDateFromStringPattern")
fun DataColumn<String>.convertToJavaLocalDate(pattern: String, locale: Locale? = null): DataColumn<LocalDate>

Converts values in this String column to JavaLocalDate.

Link copied to clipboard

Converts values in this column to JavaLocalDateTime. Preserves null values.

@JvmName(name = "convertToJavaLocalDateTimeFromT")
fun <T : Any> DataColumn<T>.convertToJavaLocalDateTime(): DataColumn<LocalDateTime>

Converts values in this column to JavaLocalDateTime.

@JvmName(name = "convertToJavaLocalDateTimeFromStringNullable")
fun DataColumn<String?>.convertToJavaLocalDateTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataColumn<LocalDateTime?>
@JvmName(name = "convertToJavaLocalDateTimeFromStringNullablePattern")
fun DataColumn<String?>.convertToJavaLocalDateTime(pattern: String, locale: Locale? = null): DataColumn<LocalDateTime?>

Converts values in this nullable String column to JavaLocalDateTime. Preserves null values.

@JvmName(name = "convertToJavaLocalDateTimeFromString")
fun DataColumn<String>.convertToJavaLocalDateTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataColumn<LocalDateTime>
@JvmName(name = "convertToJavaLocalDateTimeFromStringPattern")
fun DataColumn<String>.convertToJavaLocalDateTime(pattern: String, locale: Locale? = null): DataColumn<LocalDateTime>

Converts values in this String column to JavaLocalDateTime.

Link copied to clipboard

Converts values in this column to JavaLocalTime. Preserves null values.

@JvmName(name = "convertToJavaLocalTimeFromT")
fun <T : Any> DataColumn<T>.convertToJavaLocalTime(): DataColumn<LocalTime>

Converts values in this column to JavaLocalTime.

@JvmName(name = "convertToJavaLocalTimeFromStringNullable")
fun DataColumn<String?>.convertToJavaLocalTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataColumn<LocalTime?>
@JvmName(name = "convertToJavaLocalTimeFromStringNullablePattern")
fun DataColumn<String?>.convertToJavaLocalTime(pattern: String, locale: Locale? = null): DataColumn<LocalTime?>

Converts values in this nullable String column to JavaLocalTime. Preserves null values.

@JvmName(name = "convertToJavaLocalTimeFromString")
fun DataColumn<String>.convertToJavaLocalTime(formatter: DateTimeFormatter? = null, locale: Locale? = null): DataColumn<LocalTime>
@JvmName(name = "convertToJavaLocalTimeFromStringPattern")
fun DataColumn<String>.convertToJavaLocalTime(pattern: String, locale: Locale? = null): DataColumn<LocalTime>

Converts values in this String column to JavaLocalTime.

Link copied to clipboard
fun <T : Any> DataColumn<T?>.convertToLocalDate(): DataColumn<LocalDate?>

Converts values in this column to LocalDate. Preserves null values.

@JvmName(name = "convertToLocalDateFromT")
fun <T : Any> DataColumn<T>.convertToLocalDate(): DataColumn<LocalDate>

Converts values in this column to LocalDate.

@JvmName(name = "convertToLocalDateFromDateTimeComponentsNullable")
fun DataColumn<DateTimeComponents?>.convertToLocalDate(): DataColumn<LocalDate?>

Converts values in this DateTimeComponents column to LocalDate. Preserves null values.

@JvmName(name = "convertToLocalDateFromDateTimeComponents")
fun DataColumn<DateTimeComponents>.convertToLocalDate(): DataColumn<LocalDate>

Converts values in this DateTimeComponents column to LocalDate.

@JvmName(name = "convertToLocalDateFromIntNullable")
fun DataColumn<Int?>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate?>

Converts values in this Int column to LocalDate. Preserves null values.

@JvmName(name = "convertToLocalDateFromInt")
fun DataColumn<Int>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate>

Converts values in this Int column to LocalDate.

fun DataColumn<Long?>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate?>

Converts values in this Long column to LocalDate. Preserves null values.

@JvmName(name = "convertToLocalDateFromLong")
fun DataColumn<Long>.convertToLocalDate(zone: TimeZone = defaultTimeZone): DataColumn<LocalDate>

Converts values in this Long column to LocalDate.

@JvmName(name = "convertToLocalDateFromStringNullablePattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String?>.convertToLocalDate(pattern: String): DataColumn<LocalDate?>
@JvmName(name = "convertToLocalDateFromStringNullable")
fun DataColumn<String?>.convertToLocalDate(format: DateTimeFormat<LocalDate>? = null): DataColumn<LocalDate?>

Converts values in this String column to LocalDate. Preserves null values.

@JvmName(name = "convertToLocalDateFromStringPattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String>.convertToLocalDate(pattern: String): DataColumn<LocalDate>
@JvmName(name = "convertToLocalDateFromString")
fun DataColumn<String>.convertToLocalDate(format: DateTimeFormat<LocalDate>? = null): DataColumn<LocalDate>

Converts values in this String column to LocalDate.

@JvmName(name = "convertToLocalDateFromStringNullable")
fun DataColumn<String?>.convertToLocalDate(pattern: String? = null, locale: Locale? = null): DataColumn<LocalDate?>
@JvmName(name = "convertToLocalDateFromString")
fun DataColumn<String>.convertToLocalDate(pattern: String? = null, locale: Locale? = null): DataColumn<LocalDate>
Link copied to clipboard
fun <T : Any> DataColumn<T?>.convertToLocalDateTime(): DataColumn<LocalDateTime?>

Converts values in this column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromT")
fun <T : Any> DataColumn<T>.convertToLocalDateTime(): DataColumn<LocalDateTime>

Converts values in this column to LocalDateTime.

@JvmName(name = "convertToLocalDateTimeFromDateTimeComponentsNullable")
fun DataColumn<DateTimeComponents?>.convertToLocalDateTime(): DataColumn<LocalDateTime?>

Converts values in this DateTimeComponents column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromDateTimeComponents")
fun DataColumn<DateTimeComponents>.convertToLocalDateTime(): DataColumn<LocalDateTime>

Converts values in this DateTimeComponents column to LocalDateTime.

@JvmName(name = "convertToLocalDateTimeFromIntNullable")
fun DataColumn<Int?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

Converts values in this Int column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromInt")
fun DataColumn<Int>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this Int column to LocalDateTime.

fun DataColumn<Long?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

Converts values in this Long column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromLong")
fun DataColumn<Long>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this Long column to LocalDateTime.

@JvmName(name = "convertToLocalDateTimeFromStringNullablePattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String?>.convertToLocalDateTime(pattern: String): DataColumn<LocalDateTime?>
@JvmName(name = "convertToLocalDateTimeFromStringNullable")
fun DataColumn<String?>.convertToLocalDateTime(format: DateTimeFormat<LocalDateTime>? = null): DataColumn<LocalDateTime?>

Converts values in this String column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromStringPattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String>.convertToLocalDateTime(pattern: String): DataColumn<LocalDateTime>
@JvmName(name = "convertToLocalDateTimeFromString")
fun DataColumn<String>.convertToLocalDateTime(format: DateTimeFormat<LocalDateTime>? = null): DataColumn<LocalDateTime>

Converts values in this String column to LocalDateTime.

@JvmName(name = "convertToLocalDateTimeFromStdlibInstantNullable")
fun DataColumn<Instant?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

Converts values in this kotlin.time.Instant column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromStdlibInstant")
fun DataColumn<Instant>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this kotlin.time.Instant column to LocalDateTime.

@JvmName(name = "convertToLocalDateTimeFromDeprecatedInstantNullable")
fun DataColumn<Instant?>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime?>

Converts values in this kotlinx.datetime.Instant column to LocalDateTime. Preserves null values.

@JvmName(name = "convertToLocalDateTimeFromDeprecatedInstant")
fun DataColumn<Instant>.convertToLocalDateTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalDateTime>

Converts values in this kotlinx.datetime.Instant column to LocalDateTime.

@JvmName(name = "convertToLocalDateTimeFromStringNullable")
fun DataColumn<String?>.convertToLocalDateTime(pattern: String? = null, locale: Locale? = null): DataColumn<LocalDateTime?>
@JvmName(name = "convertToLocalDateTimeFromString")
fun DataColumn<String>.convertToLocalDateTime(pattern: String? = null, locale: Locale? = null): DataColumn<LocalDateTime>
Link copied to clipboard
fun <T : Any> DataColumn<T?>.convertToLocalTime(): DataColumn<LocalTime?>

Converts values in this column to LocalTime. Preserves null values.

@JvmName(name = "convertToLocalTimeFromT")
fun <T : Any> DataColumn<T>.convertToLocalTime(): DataColumn<LocalTime>

Converts values in this column to LocalTime.

@JvmName(name = "convertToLocalTimeFromDateTimeComponentsNullable")
fun DataColumn<DateTimeComponents?>.convertToLocalTime(): DataColumn<LocalTime?>

Converts values in this DateTimeComponents column to LocalTime. Preserves null values.

@JvmName(name = "convertToLocalTimeFromDateTimeComponents")
fun DataColumn<DateTimeComponents>.convertToLocalTime(): DataColumn<LocalTime>

Converts values in this DateTimeComponents column to LocalTime.

@JvmName(name = "convertToLocalTimeIntNullable")
fun DataColumn<Int?>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime?>

Converts values in this Int column to LocalTime. Preserves null values.

@JvmName(name = "convertToLocalTimeFromInt")
fun DataColumn<Int>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime>

Converts values in this Int column to LocalTime.

fun DataColumn<Long?>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime?>

Converts values in this Long column to LocalTime. Preserves null values.

@JvmName(name = "convertToLocalTimeFromLong")
fun DataColumn<Long>.convertToLocalTime(zone: TimeZone = defaultTimeZone): DataColumn<LocalTime>

Converts values in this Long column to LocalTime.

@JvmName(name = "convertToLocalTimeFromStringNullablePattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String?>.convertToLocalTime(pattern: String): DataColumn<LocalTime?>
@JvmName(name = "convertToLocalTimeFromStringNullable")
fun DataColumn<String?>.convertToLocalTime(format: DateTimeFormat<LocalTime>? = null): DataColumn<LocalTime?>

Converts values in this String column to LocalTime. Preserves null values.

@JvmName(name = "convertToLocalTimeFromStringPattern")
@FormatStringsInDatetimeFormats
fun DataColumn<String>.convertToLocalTime(pattern: String): DataColumn<LocalTime>
@JvmName(name = "convertToLocalTimeFromString")
fun DataColumn<String>.convertToLocalTime(format: DateTimeFormat<LocalTime>? = null): DataColumn<LocalTime>

Converts values in this String column to LocalTime.

@JvmName(name = "convertToLocalTimeFromStringNullable")
fun DataColumn<String?>.convertToLocalTime(pattern: String? = null, locale: Locale? = null): DataColumn<LocalTime?>
@JvmName(name = "convertToLocalTimeFromString")
fun DataColumn<String>.convertToLocalTime(pattern: String? = null, locale: Locale? = null): DataColumn<LocalTime>
Link copied to clipboard

Converts values in this column to Long. Preserves null values.

@JvmName(name = "convertToLongFromT")
fun <T : Any> DataColumn<T>.convertToLong(): DataColumn<Long>

Converts values in this column to Long.

Link copied to clipboard

Converts values in this column to Short. Preserves null values.

@JvmName(name = "convertToShortFromT")
fun <T : Any> DataColumn<T>.convertToShort(): DataColumn<Short>

Converts values in this column to Short.

Link copied to clipboard
@JvmName(name = "convertToStdlibInstantFromStringNullable")
fun DataColumn<String?>.convertToStdlibInstant(): DataColumn<Instant?>

Converts values in this String column to kotlin.time.Instant. Preserves null values.

Converts values in this String column to kotlin.time.Instant.

@JvmName(name = "convertToStdlibInstantFromDeprecatedInstantNullable")
fun DataColumn<Instant?>.convertToStdlibInstant(): DataColumn<Instant?>

Converts values in this kotlinx.datetime.Instant column to kotlin.time.Instant. Preserves null values.

@JvmName(name = "convertToStdlibInstantFromDeprecatedInstant")
fun DataColumn<Instant>.convertToStdlibInstant(): DataColumn<Instant>

Converts values in this kotlinx.datetime.Instant column to kotlin.time.Instant.

@JvmName(name = "convertToStdlibInstantFromDateTimeComponentsNullable")
fun DataColumn<DateTimeComponents?>.convertToStdlibInstant(): DataColumn<Instant?>

Converts values in this DateTimeComponents column to kotlin.time.Instant. Preserves null values.

@JvmName(name = "convertToStdlibInstantFromDateTimeComponents")
fun DataColumn<DateTimeComponents>.convertToStdlibInstant(): DataColumn<Instant>

Converts values in this DateTimeComponents column to kotlin.time.Instant.

Link copied to clipboard

Converts values in this column to String. Preserves null values.

@JvmName(name = "convertToStringFromT")
fun <T : Any> DataColumn<T>.convertToString(): DataColumn<String>

Converts values in this column to String.

Link copied to clipboard
internal fun AnyCol.convertToTypeImpl(to: KType, parserOptions: ParserOptions?): AnyCol
Link copied to clipboard
@JvmName(name = "convertToURLFromStringNullable")
fun DataColumn<String?>.convertToURL(): DataColumn<URL?>
Link copied to clipboard
@JvmName(name = "convertToUrlFromStringNullable")
fun DataColumn<String?>.convertToUrl(): DataColumn<URL?>

Converts values in this String column to an URL. Preserves null values.

Converts values in this String column to an URL.

Link copied to clipboard
@JvmName(name = "convertToUtcOffsetNullable")
fun DataColumn<DateTimeComponents?>.convertToUtcOffset(): DataColumn<UtcOffset?>

Converts values in this DateTimeComponents column to UtcOffset. Preserves null values.

fun DataColumn<DateTimeComponents>.convertToUtcOffset(): DataColumn<UtcOffset>

Converts values in this DateTimeComponents column to UtcOffset.

Link copied to clipboard
@JvmName(name = "convertToYearMonthNullable")
fun DataColumn<DateTimeComponents?>.convertToYearMonth(): DataColumn<YearMonth?>

Converts values in this DateTimeComponents column to YearMonth. Preserves null values.

fun DataColumn<DateTimeComponents>.convertToYearMonth(): DataColumn<YearMonth>

Converts values in this DateTimeComponents column to YearMonth.

Link copied to clipboard
fun <T> DataColumn<T>.count(predicate: Predicate<T>? = null): Int

Counts the elements in this DataColumn that satisfy a given predicate or returns the total count if no predicate is provided.

Link copied to clipboard
open override fun countDistinct(): Int
Link copied to clipboard
internal fun AnyCol.createComparator(nullsLast: Boolean): Comparator<Int>
Link copied to clipboard
fun <T : Number?> DataColumn<T>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<T>
@JvmName(name = "cumSumNullableByte")
fun DataColumn<Byte?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int?>
@JvmName(name = "cumSumByte")
fun DataColumn<Byte>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int>
@JvmName(name = "cumSumDouble")
fun DataColumn<Double?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Double>
@JvmName(name = "cumSumFloat")
fun DataColumn<Float?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Float>
@JvmName(name = "cumSumNullableShort")
fun DataColumn<Short?>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int?>
@JvmName(name = "cumSumShort")
fun DataColumn<Short>.cumSum(skipNA: Boolean = defaultCumSumSkipNA): DataColumn<Int>

Computes the cumulative sums of the values in each column from the DataColumn from the first cell to the last cell.

Link copied to clipboard
@JvmName(name = "byteCumsum")
internal fun DataColumn<Byte>.cumSumImpl(): DataColumn<Int>
@JvmName(name = "intCumsum")
internal fun DataColumn<Int>.cumSumImpl(): DataColumn<Int>
@JvmName(name = "longCumsum")
internal fun DataColumn<Long>.cumSumImpl(): DataColumn<Long>
@JvmName(name = "shortCumsum")
internal fun DataColumn<Short>.cumSumImpl(): DataColumn<Int>
@JvmName(name = "cumsumByteNullable")
internal fun DataColumn<Byte?>.cumSumImpl(skipNA: Boolean): DataColumn<Int?>
@JvmName(name = "cumsumDoubleNullable")
internal fun DataColumn<Double?>.cumSumImpl(skipNA: Boolean): DataColumn<Double>
@JvmName(name = "doubleCumsum")
internal fun DataColumn<Double>.cumSumImpl(skipNA: Boolean): DataColumn<Double>
@JvmName(name = "floatCumsum")
internal fun DataColumn<Float>.cumSumImpl(skipNA: Boolean): DataColumn<Float>
@JvmName(name = "intCumsum")
internal fun DataColumn<Int?>.cumSumImpl(skipNA: Boolean): DataColumn<Int?>
@JvmName(name = "cumsumLongNullable")
internal fun DataColumn<Long?>.cumSumImpl(skipNA: Boolean): DataColumn<Long?>
@JvmName(name = "cumsumShortNullable")
internal fun DataColumn<Short?>.cumSumImpl(skipNA: Boolean): DataColumn<Int?>
internal fun DataColumn<Number?>.cumSumImpl(type: KType, skipNA: Boolean): DataColumn<Number?>
Link copied to clipboard
open override fun defaultValue(): T?
Link copied to clipboard

Computes descriptive statistics for a given DataColumn, returning a DataFrame with key summary metrics.

Link copied to clipboard
open override fun distinct(): ValueColumn<T>
Link copied to clipboard
operator fun DataColumn<Double>.div(value: Double): DataColumn<Double>
@JvmName(name = "divDouble")
operator fun DataColumn<Double>.div(value: Int): DataColumn<Double>
@JvmName(name = "divIntNullable")
operator fun DataColumn<Int?>.div(value: Int): DataColumn<Int?>
@JvmName(name = "divInt")
operator fun DataColumn<Int>.div(value: Double): DataColumn<Double>
operator fun DataColumn<Int>.div(value: Int): DataColumn<Int>
operator fun DataColumn<Long>.div(value: Long): DataColumn<Long>

Returns a DataColumn containing the results of dividing each element of this DataColumn by value.

operator fun ColumnReference<Int>.div(value: Int): ColumnReference<Int>

Returns a ColumnReference containing the results of dividing each element of this ColumnReference by value.

Link copied to clipboard
inline fun <T> DataColumn<T>.drop(predicate: Predicate<T>): DataColumn<T>

Returns a DataColumn containing only the values that do not match the given predicate.

Returns a DataColumn containing all values of this DataColumn except the first n values.

Link copied to clipboard
fun <T> DataColumn<T>.dropLast(n: Int = 1): DataColumn<T>

Returns a DataColumn containing all values of this DataColumn except the last n values.

Link copied to clipboard

Removes NA values from this DataColumn, adjusting the type accordingly.

Link copied to clipboard

Removes NaN values from this DataColumn, adjusting the type accordingly.

Link copied to clipboard

Removes null values from this DataColumn, adjusting the type accordingly.

Link copied to clipboard
internal fun <T> DataColumn<T>.duplicateValuesImpl(n: Int, indicesSorted: Iterable<Int>): DataColumn<T>
Link copied to clipboard

Checks the validity of this SingleColumn, by adding a check to see it's a ColumnGroup (so, a SingleColumn<*>) and throwing an IllegalArgumentException if it's not.

Link copied to clipboard

Checks the validity of this SingleColumn, by adding a check to see it's a FrameColumn (so, a SingleColumn<*>) and throwing an IllegalArgumentException if it's not.

Link copied to clipboard

Checks the validity of this SingleColumn, by adding a check to see it's a ValueColumn (so, a SingleColumn<*>) and throwing an IllegalArgumentException if it's not.

Link copied to clipboard
infix fun <T> DataColumn<T>.eq(value: T): DataColumn<Boolean>

Returns a DataColumn containing the results of comparing each element of this DataColumn with value for equality using the == operator.

infix fun <C> ColumnReference<C>.eq(value: C): ColumnReference<Boolean>
Link copied to clipboard
@JvmName(name = "exceptInternalSingleColumn")
internal fun <C> SingleColumn<DataRow<C>>.exceptInternal(other: ColumnsResolver<*>): SingleColumn<DataRow<C>>

Returns a new SingleColumn> that has the same structure as the receiver, but excludes columns specified in the "other" ColumnsResolver.

Link copied to clipboard
@JvmName(name = "explodeList")
fun <T> DataColumn<Collection<T>>.explode(): DataColumn<T>

Splits list-like values in this DataColumn and spreads them vertically — that is, it adds a separate row for each element (one value per row).

@JvmName(name = "explodeFrames")
fun <T> DataColumn<DataFrame<T>>.explode(): ColumnGroup<T>

Explodes a DataColumn of DataFrame values into a single ColumnGroup.

Link copied to clipboard
internal fun AnyCol.explodeImpl(): AnyCol
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T> DataColumn<T>.filter(predicate: Predicate<T>): DataColumn<T>

Returns a new DataColumn containing only the elements that match the given predicate.

Link copied to clipboard
fun <T> DataColumn<T>.first(): T

Returns the first value in this DataColumn.

fun <T> DataColumn<T>.first(predicate: (T) -> Boolean): T

Returns the first value in this DataColumn that matches the given predicate.

Link copied to clipboard

Returns the first value in this DataColumn. If the DataColumn is empty, returns null.

fun <T> DataColumn<T>.firstOrNull(predicate: (T) -> Boolean): T?

Returns the first value in this DataColumn that matches the given predicate. Returns null if the DataColumn contains no elements matching the predicate (including the case when the DataColumn is empty).

Link copied to clipboard
internal fun ColumnsResolver<*>.flattenRecursively(includeGroups: Boolean = true, includeTopLevel: Boolean = true): ColumnsResolver<*>

Flattens a ColumnsResolver recursively.

Link copied to clipboard
inline fun <T> DataColumn<T>.forEach(action: (T) -> Unit)

Calls action for every value of this DataColumn, from the first one to the last one.

Link copied to clipboard
inline fun <T> DataColumn<T>.forEachIndexed(action: (Int, T) -> Unit)

Calls action for every value of this DataColumn and its position, from the first value to the last one.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.frameColumnsInternal(crossinline filter: (FrameColumn<*>) -> Boolean): TransformableColumnSet<AnyFrame>

Returns a TransformableColumnSet containing the frame columns that satisfy the given filter.

Link copied to clipboard
open operator override fun get(index: Int): T

Gets the row at given index.

open operator override fun get(columnName: String): DataColumn<*>
open operator override fun get(row: AnyRow): T

open operator override fun get(firstIndex: Int, vararg otherIndices: Int): BaseColumn<T>
open operator override fun get(indices: Iterable<Int>): DataColumn<T>

Gets the rows at given indices.

open operator override fun get(range: IntRange): DataColumn<T>

Gets the rows at given range of indices.

Link copied to clipboard
internal fun <T> ColumnsResolver<T>.getAt(index: Int): SingleColumn<T>
Link copied to clipboard
internal fun AnyCol.getHashCode(): Int
Link copied to clipboard
open override fun getStatisticCacheOrNull(statName: String, arguments: Map<String, Any>): StatisticResult?
Link copied to clipboard
open override fun getValue(row: AnyRow): T
open operator override fun getValue(thisRef: Any?, property: KProperty<*>): ValueColumn<T>
Link copied to clipboard
open override fun getValueOrNull(row: AnyRow): T?
Link copied to clipboard
internal fun <T> AnyCol.grouped(): ColumnGroup<T>
Link copied to clipboard
infix fun <T : Comparable<T>> DataColumn<T>.gt(value: T): DataColumn<Boolean>

Returns a DataColumn containing the results of comparing each element of this DataColumn with value using the > operator.

Link copied to clipboard
open override fun hasNulls(): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Returns true if this column is a ColumnGroup, i.e., its kind is ColumnKind.Group.

Link copied to clipboard

Returns true if this column is intra-comparable (mutually comparable), i.e., its values can be compared with each other and thus ordered.

Link copied to clipboard

Returns true if this column is a FrameColumn, i.e., its kind is ColumnKind.Frame.

Link copied to clipboard

Returns true when the class of this column's type is List, i.e., the column holds List<*> (or List<*>?) values.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Returns true when this column's type is a subtype of Number?

Link copied to clipboard

Returns true when this column has the (nullable) type of either: Byte, Short, Int, Long, Float, or Double.

Link copied to clipboard

Returns true when this column has the (nullable) type of either: Byte, Short, Int, Long, Float, Double, or Number.

Link copied to clipboard
inline fun <reified T> DataColumn<*>.isSubtypeOf(): Boolean

Returns true if the type of this column is a subtype of T.

Returns true if the type of this column is a subtype of the given type.

Link copied to clipboard
Link copied to clipboard
inline fun <reified T> DataColumn<*>.isType(): Boolean

Returns true only if the type of this column is exactly T.

Link copied to clipboard

Returns true if this column is a ValueColumn, i.e., its kind is ColumnKind.Value.

Link copied to clipboard
open operator override fun iterator(): Iterator<T>
Link copied to clipboard
open override fun kind(): ColumnKind
Link copied to clipboard
fun <T> DataColumn<T>.last(): T

Returns the last value in this DataColumn.

inline fun <T> DataColumn<T>.last(predicate: (T) -> Boolean): T

Returns the last value in this DataColumn that matches the given predicate.

Link copied to clipboard

Returns the last value in this DataColumn. If the DataColumn is empty, returns null.

inline fun <T> DataColumn<T>.lastOrNull(predicate: (T) -> Boolean): T?

Returns the last value in this DataColumn that matches the given predicate. Returns null if the DataColumn contains no elements matching the predicate (including the case when the DataColumn is empty).

Link copied to clipboard
infix fun <T : Comparable<T>> DataColumn<T>.lt(value: T): DataColumn<Boolean>

Returns a DataColumn containing the results of comparing each element of this DataColumn with value using the < operator.

Link copied to clipboard
inline fun <T, reified R> DataColumn<T>.map(infer: Infer = Infer.Nulls, transform: (T) -> R): DataColumn<R>

Returns a new DataColumn with the values that transform computes from the values of this column.

internal inline fun <C, reified R> ColumnReference<C>.map(infer: Infer = Infer.Nulls, noinline transform: (C) -> R): ColumnReference<R>

inline fun <T, R> DataColumn<T>.map(type: KType, infer: Infer = Infer.Nulls, transform: (T) -> R): DataColumn<R>

Returns a new DataColumn of the given type with the values that transform computes from the values of this column.

Link copied to clipboard
inline fun <T, reified R> DataColumn<T>.mapIndexed(infer: Infer = Infer.Nulls, transform: (Int, T) -> R): DataColumn<R>

Returns a new DataColumn with the values that transform computes from the values of this column and their positions.

inline fun <T, R> DataColumn<T>.mapIndexed(type: KType, infer: Infer = Infer.Nulls, transform: (Int, T) -> R): DataColumn<R>

Returns a new DataColumn of the given type with the values that transform computes from the values of this column and their positions.

Link copied to clipboard
internal fun <T, R> DataColumn<T?>.mapNotNullValues(transform: (T) -> R): DataColumn<R?>
Link copied to clipboard
fun <T : Comparable<T>> DataColumn<T?>.max(skipNaN: Boolean = skipNaNDefault): T

Returns the maximum of the values in this DataColumn.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.maxBy(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T

Returns the first element of this DataColumn for which the given selector returns the maximum value.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.maxByOrNull(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T?

Returns the first element of this DataColumn for which the given selector returns the maximum value, or null if there is nothing to compare.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.maxOf(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): R & Any

Returns the maximum of the values that the given selector returns for each element of this DataColumn.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.maxOfOrNull(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): R?

Returns the maximum of the values that the given selector returns for each element of this DataColumn, or null if there is nothing to compare.

Link copied to clipboard
fun <T : Comparable<T>> DataColumn<T?>.maxOrNull(skipNaN: Boolean = skipNaNDefault): T?

Returns the maximum of the values in this DataColumn, or null if there is nothing to compare.

Link copied to clipboard
internal fun BaseColumn<*>.maxWidth(): Int

Returns the max number of columns needed to display this column flattened

Link copied to clipboard
fun DataColumn<Number?>.mean(skipNaN: Boolean = skipNaNDefault): Double

Returns the mean of the values in this DataColumn, as a Double.

Link copied to clipboard
inline fun <T, reified R : Number?> DataColumn<T>.meanOf(skipNaN: Boolean = skipNaNDefault, crossinline expression: (T) -> R): Double

Returns the mean of the values that the given expression returns for each element of this DataColumn, as a Double.

Link copied to clipboard
fun <T : Comparable<T & Any>?> DataColumn<T>.median(): T & Any

Returns the median of the comparable values in this DataColumn.

fun <T : Comparable<T & Any>?, Number?> DataColumn<T>.median(skipNaN: Boolean = skipNaNDefault): Double

Returns the median of the numbers in this DataColumn, as a Double.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.medianBy(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T

Returns the element of this DataColumn at the median of the values that the given selector returns for each element.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.medianByOrNull(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T?

Returns the element of this DataColumn at the median of the values that the given selector returns for each element, or null if there is nothing to compute the median of.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.medianOf(crossinline expression: (T) -> R): R & Any

Returns the median of the comparable values that the given expression returns for each element of this DataColumn.

inline fun <T, reified R : Comparable<R & Any>?, Number?> DataColumn<T>.medianOf(skipNaN: Boolean = skipNaNDefault, crossinline expression: (T) -> R): Double

Returns the median of the numbers that the given expression returns for each element of this DataColumn, as a Double.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.medianOfOrNull(crossinline expression: (T) -> R): R?

Returns the median of the comparable values that the given expression returns for each element of this DataColumn, or null if there is nothing to compute the median of.

inline fun <T, reified R : Comparable<R & Any>?, Number?> DataColumn<T>.medianOfOrNull(skipNaN: Boolean = skipNaNDefault, crossinline expression: (T) -> R): Double?

Returns the median of the numbers that the given expression returns for each element of this DataColumn, as a Double, or null if there is nothing to compute the median of.

Link copied to clipboard

Returns the median of the comparable values in this DataColumn, or null if there is nothing to compute the median of.

fun <T : Comparable<T & Any>?, Number?> DataColumn<T>.medianOrNull(skipNaN: Boolean = skipNaNDefault): Double?

Returns the median of the numbers in this DataColumn, as a Double, or null if there is nothing to compute the median of.

Link copied to clipboard
fun <T : Comparable<T>> DataColumn<T?>.min(skipNaN: Boolean = skipNaNDefault): T

Returns the minimum of the values in this DataColumn.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.minBy(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T

Returns the first element of this DataColumn for which the given selector returns the minimum value.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.minByOrNull(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T?

Returns the first element of this DataColumn for which the given selector returns the minimum value, or null if there is nothing to compare.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.minOf(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): R & Any

Returns the minimum of the values that the given selector returns for each element of this DataColumn.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.minOfOrNull(skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): R?

Returns the minimum of the values that the given selector returns for each element of this DataColumn, or null if there is nothing to compare.

Link copied to clipboard
fun <T : Comparable<T>> DataColumn<T?>.minOrNull(skipNaN: Boolean = skipNaNDefault): T?

Returns the minimum of the values in this DataColumn, or null if there is nothing to compare.

Link copied to clipboard
operator fun DataColumn<Double>.minus(value: Double): DataColumn<Double>
@JvmName(name = "minusDouble")
operator fun DataColumn<Double>.minus(value: Int): DataColumn<Double>
@JvmName(name = "minusIntNullable")
operator fun DataColumn<Int?>.minus(value: Int): DataColumn<Int?>
@JvmName(name = "minusInt")
operator fun DataColumn<Int>.minus(value: Double): DataColumn<Double>
operator fun DataColumn<Int>.minus(value: Int): DataColumn<Int>
operator fun DataColumn<Long>.minus(value: Long): DataColumn<Long>

Returns a DataColumn where each element is the result of subtracting value from the corresponding element of this DataColumn.

Returns a ColumnReference where each element is the result of subtracting value from the corresponding element of this ColumnReference.

Link copied to clipboard
open override fun name(): String
Link copied to clipboard
infix fun <T> DataColumn<T>.neq(value: T): DataColumn<Boolean>

Returns a DataColumn containing the results of comparing each element of this DataColumn with value for inequality using the != operator.

infix fun <C> ColumnReference<C>.neq(value: C): ColumnReference<Boolean>
Link copied to clipboard
fun <T> DataColumn<T>.none(predicate: Predicate<T>): Boolean

Returns true if none of the values match the given predicate.

Link copied to clipboard
@JvmName(name = "notBooleanNullable")
operator fun DataColumn<Boolean?>.not(): DataColumn<Boolean?>

Returns a DataColumn containing the inverse Boolean values of this DataColumn. Each null value in the original DataColumn is preserved.

Returns a DataColumn containing the inverse Boolean values of this DataColumn.

@JvmName(name = "notBooleanNullable")
operator fun ColumnReference<Boolean?>.not(): ColumnReference<Boolean?>

Returns a ColumnReference containing the inverse Boolean values of this ColumnReference. Each null value in the original ColumnReference is preserved.

Returns a ColumnReference containing the inverse Boolean values of this ColumnReference.

Link copied to clipboard
internal fun <A> SingleColumn<A>.onResolve(check: (ColumnWithPath<A>?) -> Unit): SingleColumn<A>

Helper function to perform runtime checks on a SingleColumn.

Link copied to clipboard
@JvmName(name = "parseChar")
fun DataColumn<Char?>.parse(options: ParserOptions? = null): DataColumn<*>

Tries to parse a column of chars as strings into a column of a different type. Each parser in Parsers is run in order until a valid parser is found, a.k.a. that parser was able to parse all values in the column successfully. If a parser fails to parse any value, the next parser is tried.

fun DataColumn<String?>.parse(options: ParserOptions? = null): DataColumn<*>

Tries to parse a column of strings into a column of a different type. Each parser in Parsers is run in order until a valid parser is found, a.k.a. that parser was able to parse all values in the column successfully. If a parser fails to parse any value, the next parser is tried.

@JvmName(name = "parseAnyFrameNullable")
fun DataColumn<DataFrame<*>?>.parse(options: ParserOptions? = null): DataColumn<DataFrame<*>?>
internal fun <T> DataColumn<String?>.parse(parser: StringParser<T>, options: ParserOptions?): DataColumn<T?>
Link copied to clipboard
open override fun path(): ColumnPath
Link copied to clipboard
fun <T : Comparable<T & Any>?> DataColumn<T>.percentile(percentile: Double): T & Any

Returns the given percentile of the comparable values in this DataColumn.

fun <T : Comparable<T & Any>?, Number?> DataColumn<T>.percentile(percentile: Double, skipNaN: Boolean = skipNaNDefault): Double

Returns the given percentile of the numbers in this DataColumn, as a Double.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.percentileBy(percentile: Double, skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T

Returns the element of this DataColumn at the given percentile of the values that the given selector returns for each element.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.percentileByOrNull(percentile: Double, skipNaN: Boolean = skipNaNDefault, crossinline selector: (T) -> R): T?

Returns the element of this DataColumn at the given percentile of the values that the given selector returns for each element, or null if there is nothing to compute the percentile of.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.percentileOf(percentile: Double, crossinline expression: (T) -> R): R & Any

Returns the given percentile of the comparable values that the given expression returns for each element of this DataColumn.

inline fun <T, reified R : Comparable<R & Any>?, Number?> DataColumn<T>.percentileOf(percentile: Double, skipNaN: Boolean = skipNaNDefault, crossinline expression: (T) -> R): Double

Returns the given percentile of the numbers that the given expression returns for each element of this DataColumn, as a Double.

Link copied to clipboard
inline fun <T, reified R : Comparable<R & Any>?> DataColumn<T>.percentileOfOrNull(percentile: Double, crossinline expression: (T) -> R): R?

Returns the given percentile of the comparable values that the given expression returns for each element of this DataColumn, or null if there is nothing to compute the percentile of.

inline fun <T, reified R : Comparable<R & Any>?, Number?> DataColumn<T>.percentileOfOrNull(percentile: Double, skipNaN: Boolean = skipNaNDefault, crossinline expression: (T) -> R): Double?

Returns the given percentile of the numbers that the given expression returns for each element of this DataColumn, as a Double, or null if there is nothing to compute the percentile of.

Link copied to clipboard
fun <T : Comparable<T & Any>?> DataColumn<T>.percentileOrNull(percentile: Double): T?

Returns the given percentile of the comparable values in this DataColumn, or null if there is nothing to compute the percentile of.

fun <T : Comparable<T & Any>?, Number?> DataColumn<T>.percentileOrNull(percentile: Double, skipNaN: Boolean = skipNaNDefault): Double?

Returns the given percentile of the numbers in this DataColumn, as a Double, or null if there is nothing to compute the percentile of.

Link copied to clipboard
operator fun DataColumn<*>.plus(str: String): DataColumn<String>

Returns a DataColumn of String values obtained by converting each element of this AnyCol to a String and concatenating it with str.

operator fun DataColumn<Double>.plus(value: Double): DataColumn<Double>
@JvmName(name = "plusDouble")
operator fun DataColumn<Double>.plus(value: Int): DataColumn<Double>
@JvmName(name = "plusIntNullable")
operator fun DataColumn<Int?>.plus(value: Int): DataColumn<Int?>
@JvmName(name = "plusInt")
operator fun DataColumn<Int>.plus(value: Double): DataColumn<Double>
operator fun DataColumn<Int>.plus(value: Int): DataColumn<Int>
operator fun DataColumn<Long>.plus(value: Long): DataColumn<Long>

Returns a DataColumn where each element is the result of adding value to the corresponding element of this DataColumn.

Returns a ColumnReference of String values obtained by converting each element of this ColumnReference to a String and concatenating it with str.

operator fun ColumnReference<Int>.plus(value: Int): ColumnReference<Int>

Returns a ColumnReference where each element is the result of adding value to the corresponding element of this ColumnReference.

Link copied to clipboard
fun <T> DataColumn<T>.print()
Link copied to clipboard
open override fun putStatisticCache(statName: String, arguments: Map<String, Any>, value: StatisticResult)
Link copied to clipboard
open override fun rename(newName: String): ValueColumn<T>
Link copied to clipboard
internal fun <C> SingleColumn<C>.renamedColumn(newName: String): SingleColumn<C>
Link copied to clipboard
Link copied to clipboard
internal fun AnyCol.renderShort(): String
Link copied to clipboard
open override fun resolve(context: ColumnResolutionContext): List<ColumnWithPath<T>>

Resolves this ColumnsResolver as a List<ColumnWithPath<C>>. In many cases this function transforms a parent ColumnsResolver to reach the current ColumnsResolver result.

Link copied to clipboard
internal fun <C> ColumnsResolver<C>.resolve(df: DataFrame<*>, unresolvedColumnsPolicy: UnresolvedColumnsPolicy = UnresolvedColumnsPolicy.Fail): List<ColumnWithPath<C>>
Link copied to clipboard
Link copied to clipboard
open override fun resolveSingle(context: ColumnResolutionContext): ColumnWithPath<T>?
Link copied to clipboard
internal fun <C> SingleColumn<C>.resolveSingle(df: DataFrame<*>, unresolvedColumnsPolicy: UnresolvedColumnsPolicy = UnresolvedColumnsPolicy.Fail): ColumnWithPath<C>?
Link copied to clipboard

Returns a new DataColumn with the same values in reversed order, so the last value becomes the first one.

Returns a new ValueColumn with the same values in reversed order, so the last value becomes the first one.

Link copied to clipboard
internal fun <T : Number> DataColumn<T?>.scale(): Int
Link copied to clipboard
internal fun <C, R> SingleColumn<DataRow<C>>.selectInternal(selector: ColumnsSelector<C, R>): ColumnSet<R>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Returns a new DataColumn with values in random order using the default randomness.

fun <T> DataColumn<T>.shuffle(random: Random): DataColumn<T>

Returns a new DataColumn with the same values in random order using the provided random source.

Link copied to clipboard

Simplifies structure by removing columns that are already present in column groups in this.

Link copied to clipboard
fun <C> DataColumn<C>.single(): C

Returns the single value in this DataColumn.

Link copied to clipboard

Converts this ColumnsResolver to a SingleColumn. resolveSingle will return the single column of this if there is only one, else it will throw an exception: In case of an empty ColumnsResolver, a NoSuchElementException will be thrown. In case of more than one column, an IllegalArgumentException will be thrown. If the result is used as a ColumnSet, null will be converted to an empty list.

Link copied to clipboard
internal fun <C> ColumnsResolver<C>.singleInternal(condition: ColumnFilter<C> = { true }): TransformableSingleColumn<C>
Link copied to clipboard

Converts this ColumnsResolver to a SingleColumn. resolveSingle will return the single column of this if there is only one, else it will return null. If the result used as a ColumnSet, null will be converted to an empty list.

Link copied to clipboard
open override fun size(): Int
Link copied to clipboard

Sorts the values in this column in ascending order.

Link copied to clipboard

Sorts the values in this column in descending order.

Link copied to clipboard
fun DataColumn<Iterable<*>>.splitInto(vararg names: String): DataFrame<*>
Link copied to clipboard
fun DataColumn<Number?>.std(skipNaN: Boolean = skipNaNDefault, ddof: Int = ddofDefault): Double

Returns the standard deviation of the values in this DataColumn, as a Double.

Link copied to clipboard
inline fun <T, reified R : Number?> DataColumn<T>.stdOf(skipNaN: Boolean = skipNaNDefault, ddof: Int = ddofDefault, noinline expression: (T) -> R): Double

Returns the standard deviation of the values that the given expression returns for each element of this DataColumn, as a Double.

Link copied to clipboard
@JvmName(name = "sumByte")
fun DataColumn<Byte?>.sum(): Int

Returns the sum of the Byte values in this DataColumn, as an Int.

@JvmName(name = "sumShort")
fun DataColumn<Short?>.sum(): Int

Returns the sum of the Short values in this DataColumn, as an Int.

@JvmName(name = "sumNumber")
fun <T : Number?> DataColumn<T>.sum(skipNaN: Boolean = skipNaNDefault): T & Any

Returns the sum of the values in this DataColumn.

Link copied to clipboard
@JvmName(name = "sumOfByte")
inline fun <C, reified V : Byte?> DataColumn<C>.sumOf(crossinline expression: (C) -> V): Int

Returns the sum of the Byte values that the given expression returns for each element of this DataColumn, as an Int.

@JvmName(name = "sumOfShort")
inline fun <C, reified V : Short?> DataColumn<C>.sumOf(crossinline expression: (C) -> V): Int

Returns the sum of the Short values that the given expression returns for each element of this DataColumn, as an Int.

@JvmName(name = "sumOfNumber")
inline fun <C, reified V : Number?> DataColumn<C>.sumOf(skipNaN: Boolean = skipNaNDefault, crossinline expression: (C) -> V): V & Any

Returns the sum of the values that the given expression returns for each element of this DataColumn.

Link copied to clipboard

Returns a DataColumn containing the first n values of this DataColumn.

Link copied to clipboard
fun <T> DataColumn<T>.takeLast(n: Int = 1): DataColumn<T>

Returns a DataColumn containing the last n values of this DataColumn.

Link copied to clipboard
operator fun DataColumn<Double>.times(value: Double): DataColumn<Double>
@JvmName(name = "timesDouble")
operator fun DataColumn<Double>.times(value: Int): DataColumn<Double>
@JvmName(name = "timesIntNullable")
operator fun DataColumn<Int?>.times(value: Int): DataColumn<Int?>
@JvmName(name = "timesInt")
operator fun DataColumn<Int>.times(value: Double): DataColumn<Double>
operator fun DataColumn<Int>.times(value: Int): DataColumn<Int>
operator fun DataColumn<Long>.times(value: Long): DataColumn<Long>

Returns a DataColumn containing the results of multiplying each element of this DataColumn by value.

Returns a ColumnReference containing the results of multiplying each element of this ColumnReference by value.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun <T> DataColumn<List<List<T>>>.toDataFrames(containsColumns: Boolean = false): DataColumn<DataFrame<*>>

Converts a list of lists values in this DataColumn to DataFrame.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun toList(): List<T>
Link copied to clipboard
Link copied to clipboard
open override fun toSet(): Set<T>
Link copied to clipboard
Link copied to clipboard
inline fun <reified T> DataColumn<T>.toTypedArray(): Array<T>
Link copied to clipboard
internal inline fun <A, B> ColumnsResolver<A>.transform(crossinline converter: (List<ColumnWithPath<A>>) -> List<ColumnWithPath<B>>): TransformableColumnSet<B>

Applies a transformation on this by converting its List<ColumnWithPath<A>] to List<ColumnWithPath<B>] using converter.

Link copied to clipboard
internal fun <A, B> SingleColumn<A>.transformSingle(converter: (ColumnWithPath<A>) -> List<ColumnWithPath<B>>): ColumnSet<B>

Applies a transformation on this SingleColumn by converting its single ColumnWithPath<A> to List<ColumnWithPath<B>] using converter. Since converter allows you to return multiple columns, the result is turned into a ColumnSet<B>.

Link copied to clipboard

Applies a transformation on this SingleColumn by converting its single ColumnWithPath<A> to List<ColumnWithPath<B>] using converter but also providing the ColumnResolutionContext to the converter.

Link copied to clipboard

Applies a transformation on this by converting its List<ColumnWithPath<A>] to List<ColumnWithPath<B>] using converter, but also providing the ColumnResolutionContext to the converter.

Link copied to clipboard
@JvmName(name = "tryParseChar")
fun DataColumn<Char?>.tryParse(options: ParserOptions? = null): DataColumn<*>

Tries to parse a column of chars into a column of a different type. Each parser in Parsers is run in order until a valid parser is found, a.k.a. that parser was able to parse all values in the column successfully. If a parser fails to parse any value, the next parser is tried. If all the others fail, the final parser returns strings.

fun DataColumn<String?>.tryParse(options: ParserOptions? = null): DataColumn<*>

Tries to parse a column of strings into a column of a different type. Each parser in Parsers is run in order until a valid parser is found, a.k.a. that parser was able to parse all values in the column successfully. If a parser fails to parse any value, the next parser is tried. If all the others fail, the final parser simply returns the original string, leaving the column unchanged.

Link copied to clipboard
internal fun DataColumn<String?>.tryParseImpl(options: ParserOptions?): DataColumn<*>

Tries to parse a column of strings into a column of a different type. Each parser in Parsers is run in order until a valid parser is found, a.k.a. that parser was able to parse all values in the column successfully. If a parser fails to parse any value, the next parser is tried. If all the others fail, the final parser simply returns the original string, leaving the column unchanged.

Link copied to clipboard
open override fun type(): KType
Link copied to clipboard
@JvmName(name = "unaryMinusBigDecimal")
operator fun DataColumn<BigDecimal>.unaryMinus(): DataColumn<BigDecimal>
@JvmName(name = "unaryMinusBigInteger")
operator fun DataColumn<BigInteger>.unaryMinus(): DataColumn<BigInteger>
@JvmName(name = "unaryMinusDouble")
operator fun DataColumn<Double>.unaryMinus(): DataColumn<Double>
@JvmName(name = "unaryMinusIntNullable")
operator fun DataColumn<Int?>.unaryMinus(): DataColumn<Int?>
@JvmName(name = "unaryMinusLong")
operator fun DataColumn<Long>.unaryMinus(): DataColumn<Long>

Returns a DataColumn containing negatives of the corresponding elements of this DataColumn.

Returns a ColumnReference containing negatives of the corresponding elements of this ColumnReference.

Link copied to clipboard
internal fun AnyBaseCol.unbox(): AnyCol
Link copied to clipboard
inline fun <reified T> DataColumn<T>.unfold(vararg roots: KCallable<*>, maxDepth: Int = 0): DataColumn<*>

Returns a ColumnGroup made from the objects of this column, with a column for every public property of these objects, or this column itself when it cannot be unfolded.

Link copied to clipboard
internal fun <T> DataColumn<T>.unfoldImpl(type: KType, body: CreateDataFrameDsl<T>.() -> Unit): AnyCol
Link copied to clipboard
internal fun <T, C> DataColumn<C>.updateImpl(df: DataFrame<T>, filter: RowValueFilter<T, C>?, expression: (AddDataRow<T>, DataColumn<C>, C) -> C?): DataColumn<C>
Link copied to clipboard
internal fun <T> DataColumn<T>.updateWith(values: List<T>): DataColumn<T>

Replaces all values in the column asserting that new values are compatible with the current column kind.

Link copied to clipboard
internal inline fun ColumnsResolver<*>.valueColumnsInternal(crossinline filter: (ValueColumn<*>) -> Boolean): TransformableColumnSet<*>

Returns a TransformableColumnSet containing the value columns that satisfy the given filter.

Link copied to clipboard
fun <T> DataColumn<T>.valueCounts(sort: Boolean = true, ascending: Boolean = false, dropNA: Boolean = true, resultColumn: String = defaultCountColumnName): DataFrame<ValueCount>

Returns a DataFrame containing counts of unique values in this DataColumn.

Link copied to clipboard
open override fun values(): Iterable<T>
Link copied to clipboard

Returns true if this column is intra-comparable (mutually comparable), i.e., its values can be compared with each other and thus ordered.

Link copied to clipboard
inline fun <reified T> ColumnReference<T>.withValues(values: Iterable<T>): ValueColumn<T>
inline fun <reified T> ColumnReference<T>.withValues(vararg values: T): ValueColumn<T>