kmath-histograms/space.kscience.kmath.histogram

Package space.kscience.kmath.histogram

Types

Bin

interface Bin<in T : Any, out V> : Domain<T>

The binned data element. Could be a histogram bin with a number of counts or an artificial construct.

Bin1D

@UnstableKMathAPI

data class Bin1D<T : Comparable<T>, out V>(domain: Domain1D<T>, binValue: V) : Bin<T, V> , ClosedRange<T>

A univariate bin based on a range

Counter

interface Counter<T : Any>

Common representation for atomic counters

DomainBin

data class DomainBin<in T : Comparable<T>, D : Domain<T>, out V>(domain: D, binValue: V) : Bin<T, V> , Domain<T>

A simple histogram bin based on domain

Histogram

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

Histogram1D

interface Histogram1D<T : Comparable<T>, V> : Histogram<T, V, Bin1D<T, V>>

Histogram1DBuilder

interface Histogram1DBuilder<in T : Any, V : Any> : HistogramBuilder<T, V>

HistogramBuilder

interface HistogramBuilder<in T : Any, V : Any>

HistogramGroupND

interface HistogramGroupND<T : Comparable<T>, D : Domain<T>, V : Any> : Group<HistogramND<T, D, V>> , ScaleOperations<HistogramND<T, D, V>>

A space for producing histograms with values in a NDStructure

HistogramND

class HistogramND<T : Comparable<T>, D : Domain<T>, V : Any>(group: HistogramGroupND<T, D, V>, values: StructureND<V>) : Histogram<T, V, DomainBin<T, D, V>>

HyperSquareBin

typealias HyperSquareBin<V> = DomainBin<Double, HyperSquareDomain, V>

IntCounter

class IntCounter : Counter<Int>

LongCounter

class LongCounter : Counter<Long>

ObjectCounter

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

TreeHistogram

class TreeHistogram<V : Any>(binMap: TreeMap<Double, Bin1D<Double, V>>) : Histogram1D<Double, V>

A histogram based on a tree map of values

TreeHistogramGroup

class TreeHistogramGroup<V : Any, A : Ring<V>, ScaleOperations<V>>(valueAlgebra: A, binFactory: (Double) -> DoubleDomain1D) : Group<TreeHistogram<V>> , ScaleOperations<TreeHistogram<V>>

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

UniformHistogram1D

class UniformHistogram1D<V : Any>(group: UniformHistogram1DGroup<V, *>, values: Map<Int, V>) : Histogram1D<Double, V>

UniformHistogram1DGroup

class UniformHistogram1DGroup<V : Any, A : Ring<V>, ScaleOperations<V>>(valueAlgebra: A, binSize: Double, startPoint: Double) : Group<Histogram1D<Double, V>> , ScaleOperations<Histogram1D<Double, V>>

An algebra for uniform histograms in 1D real space

UniformHistogramGroupND

class UniformHistogramGroupND<V : Any, A : Field<V>>(valueAlgebraND: FieldOpsND<V, A>, lower: Buffer<Double>, upper: Buffer<Double>, binNums: IntArray, bufferFactory: BufferFactory<V>) : HistogramGroupND<Double, HyperSquareDomain, V>

Multivariate histogram space for hyper-square real-field bins.

Functions

custom1D

fun <V : Any, A : Ring<V>, ScaleOperations<V>> Histogram.Companion.custom1D(valueAlgebra: A, borders: Buffer<Double>): TreeHistogramGroup<V, A>

Create a histogram group with custom cell borders

dec

operator fun IntCounter.dec(): IntCounter

operator fun LongCounter.dec(): LongCounter

fill

@UnstableKMathAPI

fun <T : Any> Histogram1DBuilder<T, *>.fill(buffer: Buffer<T>)

@UnstableKMathAPI

fun Histogram1DBuilder<Double, *>.fill(array: DoubleArray)

@UnstableKMathAPI

fun Histogram1DBuilder<Double, *>.fill(items: Iterable<Double>)

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

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

Pass a sequence builder into histogram

inc

operator fun IntCounter.inc(): IntCounter

operator fun LongCounter.inc(): LongCounter

produce

@UnstableKMathAPI

fun <V : Any> UniformHistogram1DGroup<V, *>.produce(buffer: Buffer<Double>): UniformHistogram1D<V>

put

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

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

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

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

uniform1D

fun <V : Any, A : Ring<V>, ScaleOperations<V>> Histogram.Companion.uniform1D(valueAlgebra: A, binSize: Double, startPoint: Double = 0.0): UniformHistogram1DGroup<V, A>

uniformDoubleNDFromRanges

fun Histogram.Companion.uniformDoubleNDFromRanges(vararg ranges: Pair<ClosedFloatingPointRange<Double>, Int>): UniformHistogramGroupND<Double, DoubleField>

fun Histogram.Companion.uniformDoubleNDFromRanges(vararg ranges: ClosedFloatingPointRange<Double>): UniformHistogramGroupND<Double, DoubleField>

uniformNDFromRanges

fun <V : Any, A : Field<V>> Histogram.Companion.uniformNDFromRanges(valueAlgebraND: FieldOpsND<V, A>, vararg ranges: Pair<ClosedFloatingPointRange<Double>, Int>, bufferFactory: BufferFactory<V> = Buffer.Companion::boxing): UniformHistogramGroupND<V, A>

fun <V : Any, A : Field<V>> Histogram.Companion.uniformNDFromRanges(valueAlgebraND: FieldOpsND<V, A>, vararg ranges: ClosedFloatingPointRange<Double>, bufferFactory: BufferFactory<V> = Buffer.Companion::boxing): UniformHistogramGroupND<V, A>

Use it like

Properties

binValues

val <V : Any> UniformHistogram1D<V>.binValues: Map<Double, V>

Map of bin centers to bin values

center

val Bin1D<Double, *>.center: Double