From fd4253fc932647f9a1b75d811b243d1c42082420 Mon Sep 17 00:00:00 2001
From: Iaroslav Postovalov <postovalovya@gmail.com>
Date: Sun, 4 Oct 2020 13:54:00 +0700
Subject: [PATCH] Provide bindings for each gsl_matrix except char, uchar,
 long_double because they have no clear KMath analogues

---
 .../kotlin/kscience/kmath/ejml/EjmlMatrix.kt  |   3 -
 .../kotlin/kscience/kmath/gsl/GslMatrices.kt  | 237 ++++++++++++++++++
 .../kscience/kmath/gsl/GslRealMatrix.kt       |  51 ----
 3 files changed, 237 insertions(+), 54 deletions(-)
 create mode 100644 kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrices.kt
 delete mode 100644 kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslRealMatrix.kt

diff --git a/kmath-ejml/src/main/kotlin/kscience/kmath/ejml/EjmlMatrix.kt b/kmath-ejml/src/main/kotlin/kscience/kmath/ejml/EjmlMatrix.kt
index a8892924a..88b8a5162 100644
--- a/kmath-ejml/src/main/kotlin/kscience/kmath/ejml/EjmlMatrix.kt
+++ b/kmath-ejml/src/main/kotlin/kscience/kmath/ejml/EjmlMatrix.kt
@@ -22,9 +22,6 @@ public class EjmlMatrix(public val origin: SimpleMatrix, features: Set<MatrixFea
     public override val colNum: Int
         get() = origin.numCols()
 
-    public override val shape: IntArray
-        get() = intArrayOf(origin.numRows(), origin.numCols())
-
     public override val features: Set<MatrixFeature> = setOf(
         object : LUPDecompositionFeature<Double>, DeterminantFeature<Double> {
             override val determinant: Double
diff --git a/kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrices.kt b/kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrices.kt
new file mode 100644
index 000000000..9381a5e5c
--- /dev/null
+++ b/kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrices.kt
@@ -0,0 +1,237 @@
+package kscience.kmath.gsl
+
+import kotlinx.cinterop.*
+import kscience.kmath.linear.FeaturedMatrix
+import kscience.kmath.linear.MatrixFeature
+import kscience.kmath.operations.Complex
+import kscience.kmath.structures.NDStructure
+import org.gnu.gsl.*
+
+public sealed class GslMatrix<T : Any> : FeaturedMatrix<T> {
+    protected abstract val nativeHandle: CValues<out CStructVar>
+
+    override fun equals(other: Any?): Boolean {
+        return NDStructure.equals(this, other as? NDStructure<*> ?: return false)
+    }
+
+    public override fun hashCode(): Int {
+        var result = nativeHandle.hashCode()
+        result = 31 * result + features.hashCode()
+        return result
+    }
+}
+
+public class GslRealMatrix(protected override val nativeHandle: CValues<gsl_matrix>, features: Set<MatrixFeature>) :
+    GslMatrix<Double>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslRealMatrix =
+        GslRealMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): Double = gsl_matrix_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslRealMatrix) gsl_matrix_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslIntMatrix(protected override val nativeHandle: CValues<gsl_matrix_int>, features: Set<MatrixFeature>) :
+    GslMatrix<Int>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslIntMatrix =
+        GslIntMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): Int = gsl_matrix_int_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslIntMatrix) gsl_matrix_int_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslLongMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_long>,
+    features: Set<MatrixFeature>
+) :
+    GslMatrix<Long>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslLongMatrix =
+        GslLongMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): Long = gsl_matrix_long_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslLongMatrix) gsl_matrix_long_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslFloatMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_float>,
+    features: Set<MatrixFeature>
+) :
+    GslMatrix<Float>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslFloatMatrix =
+        GslFloatMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): Float = gsl_matrix_float_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslFloatMatrix) gsl_matrix_float_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslUIntMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_uint>,
+    features: Set<MatrixFeature>
+) : GslMatrix<UInt>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslUIntMatrix =
+        GslUIntMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): UInt = gsl_matrix_uint_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslUIntMatrix) gsl_matrix_uint_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslULongMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_ulong>,
+    features: Set<MatrixFeature>
+) : GslMatrix<ULong>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslULongMatrix =
+        GslULongMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): ULong = gsl_matrix_ulong_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslULongMatrix) gsl_matrix_ulong_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslUShortMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_ushort>,
+    features: Set<MatrixFeature>
+) : GslMatrix<UShort>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslUShortMatrix =
+        GslUShortMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): UShort = gsl_matrix_ushort_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslUShortMatrix) gsl_matrix_ushort_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslShortMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_short>,
+    features: Set<MatrixFeature>
+) : GslMatrix<Short>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslUShortMatrix =
+        GslShortMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): UShort = gsl_matrix_short_get(nativeHandle, i.toULong(), j.toULong())
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslShortMatrix) gsl_matrix_short_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
+
+public class GslComplexMatrix(
+    protected override val nativeHandle: CValues<gsl_matrix_complex>,
+    features: Set<MatrixFeature>
+) : GslMatrix<Complex>() {
+
+    public override val rowNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
+
+    public override val colNum: Int
+        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
+
+    public override val features: Set<MatrixFeature> = features
+
+    public override fun suggestFeature(vararg features: MatrixFeature): GslComplexMatrix =
+        GslComplexMatrix(nativeHandle, this.features + features)
+
+    public override fun get(i: Int, j: Int): Complex =
+        gsl_matrix_complex_get(nativeHandle, i.toULong(), j.toULong()).useContents { Complex(dat[0], dat[1]) }
+
+    public override fun equals(other: Any?): Boolean {
+        if (other is GslComplexMatrix) gsl_matrix_complex_equal(nativeHandle, other.nativeHandle)
+        return super.equals(other)
+    }
+}
diff --git a/kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslRealMatrix.kt b/kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslRealMatrix.kt
deleted file mode 100644
index 6ef3abdc8..000000000
--- a/kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslRealMatrix.kt
+++ /dev/null
@@ -1,51 +0,0 @@
-package kscience.kmath.gsl
-
-import kotlinx.cinterop.CStructVar
-import kotlinx.cinterop.CValues
-import kotlinx.cinterop.memScoped
-import kotlinx.cinterop.pointed
-import kscience.kmath.linear.FeaturedMatrix
-import kscience.kmath.linear.MatrixFeature
-import kscience.kmath.structures.NDStructure
-import org.gnu.gsl.gsl_matrix
-import org.gnu.gsl.gsl_matrix_equal
-import org.gnu.gsl.gsl_matrix_get
-
-public sealed class GslMatrix<T : Any> : FeaturedMatrix<T> {
-    protected abstract val nativeHandle: CValues<out CStructVar>
-
-    override fun equals(other: Any?): Boolean {
-        return NDStructure.equals(this, other as? NDStructure<*> ?: return false)
-    }
-
-    public override fun hashCode(): Int {
-        var result = nativeHandle.hashCode()
-        result = 31 * result + features.hashCode()
-        return result
-    }
-}
-
-public class GslRealMatrix(protected override val nativeHandle: CValues<gsl_matrix>, features: Set<MatrixFeature>) :
-    GslMatrix<Double>() {
-
-    public override val rowNum: Int
-        get() = memScoped { nativeHandle.getPointer(this).pointed.size1.toInt() }
-
-    public override val colNum: Int
-        get() = memScoped { nativeHandle.getPointer(this).pointed.size2.toInt() }
-
-    public override val shape: IntArray
-        get() = intArrayOf(rowNum, colNum)
-
-    public override val features: Set<MatrixFeature> = features
-
-    public override fun suggestFeature(vararg features: MatrixFeature): GslRealMatrix =
-        GslRealMatrix(nativeHandle, this.features + features)
-
-    public override fun get(i: Int, j: Int): Double = gsl_matrix_get(nativeHandle, i.toULong(), j.toULong())
-
-    public override fun equals(other: Any?): Boolean {
-        if (other is GslRealMatrix) gsl_matrix_equal(nativeHandle, other.nativeHandle)
-        return super.equals(other)
-    }
-}