forked from kscience/kmath
Fix Univariate histogram filling
This commit is contained in:
parent
cfe6c3ef4b
commit
94c58b7749
@ -50,6 +50,7 @@
|
|||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
- Ring inherits RingOperations, not GroupOperations
|
- Ring inherits RingOperations, not GroupOperations
|
||||||
|
- Univariate histogram filling
|
||||||
|
|
||||||
### Security
|
### Security
|
||||||
|
|
||||||
|
@ -17,7 +17,7 @@ allprojects {
|
|||||||
}
|
}
|
||||||
|
|
||||||
group = "space.kscience"
|
group = "space.kscience"
|
||||||
version = "0.3.0-dev-13"
|
version = "0.3.0-dev-14"
|
||||||
}
|
}
|
||||||
|
|
||||||
subprojects {
|
subprojects {
|
||||||
|
@ -35,20 +35,13 @@ public class TreeHistogram(
|
|||||||
override val bins: Collection<UnivariateBin> get() = binMap.values
|
override val bins: Collection<UnivariateBin> get() = binMap.values
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
@OptIn(UnstableKMathAPI::class)
|
||||||
* A space for univariate histograms with variable bin borders based on a tree map
|
private class TreeHistogramBuilder(val binFactory: (Double) -> UnivariateDomain) : UnivariateHistogramBuilder {
|
||||||
*/
|
|
||||||
@UnstableKMathAPI
|
|
||||||
public class TreeHistogramSpace(
|
|
||||||
public val binFactory: (Double) -> UnivariateDomain,
|
|
||||||
) : Group<UnivariateHistogram>, ScaleOperations<UnivariateHistogram> {
|
|
||||||
|
|
||||||
private class BinCounter(val domain: UnivariateDomain, val counter: Counter<Double> = Counter.real()) :
|
private class BinCounter(val domain: UnivariateDomain, val counter: Counter<Double> = Counter.real()) :
|
||||||
ClosedFloatingPointRange<Double> by domain.range
|
ClosedFloatingPointRange<Double> by domain.range
|
||||||
|
|
||||||
public fun produce(builder: UnivariateHistogramBuilder.() -> Unit): UnivariateHistogram {
|
private val bins: TreeMap<Double, BinCounter> = TreeMap()
|
||||||
val bins: TreeMap<Double, BinCounter> = TreeMap()
|
|
||||||
val hBuilder = object : UnivariateHistogramBuilder {
|
|
||||||
|
|
||||||
fun get(value: Double): BinCounter? = bins.getBin(value)
|
fun get(value: Double): BinCounter? = bins.getBin(value)
|
||||||
|
|
||||||
@ -69,17 +62,29 @@ public class TreeHistogramSpace(
|
|||||||
}
|
}
|
||||||
|
|
||||||
override fun putValue(point: Buffer<Double>, value: Number) {
|
override fun putValue(point: Buffer<Double>, value: Number) {
|
||||||
put(point[0], value.toDouble())
|
require(point.size == 1) { "Only points with single value could be used in univariate histogram" }
|
||||||
|
putValue(point[0], value.toDouble())
|
||||||
}
|
}
|
||||||
}
|
|
||||||
hBuilder.apply(builder)
|
fun build(): TreeHistogram {
|
||||||
val resBins = TreeMap<Double, UnivariateBin>()
|
val map = bins.mapValuesTo(TreeMap<Double, UnivariateBin>()) { (_, binCounter) ->
|
||||||
bins.forEach { (key, binCounter) ->
|
|
||||||
val count = binCounter.counter.value
|
val count = binCounter.counter.value
|
||||||
resBins[key] = UnivariateBin(binCounter.domain, count, sqrt(count))
|
UnivariateBin(binCounter.domain, count, sqrt(count))
|
||||||
}
|
}
|
||||||
return TreeHistogram(resBins)
|
return TreeHistogram(map)
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A space for univariate histograms with variable bin borders based on a tree map
|
||||||
|
*/
|
||||||
|
@UnstableKMathAPI
|
||||||
|
public class TreeHistogramSpace(
|
||||||
|
private val binFactory: (Double) -> UnivariateDomain,
|
||||||
|
) : Group<UnivariateHistogram>, ScaleOperations<UnivariateHistogram> {
|
||||||
|
|
||||||
|
public fun fill(block: UnivariateHistogramBuilder.() -> Unit): UnivariateHistogram =
|
||||||
|
TreeHistogramBuilder(binFactory).apply(block).build()
|
||||||
|
|
||||||
override fun add(
|
override fun add(
|
||||||
a: UnivariateHistogram,
|
a: UnivariateHistogram,
|
||||||
@ -89,7 +94,8 @@ public class TreeHistogramSpace(
|
|||||||
// require(b.context == this) { "Histogram $b does not belong to this context" }
|
// require(b.context == this) { "Histogram $b does not belong to this context" }
|
||||||
val bins = TreeMap<Double, UnivariateBin>().apply {
|
val bins = TreeMap<Double, UnivariateBin>().apply {
|
||||||
(a.bins.map { it.domain } union b.bins.map { it.domain }).forEach { def ->
|
(a.bins.map { it.domain } union b.bins.map { it.domain }).forEach { def ->
|
||||||
put(def.center,
|
put(
|
||||||
|
def.center,
|
||||||
UnivariateBin(
|
UnivariateBin(
|
||||||
def,
|
def,
|
||||||
value = (a[def.center]?.value ?: 0.0) + (b[def.center]?.value ?: 0.0),
|
value = (a[def.center]?.value ?: 0.0) + (b[def.center]?.value ?: 0.0),
|
||||||
@ -105,7 +111,8 @@ public class TreeHistogramSpace(
|
|||||||
override fun scale(a: UnivariateHistogram, value: Double): UnivariateHistogram {
|
override fun scale(a: UnivariateHistogram, value: Double): UnivariateHistogram {
|
||||||
val bins = TreeMap<Double, UnivariateBin>().apply {
|
val bins = TreeMap<Double, UnivariateBin>().apply {
|
||||||
a.bins.forEach { bin ->
|
a.bins.forEach { bin ->
|
||||||
put(bin.domain.center,
|
put(
|
||||||
|
bin.domain.center,
|
||||||
UnivariateBin(
|
UnivariateBin(
|
||||||
bin.domain,
|
bin.domain,
|
||||||
value = bin.value * value.toDouble(),
|
value = bin.value * value.toDouble(),
|
||||||
@ -120,7 +127,7 @@ public class TreeHistogramSpace(
|
|||||||
|
|
||||||
override fun UnivariateHistogram.unaryMinus(): UnivariateHistogram = this * (-1)
|
override fun UnivariateHistogram.unaryMinus(): UnivariateHistogram = this * (-1)
|
||||||
|
|
||||||
override val zero: UnivariateHistogram = produce { }
|
override val zero: UnivariateHistogram by lazy { fill { } }
|
||||||
|
|
||||||
public companion object {
|
public companion object {
|
||||||
/**
|
/**
|
||||||
|
@ -13,7 +13,7 @@ import space.kscience.kmath.structures.asSequence
|
|||||||
|
|
||||||
@UnstableKMathAPI
|
@UnstableKMathAPI
|
||||||
public val UnivariateDomain.center: Double
|
public val UnivariateDomain.center: Double
|
||||||
get() = (range.endInclusive - range.start) / 2
|
get() = (range.endInclusive + range.start) / 2
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A univariate bin based an a range
|
* A univariate bin based an a range
|
||||||
@ -45,7 +45,7 @@ public interface UnivariateHistogram : Histogram<Double, UnivariateBin>{
|
|||||||
binSize: Double,
|
binSize: Double,
|
||||||
start: Double = 0.0,
|
start: Double = 0.0,
|
||||||
builder: UnivariateHistogramBuilder.() -> Unit,
|
builder: UnivariateHistogramBuilder.() -> Unit,
|
||||||
): UnivariateHistogram = TreeHistogramSpace.uniform(binSize, start).produce(builder)
|
): UnivariateHistogram = TreeHistogramSpace.uniform(binSize, start).fill(builder)
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Build and fill a histogram with custom borders. Returns a read-only histogram.
|
* Build and fill a histogram with custom borders. Returns a read-only histogram.
|
||||||
@ -53,7 +53,7 @@ public interface UnivariateHistogram : Histogram<Double, UnivariateBin>{
|
|||||||
public fun custom(
|
public fun custom(
|
||||||
borders: DoubleArray,
|
borders: DoubleArray,
|
||||||
builder: UnivariateHistogramBuilder.() -> Unit,
|
builder: UnivariateHistogramBuilder.() -> Unit,
|
||||||
): UnivariateHistogram = TreeHistogramSpace.custom(borders).produce(builder)
|
): UnivariateHistogram = TreeHistogramSpace.custom(borders).fill(builder)
|
||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -0,0 +1,24 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2018-2021 KMath contributors.
|
||||||
|
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package space.kscience.kmath.histogram
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test
|
||||||
|
import kotlin.random.Random
|
||||||
|
import kotlin.test.assertTrue
|
||||||
|
|
||||||
|
class TreeHistogramTest {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun normalFill() {
|
||||||
|
val histogram = UnivariateHistogram.uniform(0.1) {
|
||||||
|
repeat(100_000) {
|
||||||
|
putValue(Random.nextDouble())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
assertTrue { histogram.bins.count() > 10 }
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user