Merge branch 'dev' into altavir/tensor-algebra

CHANGELOG.md

@@ -4,27 +4,28 @@
 ### Added
 - `fun` annotation for SAM interfaces in library
 - Explicit `public` visibility for all public APIs
-- Better trigonometric and hyperbolic functions for `AutoDiffField` (https://github.com/mipt-npm/kmath/pull/140).
+- Better trigonometric and hyperbolic functions for `AutoDiffField` (https://github.com/mipt-npm/kmath/pull/140)
 - Automatic README generation for features (#139)
 - Native support for `memory`, `core` and `dimensions`
-- `kmath-ejml` to supply EJML SimpleMatrix wrapper (https://github.com/mipt-npm/kmath/pull/136).
+- `kmath-ejml` to supply EJML SimpleMatrix wrapper (https://github.com/mipt-npm/kmath/pull/136)
 - A separate `Symbol` entity, which is used for global unbound symbol.
 - A `Symbol` indexing scope.
 - Basic optimization API for Commons-math.
 - Chi squared optimization for array-like data in CM
 - `Fitting` utility object in prob/stat
-- ND4J support module submitting `NDStructure` and `NDAlgebra` over `INDArray`.
-- Coroutine-deterministic Monte-Carlo scope with a random number generator.
-- Some minor utilities to `kmath-for-real`.
+- ND4J support module submitting `NDStructure` and `NDAlgebra` over `INDArray`
+- Coroutine-deterministic Monte-Carlo scope with a random number generator
+- Some minor utilities to `kmath-for-real`
 - Generic operation result parameter to `MatrixContext`
+- New `MatrixFeature` interfaces for matrix decompositions
 
 ### Changed
-- Package changed from `scientifik` to `kscience.kmath`.
-- Gradle version: 6.6 -> 6.7.1
+- Package changed from `scientifik` to `kscience.kmath`
+- Gradle version: 6.6 -> 6.8
 - Minor exceptions refactor (throwing `IllegalArgumentException` by argument checks instead of `IllegalStateException`)
-- `Polynomial` secondary constructor made function.
-- Kotlin version: 1.3.72 -> 1.4.20
-- `kmath-ast` doesn't depend on heavy `kotlin-reflect` library.
+- `Polynomial` secondary constructor made function
+- Kotlin version: 1.3.72 -> 1.4.21
+- `kmath-ast` doesn't depend on heavy `kotlin-reflect` library
 - Full autodiff refactoring based on `Symbol`
 - `kmath-prob` renamed to `kmath-stat`
 - Grid generators moved to `kmath-for-real`

kmath-core/src/commonMain/kotlin/kscience/kmath/linear/BufferMatrix.kt

@@ -43,7 +43,7 @@ public class BufferMatrix<T : Any>(
         if (this === other) return true
 
         return when (other) {
-            is NDStructure<*> -> NDStructure.equals(this, other)
+            is NDStructure<*> -> NDStructure.contentEquals(this, other)
             else -> false
         }
     }

kmath-core/src/commonMain/kotlin/kscience/kmath/structures/NDStructure.kt

@@ -54,7 +54,7 @@ public interface NDStructure<T> {
         /**
          * Indicates whether some [NDStructure] is equal to another one.
          */
-        public fun equals(st1: NDStructure<*>, st2: NDStructure<*>): Boolean {
+        public fun contentEquals(st1: NDStructure<*>, st2: NDStructure<*>): Boolean {
             if (st1 === st2) return true
 
             // fast comparison of buffers if possible
@@ -275,7 +275,7 @@ public abstract class NDBuffer<T> : NDStructure<T> {
     override fun elements(): Sequence<Pair<IntArray, T>> = strides.indices().map { it to this[it] }
 
     override fun equals(other: Any?): Boolean {
-        return NDStructure.equals(this, other as? NDStructure<*> ?: return false)
+        return NDStructure.contentEquals(this, other as? NDStructure<*> ?: return false)
     }
 
     override fun hashCode(): Int {

kmath-coroutines/src/jvmMain/kotlin/kscience/kmath/structures/LazyNDStructure.kt

@@ -24,7 +24,7 @@ public class LazyNDStructure<T>(
     }
 
     public override fun equals(other: Any?): Boolean {
-        return NDStructure.equals(this, other as? NDStructure<*> ?: return false)
+        return NDStructure.contentEquals(this, other as? NDStructure<*> ?: return false)
     }
 
     public override fun hashCode(): Int {

kmath-ejml/src/main/kotlin/kscience/kmath/ejml/EjmlMatrix.kt

@@ -3,6 +3,7 @@ package kscience.kmath.ejml
 import kscience.kmath.linear.*
 import kscience.kmath.misc.UnstableKMathAPI
 import kscience.kmath.structures.Matrix
+import kscience.kmath.structures.NDStructure
 import kscience.kmath.structures.RealBuffer
 import org.ejml.dense.row.factory.DecompositionFactory_DDRM
 import org.ejml.simple.SimpleMatrix
@@ -15,7 +16,7 @@ import kotlin.reflect.cast
  * @property origin the underlying [SimpleMatrix].
  * @author Iaroslav Postovalov
  */
-public inline class EjmlMatrix(
+public class EjmlMatrix(
     public val origin: SimpleMatrix,
 ) : Matrix<Double> {
     public override val rowNum: Int get() = origin.numRows()
@@ -49,7 +50,7 @@ public inline class EjmlMatrix(
             override val q: Matrix<Double> by lazy { EjmlMatrix(SimpleMatrix(qr.getQ(null, false))) }
             override val r: Matrix<Double> by lazy { EjmlMatrix(SimpleMatrix(qr.getR(null, false))) }
         }
-        CholeskyDecompositionFeature::class ->         object : CholeskyDecompositionFeature<Double> {
+        CholeskyDecompositionFeature::class -> object : CholeskyDecompositionFeature<Double> {
             override val l: Matrix<Double> by lazy {
                 val cholesky =
                     DecompositionFactory_DDRM.chol(rowNum, true).apply { decompose(origin.ddrm.copy()) }
@@ -57,7 +58,7 @@ public inline class EjmlMatrix(
                 EjmlMatrix(SimpleMatrix(cholesky.getT(null))) + LFeature
             }
         }
-        LupDecompositionFeature::class ->         object : LupDecompositionFeature<Double> {
+        LupDecompositionFeature::class -> object : LupDecompositionFeature<Double> {
             private val lup by lazy {
                 DecompositionFactory_DDRM.lu(origin.numRows(), origin.numCols()).apply { decompose(origin.ddrm.copy()) }
             }
@@ -73,7 +74,17 @@ public inline class EjmlMatrix(
             override val p: Matrix<Double> by lazy { EjmlMatrix(SimpleMatrix(lup.getRowPivot(null))) }
         }
         else -> null
-    }?.let{type.cast(it)}
+    }?.let { type.cast(it) }
 
     public override operator fun get(i: Int, j: Int): Double = origin[i, j]
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (other !is Matrix<*>) return false
+        return NDStructure.contentEquals(this, other)
+    }
+
+    override fun hashCode(): Int = origin.hashCode()
+
+
 }