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

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

Constructors

fun <A : Ring<V>, ScaleOperations<V>> UniformHistogram1DGroup(valueAlgebra: A, binSize: Double, startPoint: Double = 0.0)

Functions

add

open override fun add(left: Histogram1D<Double, V>, right: Histogram1D<Double, V>): UniformHistogram1D<V>

binaryOperation

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

binaryOperationFunction

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

bindSymbol

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

bindSymbolOrNull

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

div

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

export

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

minus

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

plus

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

produce

inline fun produce(block: Histogram1DBuilder<Double, V>.() -> Unit): UniformHistogram1D<V>

Fill histogram.

produceFrom

fun produceFrom(histogram: Histogram1D<Double, V>): UniformHistogram1D<V>

Re-bin given histogram to be compatible if exiting bin fully falls inside existing bin, this bin value is increased by one. If not, all bins including values from this bin are increased by fraction (conserving the norming).

scale

open override fun scale(a: Histogram1D<Double, V>, value: Double): UniformHistogram1D<V>

times

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

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

unaryMinus

open operator override fun Histogram1D<Double, V>.unaryMinus(): UniformHistogram1D<V>

unaryOperation

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

unaryOperationFunction

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

unaryPlus

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

Properties

binSize

val binSize: Double

startPoint

val startPoint: Double = 0.0

valueAlgebra

val valueAlgebra: A

zero

open override val zero: UniformHistogram1D<V>

Extensions

produce

@UnstableKMathAPI

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

Sources

common source