Package space.kscience.kmath.histogram

Types

Bin

common

interface Bin<in T : Any> : Domain<T>

The binned data element.

Counter

common

interface Counter<T : Any>

Common representation for atomic counters

DomainBin

common

data class DomainBin<in T : Comparable<T>>(domain: Domain<T>, value: Number) : Bin<T> , Domain<T>

A simple histogram bin based on domain

DoubleHistogramSpace

common

class DoubleHistogramSpace(lower: Buffer<Double>, upper: Buffer<Double>, binNums: IntArray) : IndexedHistogramSpace<Double, Double>

Histogram

common

interface Histogram<in T : Any, out B : Bin<T>>

HistogramBuilder

common

fun fun interface HistogramBuilder<in T : Any>

IndexedHistogram

common

class IndexedHistogram<T : Comparable<T>, V : Any>(context: IndexedHistogramSpace<T, V>, values: StructureND<V>) : Histogram<T, Bin<T>>

IndexedHistogramSpace

common

interface IndexedHistogramSpace<T : Comparable<T>, V : Any> : Group<IndexedHistogram<T, V>> , ScaleOperations<IndexedHistogram<T, V>>

A space for producing histograms with values in a NDStructure

IntCounter

common

class IntCounter : Counter<Int>

LongCounter

common

class LongCounter : Counter<Long>

ObjectCounter

common

class ObjectCounter<T : Any>(group: Ring<T>) : Counter<T>

TreeHistogram

jvm

@UnstableKMathAPI()

class TreeHistogram(binMap: TreeMap<Double, out UnivariateBin>) : UnivariateHistogram

TreeHistogramSpace

jvm

@UnstableKMathAPI()

class TreeHistogramSpace(binFactory: (Double) -> UnivariateDomain) : Group<UnivariateHistogram> , ScaleOperations<UnivariateHistogram>

A space for univariate histograms with variable bin borders based on a tree map

UnivariateBin

jvm

@UnstableKMathAPI()

class UnivariateBin(domain: UnivariateDomain, value: Double, standardDeviation: Double) : Bin<Double> , ClosedFloatingPointRange<Double>

A univariate bin based on a range

UnivariateHistogram

jvm

interface UnivariateHistogram : Histogram<Double, UnivariateBin>

UnivariateHistogramBuilder

jvm

@UnstableKMathAPI()

interface UnivariateHistogramBuilder : HistogramBuilder<Double>

Functions

fill

fun <T : Any> HistogramBuilder<T>.fill(sequence: Iterable<Point<T>>)

@UnstableKMathAPI()

fun UnivariateHistogramBuilder.fill(array: DoubleArray)

@UnstableKMathAPI()

fun UnivariateHistogramBuilder.fill(items: Iterable<Double>)

@UnstableKMathAPI()

fun UnivariateHistogramBuilder.fill(buffer: Buffer<Double>)

common

fun <T : Any> HistogramBuilder<T>.fill(block: suspend SequenceScope<Point<T>>.() -> Unit)

Pass a sequence builder into histogram

put

common

fun <T : Any> HistogramBuilder<T>.put(vararg point: T)

fun <T : Any, B : Bin<T>> HistogramBuilder<T>.put(point: Point<out T>)

fun HistogramBuilder<Double>.put(vararg point: Number)

fun HistogramBuilder<Double>.put(vararg point: Double)

Properties

center

jvm

@UnstableKMathAPI()

val UnivariateDomain.center: Double