KSLCore/ksl.utilities.maps/DataMap

DataMap

class DataMap(val arraySize: Int, map: MutableMap<String, DoubleArray> = mutableMapOf()) : MutableMap<String, DoubleArray>

A DataMap represents named arrays that have the same size. By construction, the map must have arrays of the same length.

Parameters

arraySize

the size of the arrays to be added to the map. The array must have at least one element.

map

an optional map. If empty, then added arrays must have length arraySize. If not empty, then its arrays must have size arraySize.

Constructors

constructor(arraySize: Int, map: MutableMap<String, DoubleArray> = mutableMapOf())

Properties

val arraySize: Int

open override val entries: MutableSet<MutableMap.MutableEntry<String, DoubleArray>>

open override val keys: MutableSet<String>

open override val size: Int

open override val values: MutableCollection<DoubleArray>

Functions

boxPlotSummaries

fun Map<String, DoubleArray>.boxPlotSummaries(): Map<String, BoxPlotSummary>

Computes the box plot summaries for the data within the map

open override fun clear()

open fun compute(p0: String, p1: BiFunction<in String, in DoubleArray?, out DoubleArray?>): DoubleArray?

computeIfAbsent

open fun computeIfAbsent(p0: String, p1: Function<in String, out DoubleArray>): DoubleArray

computeIfPresent

open fun computeIfPresent(p0: String, p1: BiFunction<in String, in DoubleArray, out DoubleArray?>): DoubleArray?

confidenceIntervals

fun Map<String, DoubleArray>.confidenceIntervals(level: Double = 0.95): Map<String, Interval>

Computes the confidence intervals for the data in the map

open override fun containsKey(key: String): Boolean

open override fun containsValue(value: DoubleArray): Boolean

open fun forEach(p0: BiConsumer<in String, in DoubleArray>)

open operator override fun get(key: String): DoubleArray?

open fun getOrDefault(key: String, defaultValue: DoubleArray): DoubleArray

open override fun isEmpty(): Boolean

fun Map<String, DoubleArray>.isRectangular(): Boolean

The map of arrays is considered rectangular if all arrays in the map have the same number of elements (same size).

fun MutableMap<String, DoubleArray>.maxArraySize(): Int

The size of the array that has maximum size. If empty the array size is 0.

open fun merge(p0: String, p1: DoubleArray, p2: BiFunction<in DoubleArray, in DoubleArray, out DoubleArray?>): DoubleArray?

fun MutableMap<String, DoubleArray>.minArraySize(): Int

The size of the array that has the minimum size. If empty the array size is 0.

open override fun put(key: String, value: DoubleArray): DoubleArray?

open override fun putAll(from: Map<out String, DoubleArray>)

open fun putIfAbsent(p0: String, p1: DoubleArray): DoubleArray?

open override fun remove(key: String): DoubleArray?

open fun remove(key: String, value: DoubleArray): Boolean

open fun replace(p0: String, p1: DoubleArray): DoubleArray?

open fun replace(p0: String, p1: DoubleArray, p2: DoubleArray): Boolean

open fun replaceAll(p0: BiFunction<in String, in DoubleArray, out DoubleArray>)

statisticalSummaries

fun Map<String, DoubleArray>.statisticalSummaries(): Map<String, StatisticIfc>

Computes the statistical summaries for the data within the map

fun Map<String, DoubleArray>.to2DArray(): Array<DoubleArray>

Converts the data map to a 2-D array. The values of the map are extracted

fun Map<String, DoubleArray>.toDataFrame(): AnyFrame

Converts the data stored in each array to columns within a DataFrame, with the column names as the key from the map and the columns holding the data. Each array must have the same size.

fun Map<String, Double>.toJson(): String

fun Map<String, DoubleArray>.toMapOfLists(): Map<String, List<Double>>

Converts the inner DoubleArray to List

toObservationData

fun Map<String, DoubleArray>.toObservationData(tableName: String = "tblObservations", context: String? = null, subject: String? = null): List<ObservationDataDb>

Converts the data map to a long format view of the observations.