kmath-histograms/space.kscience.kmath.histogram/HistogramGroupND

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

Functions

add

open override fun add(left: HistogramND<T, D, V>, right: HistogramND<T, D, V>): HistogramND<T, D, V>

binaryOperation

open fun binaryOperation(operation: String, left: HistogramND<T, D, V>, right: HistogramND<T, D, V>): HistogramND<T, D, V>

binaryOperationFunction

open override fun binaryOperationFunction(operation: String): (left: HistogramND<T, D, V>, right: HistogramND<T, D, V>) -> HistogramND<T, D, V>

bindSymbol

open fun bindSymbol(value: String): HistogramND<T, D, V>

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): HistogramND<T, D, V>?

div

open operator fun HistogramND<T, D, V>.div(k: Number): HistogramND<T, D, V>

export

open fun export(arg: HistogramND<T, D, V>): HistogramND<T, D, V>

getDomain

abstract fun getDomain(index: IntArray): Domain<T>?

Get a bin domain represented by given index

getIndexOrNull

abstract fun getIndexOrNull(point: Point<T>): IntArray?

Resolve index of the bin including given point. Return null if point is outside histogram area

minus

open operator fun HistogramND<T, D, V>.minus(arg: HistogramND<T, D, V>): HistogramND<T, D, V>

plus

open operator fun HistogramND<T, D, V>.plus(arg: HistogramND<T, D, V>): HistogramND<T, D, V>

produce

abstract fun produce(builder: HistogramBuilder<T, V>.() -> Unit): HistogramND<T, D, V>

produceBin

abstract fun produceBin(index: IntArray, value: V): DomainBin<T, D, V>

scale

open override fun scale(a: HistogramND<T, D, V>, value: Double): HistogramND<T, D, V>

times

open operator fun Number.times(arg: HistogramND<T, D, V>): HistogramND<T, D, V>

open operator fun HistogramND<T, D, V>.times(k: Number): HistogramND<T, D, V>

unaryMinus

abstract operator fun HistogramND<T, D, V>.unaryMinus(): HistogramND<T, D, V>

unaryOperation

open fun unaryOperation(operation: String, arg: HistogramND<T, D, V>): HistogramND<T, D, V>

unaryOperationFunction

open override fun unaryOperationFunction(operation: String): (arg: HistogramND<T, D, V>) -> HistogramND<T, D, V>

unaryPlus

open operator fun HistogramND<T, D, V>.unaryPlus(): HistogramND<T, D, V>

Properties

shape

abstract val shape: Shape

valueAlgebraND

abstract val valueAlgebraND: FieldOpsND<V, *>

zero

open override val zero: HistogramND<T, D, V>

Inheritors

UniformHistogramGroupND

Sources

common source