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

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.

Parameters

bufferFactory

is an optional parameter used to optimize buffer production.

Constructors

UniformHistogramGroupND

fun <V : Any, A : Field<V>> UniformHistogramGroupND(valueAlgebraND: FieldOpsND<V, A>, lower: Buffer<Double>, upper: Buffer<Double>, binNums: IntArray = IntArray(lower.size) { 20 }, bufferFactory: BufferFactory<V> = Buffer.Companion::boxing)

Functions

add

open override fun add(left: HistogramND<Double, HyperSquareDomain, V>, right: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

binaryOperation

open fun binaryOperation(operation: String, left: HistogramND<Double, HyperSquareDomain, V>, right: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

binaryOperationFunction

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

bindSymbol

open fun bindSymbol(value: String): HistogramND<Double, HyperSquareDomain, V>

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): HistogramND<Double, HyperSquareDomain, V>?

div

open operator fun HistogramND<Double, HyperSquareDomain, V>.div(k: Number): HistogramND<Double, HyperSquareDomain, V>

export

open fun export(arg: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

getDomain

open override fun getDomain(index: IntArray): HyperSquareDomain

Get a bin domain represented by given index

getIndexOrNull

open override fun getIndexOrNull(point: Buffer<Double>): IntArray

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

minus

open operator fun HistogramND<Double, HyperSquareDomain, V>.minus(arg: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

plus

open operator fun HistogramND<Double, HyperSquareDomain, V>.plus(arg: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

produce

open override fun produce(builder: HistogramBuilder<Double, V>.() -> Unit): HistogramND<Double, HyperSquareDomain, V>

produceBin

open override fun produceBin(index: IntArray, value: V): HyperSquareBin<V>

scale

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

times

open operator fun Number.times(arg: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

open operator fun HistogramND<Double, HyperSquareDomain, V>.times(k: Number): HistogramND<Double, HyperSquareDomain, V>

unaryMinus

open operator override fun HistogramND<Double, HyperSquareDomain, V>.unaryMinus(): HistogramND<Double, HyperSquareDomain, V>

unaryOperation

open fun unaryOperation(operation: String, arg: HistogramND<Double, HyperSquareDomain, V>): HistogramND<Double, HyperSquareDomain, V>

unaryOperationFunction

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

unaryPlus

open operator fun HistogramND<Double, HyperSquareDomain, V>.unaryPlus(): HistogramND<Double, HyperSquareDomain, V>

Properties

dimension

val dimension: Int

shape

open override val shape: IntArray

valueAlgebraND

open override val valueAlgebraND: FieldOpsND<V, A>

zero

open override val zero: HistogramND<Double, HyperSquareDomain, V>

Sources

common source