Merge pull request #207 from T45K/add_norm_for_D1Array

Add `norm` API for vectors

Author: devcrocod

multik-core/src/commonMain/kotlin/org/jetbrains/kotlinx/multik/api/linalg/norm.kt

@@ -4,16 +4,34 @@
 
 package org.jetbrains.kotlinx.multik.api.linalg
 
+import org.jetbrains.kotlinx.multik.api.mk
+import org.jetbrains.kotlinx.multik.api.zeros
+import org.jetbrains.kotlinx.multik.ndarray.data.D1
 import org.jetbrains.kotlinx.multik.ndarray.data.D2
 import org.jetbrains.kotlinx.multik.ndarray.data.MultiArray
+import org.jetbrains.kotlinx.multik.ndarray.operations.stack
 import kotlin.jvm.JvmName
 
+/**
+ * Returns norm of float vector
+ */
+@JvmName("normFV")
+public fun LinAlg.norm(mat: MultiArray<Float, D1>, norm: Norm = Norm.Fro): Float =
+    this.linAlgEx.normF(mk.stack(mat, mk.zeros(mat.size)), norm)
+
 /**
  * Returns norm of float matrix
  */
 @JvmName("normF")
 public fun LinAlg.norm(mat: MultiArray<Float, D2>, norm: Norm = Norm.Fro): Float = this.linAlgEx.normF(mat, norm)
 
+/**
+ * Returns norm of double vector
+ */
+@JvmName("normDV")
+public fun LinAlg.norm(mat: MultiArray<Double, D1>, norm: Norm = Norm.Fro): Double =
+    this.linAlgEx.norm(mk.stack(mat, mk.zeros(mat.size)), norm)
+
 /**
  * Returns norm of double matrix
  */

multik-kotlin/src/commonTest/kotlin/org/jetbrains/kotlinx/multik_kotlin/linAlg/KELinAlgTest.kt

@@ -492,6 +492,16 @@ class KELinAlgTest {
         }
 
     }
+
+    @Test
+    fun compute_norm_for_vector() {
+        val vector = mk.ndarray(mk[1.1, 0.0, 3.2, 2.3, 5.0])
+
+        assertEquals(6.460650122085238, mk.linalg.norm(vector, Norm.Fro))
+        assertEquals(11.600000000000001, mk.linalg.norm(vector, Norm.Inf))
+        assertEquals(5.0, mk.linalg.norm(vector, Norm.N1))
+        assertEquals(5.0, mk.linalg.norm(vector, Norm.Max))
+    }
 }
 
 

multik-openblas/src/commonTest/kotlin/org/jetbrains/kotlinx/multik/openblas/linalg/NativeLinAlgTest.kt

@@ -324,4 +324,14 @@ class NativeLinAlgTest {
         assertFloatingNumber(7.0, NativeLinAlg.norm(b, Norm.N1))
         assertFloatingNumber(4.0, NativeLinAlg.norm(b, Norm.Max))
     }
+
+    @Test
+    fun `compute norm for vector`() {
+        val vector = mk.ndarray(mk[1.1, 0.0, 3.2, 2.3, 5.0])
+
+        assertEquals(6.460650122085238, mk.linalg.norm(vector, Norm.Fro))
+        assertEquals(11.600000000000001, mk.linalg.norm(vector, Norm.Inf))
+        assertEquals(5.0, mk.linalg.norm(vector, Norm.N1))
+        assertEquals(5.0, mk.linalg.norm(vector, Norm.Max))
+    }
 }