Extract complex and quaternion systems to another module

examples/build.gradle.kts

@@ -30,6 +30,7 @@ dependencies {
     implementation(project(":kmath-core"))
     implementation(project(":kmath-coroutines"))
     implementation(project(":kmath-commons"))
+    implementation(project(":kmath-complex"))
     implementation(project(":kmath-stat"))
     implementation(project(":kmath-viktor"))
     implementation(project(":kmath-dimensions"))

examples/src/main/kotlin/kscience/kmath/operations/ComplexDemo.kt

@@ -1,12 +1,13 @@
 package kscience.kmath.operations
 
+import kscience.kmath.complex.Complex
+import kscience.kmath.complex.complex
 import kscience.kmath.structures.NDElement
 import kscience.kmath.structures.NDField
-import kscience.kmath.structures.complex
 
 fun main() {
     // 2d element
-    val element = NDElement.complex(2, 2) { (i,j) ->
+    val element = NDElement.complex(2, 2) { (i, j) ->
         Complex(i.toDouble() - j.toDouble(), i.toDouble() + j.toDouble())
     }
     println(element)

examples/src/main/kotlin/kscience/kmath/stat/DistributionBenchmark.kt

@@ -1,10 +1,8 @@
-package kscience.kmath.commons.prob
+package kscience.kmath.stat
 
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.async
 import kotlinx.coroutines.runBlocking
-import kscience.kmath.chains.BlockingRealChain
-import kscience.kmath.stat.*
 import org.apache.commons.rng.sampling.distribution.ZigguratNormalizedGaussianSampler
 import org.apache.commons.rng.simple.RandomSource
 import java.time.Duration
@@ -13,7 +11,7 @@ import java.time.Instant
 private fun runChain(): Duration {
     val generator = RandomGenerator.fromSource(RandomSource.MT, 123L)
     val normal = Distribution.normal(NormalSamplerMethod.Ziggurat)
-    val chain = normal.sample(generator) as BlockingRealChain
+    val chain = normal.sample(generator)
     val startTime = Instant.now()
     var sum = 0.0
 

examples/src/main/kotlin/kscience/kmath/structures/ComplexND.kt

@@ -1,8 +1,10 @@
 package kscience.kmath.structures
 
+import kscience.kmath.complex.Complex
+import kscience.kmath.complex.ComplexField
+import kscience.kmath.complex.complex
+import kscience.kmath.complex.nd
 import kscience.kmath.linear.transpose
-import kscience.kmath.operations.Complex
-import kscience.kmath.operations.ComplexField
 import kscience.kmath.operations.invoke
 import kotlin.system.measureTimeMillis
 
@@ -16,9 +18,7 @@ fun main() {
     val realTime = measureTimeMillis {
         realField {
             var res: NDBuffer<Double> = one
-            repeat(n) {
+            repeat(n) { res += 1.0 }
-                res += 1.0
-            }
         }
     }
 
@@ -40,7 +40,6 @@ fun complexExample() {
         nd(4, 8) {
             //a constant real-valued structure
             val x = one * 2.5
-            operator fun Number.plus(other: Complex) = Complex(this.toDouble() + other.re, other.im)
             //a structure generator specific to this context
             val matrix = produce { (k, l) -> k + l * i }
             //Perform sum

kmath-ast/build.gradle.kts

@@ -25,6 +25,12 @@ kotlin.sourceSets {
         }
     }
 
+    commonTest {
+        dependencies {
+            implementation(project(":kmath-complex"))
+        }
+    }
+
     jsMain {
         dependencies {
             implementation(npm("astring", "1.4.3"))

kmath-ast/src/jsTest/kotlin/kscience/kmath/estree/TestESTreeConsistencyWithInterpreter.kt

@@ -1,11 +1,11 @@
 package kscience.kmath.estree
 
 import kscience.kmath.ast.*
+import kscience.kmath.complex.ComplexField
+import kscience.kmath.complex.toComplex
 import kscience.kmath.expressions.invoke
 import kscience.kmath.operations.ByteRing
-import kscience.kmath.operations.ComplexField
 import kscience.kmath.operations.RealField
-import kscience.kmath.operations.toComplex
 import kotlin.test.Test
 import kotlin.test.assertEquals
 

kmath-ast/src/jvmMain/kotlin/kscience/kmath/asm/internal/AsmBuilder.kt

@@ -191,7 +191,7 @@ internal class AsmBuilder<T>(
         }
 
         val cls = classLoader.defineClass(className, classWriter.toByteArray())
-        java.io.File("dump.class").writeBytes(classWriter.toByteArray())
+        // java.io.File("dump.class").writeBytes(classWriter.toByteArray())
         val l = MethodHandles.publicLookup()
 
         if (hasConstants)

kmath-ast/src/jvmTest/kotlin/kscience/kmath/asm/TestAsmConsistencyWithInterpreter.kt

@@ -1,11 +1,10 @@
 package kscience.kmath.asm
 
 import kscience.kmath.ast.*
+import kscience.kmath.complex.*
 import kscience.kmath.expressions.invoke
 import kscience.kmath.operations.ByteRing
-import kscience.kmath.operations.ComplexField
 import kscience.kmath.operations.RealField
-import kscience.kmath.operations.toComplex
 import kotlin.test.Test
 import kotlin.test.assertEquals
 

kmath-ast/src/jvmTest/kotlin/kscience/kmath/ast/ParserTest.kt

@@ -1,9 +1,9 @@
 package kscience.kmath.ast
 
+import kscience.kmath.complex.Complex
+import kscience.kmath.complex.ComplexField
 import kscience.kmath.expressions.invoke
 import kscience.kmath.operations.Algebra
-import kscience.kmath.operations.Complex
-import kscience.kmath.operations.ComplexField
 import kscience.kmath.operations.RealField
 import kotlin.test.Test
 import kotlin.test.assertEquals

kmath-commons/build.gradle.kts

@@ -5,6 +5,7 @@ description = "Commons math binding for kmath"
 
 dependencies {
     api(project(":kmath-core"))
+    api(project(":kmath-complex"))
     api(project(":kmath-coroutines"))
     api(project(":kmath-stat"))
     api(project(":kmath-functions"))

kmath-commons/src/main/kotlin/kscience/kmath/commons/transform/Transformations.kt

@@ -3,7 +3,7 @@ package kscience.kmath.commons.transform
 import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.map
-import kscience.kmath.operations.Complex
+import kscience.kmath.complex.*
 import kscience.kmath.streaming.chunked
 import kscience.kmath.streaming.spread
 import kscience.kmath.structures.*

kmath-complex/build.gradle.kts

@@ -0,0 +1,28 @@
+plugins {
+    id("ru.mipt.npm.mpp")
+    id("ru.mipt.npm.native")
+}
+
+kotlin.sourceSets.commonMain {
+    dependencies {
+        api(project(":kmath-core"))
+    }
+}
+
+readme {
+    description = "Complex numbers and quaternions."
+    maturity = ru.mipt.npm.gradle.Maturity.DEVELOPMENT
+    propertyByTemplate("artifact", rootProject.file("docs/templates/ARTIFACT-TEMPLATE.md"))
+
+    feature(
+        id = "complex",
+        description = "Complex Numbers",
+        ref = "src/commonMain/kotlin/kscience/kmath/operations/Algebra.kt"
+    )
+
+    feature(
+        id = "quaternion",
+        description = "Quaternions",
+        ref = "src/commonMain/kotlin/kscience/kmath/structures/NDStructure.kt"
+    )
+}

kmath-complex/src/commonMain/kotlin/kscience/kmath/complex/Complex.kt

@@ -1,8 +1,11 @@
-package kscience.kmath.operations
+package kscience.kmath.complex
 
 import kscience.kmath.memory.MemoryReader
 import kscience.kmath.memory.MemorySpec
 import kscience.kmath.memory.MemoryWriter
+import kscience.kmath.operations.ExtendedField
+import kscience.kmath.operations.FieldElement
+import kscience.kmath.operations.Norm
 import kscience.kmath.structures.Buffer
 import kscience.kmath.structures.MemoryBuffer
 import kscience.kmath.structures.MutableBuffer

kmath-complex/src/commonMain/kotlin/kscience/kmath/complex/ComplexNDField.kt

@@ -1,12 +1,13 @@
-package kscience.kmath.structures
+package kscience.kmath.complex
 
-import kscience.kmath.operations.Complex
-import kscience.kmath.operations.ComplexField
 import kscience.kmath.operations.FieldElement
-import kscience.kmath.operations.complex
+import kscience.kmath.structures.*
 import kotlin.contracts.InvocationKind
 import kotlin.contracts.contract
 
+/**
+ * Convenience alias for [BufferedNDFieldElement] of [Complex].
+ */
 public typealias ComplexNDElement = BufferedNDFieldElement<Complex, ComplexField>
 
 /**

kmath-complex/src/commonMain/kotlin/kscience/kmath/complex/Quaternion.kt

@@ -1,8 +1,9 @@
-package kscience.kmath.operations
+package kscience.kmath.complex
 
 import kscience.kmath.memory.MemoryReader
 import kscience.kmath.memory.MemorySpec
 import kscience.kmath.memory.MemoryWriter
+import kscience.kmath.operations.*
 import kscience.kmath.structures.Buffer
 import kscience.kmath.structures.MemoryBuffer
 import kscience.kmath.structures.MutableBuffer
@@ -13,14 +14,14 @@ import kotlin.math.*
  * This quaternion's conjugate.
  */
 public val Quaternion.conjugate: Quaternion
-    get() = QuaternionField { z - x * i - y * j - z * k }
+    get() = QuaternionField { z - x * QuaternionField.i - y * QuaternionField.j - z * QuaternionField.k }
 
 /**
  * This quaternion's reciprocal.
  */
 public val Quaternion.reciprocal: Quaternion
     get() {
-        val n = QuaternionField { norm(this@reciprocal) }
+        val n = QuaternionField { QuaternionField.norm(this@reciprocal) }
         return conjugate / (n * n)
     }
 
@@ -139,7 +140,7 @@ public object QuaternionField : Field<Quaternion>, Norm<Quaternion, Quaternion>,
             return if (arg.w > 0)
                 Quaternion(ln(arg.w), 0, 0, 0)
             else {
-                val l = ComplexField { ln(arg.w.toComplex()) }
+                val l = ComplexField { ComplexField.ln(arg.w.toComplex()) }
                 Quaternion(l.re, l.im, 0, 0)
             }
 

kmath-complex/src/commonTest/kotlin/kscience/kmath/complex/ComplexFieldTest.kt

@@ -1,6 +1,6 @@
-package kscience.kmath.operations
+package kscience.kmath.complex
 
-import kscience.kmath.operations.internal.FieldVerifier
+import kscience.kmath.operations.invoke
 import kotlin.math.PI
 import kotlin.math.abs
 import kotlin.test.Test
@@ -8,8 +8,9 @@ import kotlin.test.assertEquals
 import kotlin.test.assertTrue
 
 internal class ComplexFieldTest {
-    @Test
+    //    TODO make verifier classes available in this source set
-    fun verify() = ComplexField { FieldVerifier(this, 42.0 * i, 66.0 + 28 * i, 2.0 + 0 * i, 5).verify() }
+    //    @Test
+    //    fun verify() = ComplexField { FieldVerifier(this, 42.0 * i, 66.0 + 28 * i, 2.0 + 0 * i, 5).verify() }
 
     @Test
     fun testAddition() {

kmath-complex/src/commonTest/kotlin/kscience/kmath/complex/ComplexTest.kt

@@ -1,4 +1,4 @@
-package kscience.kmath.operations
+package kscience.kmath.complex
 
 import kotlin.math.sqrt
 import kotlin.test.Test

kmath-complex/src/commonTest/kotlin/kscience/kmath/complex/QuaternionFieldTest.kt

@@ -1,5 +1,6 @@
-package kscience.kmath.operations
+package kscience.kmath.complex
 
+import kscience.kmath.operations.invoke
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertTrue

kmath-core/build.gradle.kts

@@ -3,10 +3,18 @@ plugins {
     id("ru.mipt.npm.native")
 }
 
-kotlin.sourceSets.commonMain {
+kotlin.sourceSets {
+    commonMain {
         dependencies {
             api(project(":kmath-memory"))
         }
+    }
+
+    commonTest {
+        dependencies {
+            api(project(":kmath-complex"))
+        }
+    }
 }
 
 readme {

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

@@ -1,7 +1,5 @@
 package kscience.kmath.structures
 
-import kscience.kmath.operations.Complex
-import kscience.kmath.operations.complex
 import kotlin.reflect.KClass
 
 /**
@@ -76,7 +74,6 @@ public interface Buffer<T> {
                 Int::class -> IntBuffer(size) { initializer(it) as Int } as Buffer<T>
                 Long::class -> LongBuffer(size) { initializer(it) as Long } as Buffer<T>
                 Float::class -> FloatBuffer(size) { initializer(it) as Float } as Buffer<T>
-                Complex::class -> complex(size) { initializer(it) as Complex } as Buffer<T>
                 else -> boxing(size, initializer)
             }
 
@@ -149,7 +146,6 @@ public interface MutableBuffer<T> : Buffer<T> {
                 Int::class -> IntBuffer(size) { initializer(it) as Int } as MutableBuffer<T>
                 Float::class -> FloatBuffer(size) { initializer(it) as Float } as MutableBuffer<T>
                 Long::class -> LongBuffer(size) { initializer(it) as Long } as MutableBuffer<T>
-                Complex::class -> complex(size) { initializer(it) as Complex } as MutableBuffer<T>
                 else -> boxing(size, initializer)
             }
 

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

@@ -1,6 +1,5 @@
 package kscience.kmath.structures
 
-import kscience.kmath.operations.Complex
 import kscience.kmath.operations.Field
 import kscience.kmath.operations.Ring
 import kscience.kmath.operations.Space
@@ -252,7 +251,6 @@ public interface NDField<T, F : Field<T>, N : NDStructure<T>> : Field<N>, NDRing
         public inline fun <reified T : Any, F : Field<T>> auto(field: F, vararg shape: Int): BufferedNDField<T, F> =
             when {
                 T::class == Double::class -> real(*shape) as BufferedNDField<T, F>
-                T::class == Complex::class -> complex(*shape) as BufferedNDField<T, F>
                 else -> BoxingNDField(shape, field, Buffer.Companion::auto)
             }
     }

kmath-core/src/commonTest/kotlin/kscience/kmath/expressions/ExpressionFieldTest.kt

@@ -1,8 +1,7 @@
 package kscience.kmath.expressions
 
-import kscience.kmath.operations.Complex
-import kscience.kmath.operations.ComplexField
 import kscience.kmath.operations.RealField
+import kscience.kmath.complex.*
 import kscience.kmath.operations.invoke
 import kotlin.test.Test
 import kotlin.test.assertEquals
@@ -10,6 +9,7 @@ import kotlin.test.assertFails
 
 class ExpressionFieldTest {
     val x by symbol
+
     @Test
     fun testExpression() {
         val context = FunctionalExpressionField(RealField)
@@ -20,7 +20,7 @@ class ExpressionFieldTest {
         }
 
         assertEquals(expression(x to 1.0), 4.0)
-        assertFails {  expression()}
+        assertFails { expression() }
     }
 
     @Test

kmath-core/src/commonTest/kotlin/kscience/kmath/operations/BigIntAlgebraTest.kt

@@ -1,6 +1,6 @@
 package kscience.kmath.operations
 
-import kscience.kmath.operations.internal.RingVerifier
+import kscience.kmath.testutils.RingVerifier
 import kotlin.test.Test
 import kotlin.test.assertEquals
 

kmath-core/src/commonTest/kotlin/kscience/kmath/operations/RealFieldTest.kt

@@ -1,6 +1,6 @@
 package kscience.kmath.operations
 
-import kscience.kmath.operations.internal.FieldVerifier
+import kscience.kmath.testutils.FieldVerifier
 import kotlin.test.Test
 import kotlin.test.assertEquals
 

kmath-core/src/commonTest/kotlin/kscience/kmath/structures/ComplexBufferSpecTest.kt

@@ -1,7 +1,7 @@
 package kscience.kmath.structures
 
-import kscience.kmath.operations.Complex
+import kscience.kmath.complex.Complex
-import kscience.kmath.operations.complex
+import kscience.kmath.complex.complex
 import kotlin.test.Test
 import kotlin.test.assertEquals
 

kmath-core/src/commonTest/kotlin/kscience/kmath/structures/NDFieldTest.kt

@@ -1,6 +1,6 @@
 package kscience.kmath.structures
 
-import kscience.kmath.operations.internal.FieldVerifier
+import kscience.kmath.testutils.FieldVerifier
 import kscience.kmath.operations.invoke
 import kotlin.test.Test
 import kotlin.test.assertEquals

kmath-core/src/commonTest/kotlin/kscience/kmath/testutils/AlgebraicVerifier.kt

@@ -1,4 +1,4 @@
-package kscience.kmath.operations.internal
+package kscience.kmath.testutils
 
 import kscience.kmath.operations.Algebra
 

kmath-core/src/commonTest/kotlin/kscience/kmath/testutils/FieldVerifier.kt

@@ -1,4 +1,4 @@
-package kscience.kmath.operations.internal
+package kscience.kmath.testutils
 
 import kscience.kmath.operations.Field
 import kscience.kmath.operations.invoke

kmath-core/src/commonTest/kotlin/kscience/kmath/testutils/RingVerifier.kt

@@ -1,4 +1,4 @@
-package kscience.kmath.operations.internal
+package kscience.kmath.testutils
 
 import kscience.kmath.operations.Ring
 import kscience.kmath.operations.invoke

kmath-core/src/commonTest/kotlin/kscience/kmath/testutils/SpaceVerifier.kt

@@ -1,4 +1,4 @@
-package kscience.kmath.operations.internal
+package kscience.kmath.testutils
 
 import kscience.kmath.operations.Space
 import kscience.kmath.operations.invoke

settings.gradle.kts

@@ -26,9 +26,10 @@ rootProject.name = "kmath"
 
 include(
     ":kmath-memory",
+    ":kmath-complex",
     ":kmath-core",
-    ":kmath-functions",
     ":kmath-coroutines",
+    ":kmath-functions",
     ":kmath-histograms",
     ":kmath-commons",
     ":kmath-viktor",