From 29da5bad2842a08480e5e1403dd97e8d7055a2d8 Mon Sep 17 00:00:00 2001
From: Alexander Nozik <altavir@gmail.com>
Date: Fri, 23 Nov 2018 15:46:14 +0300
Subject: [PATCH] Added phantom histograms

---
 .../scientifik/kmath/histogram/FastHistogram.kt   | 15 +++++++++++++++
 .../kmath/histogram/PhantomHistogram.kt           |  5 +++--
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/FastHistogram.kt b/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/FastHistogram.kt
index 621ea90c0..37c4eed2a 100644
--- a/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/FastHistogram.kt
+++ b/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/FastHistogram.kt
@@ -84,6 +84,21 @@ class FastHistogram(
 
     override fun iterator(): Iterator<MultivariateBin> = bins.asSequence().map { it.second }.iterator()
 
+    /**
+     * Convert this histogram into NDStructure containing bin values but not bin descriptions
+     */
+    fun asND(): NDStructure<Number> {
+        return ndStructure(this.bins.shape) { bins[it].value }
+    }
+
+    /**
+     * Create a phantom lightweight immutable copy of this histogram
+     */
+    fun asPhantom(): PhantomHistogram<Double> {
+        val binTemplates = bins.associate { (index, bin) -> BinTemplate<Double>(bin.center, bin.sizes) to index }
+        return PhantomHistogram(binTemplates, asND())
+    }
+
     companion object {
 
         /**
diff --git a/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/PhantomHistogram.kt b/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/PhantomHistogram.kt
index 041eccfe2..9ea17c730 100644
--- a/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/PhantomHistogram.kt
+++ b/kmath-core/src/commonMain/kotlin/scientifik/kmath/histogram/PhantomHistogram.kt
@@ -4,7 +4,7 @@ import scientifik.kmath.linear.Vector
 import scientifik.kmath.operations.Space
 import scientifik.kmath.structures.NDStructure
 
-class BinTemplate<T : Comparable<T>>(val center: Vector<T>, val sizes: Vector<T>) {
+data class BinTemplate<T : Comparable<T>>(val center: Vector<T>, val sizes: Vector<T>) {
     fun contains(vector: Point<out T>): Boolean {
         if (vector.size != center.size) error("Dimension mismatch for input vector. Expected ${center.size}, but found ${vector.size}")
         val upper = center + sizes/2.0
@@ -40,10 +40,11 @@ class PhantomBin<T : Comparable<T>>(val template: BinTemplate<T>, override val v
 /**
  * Immutable histogram with explicit structure for content and additional external bin description.
  * Bin search is slow, but full histogram algebra is supported.
+ * @param bins map a template into structure index
  */
 class PhantomHistogram<T : Comparable<T>>(
         val bins: Map<BinTemplate<T>, IntArray>,
-        val data: NDStructure<Double>
+        val data: NDStructure<Number>
 ) : Histogram<T, PhantomBin<T>> {
 
     override val dimension: Int