Skip to content

Add norm API for vectors #207

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 21, 2024
Merged

Add norm API for vectors #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3330c8c
add norm API to Vector
T45K Aug 18, 2024
fcb3ad9
add tests
T45K Aug 19, 2024
6b3071f
revert import order
T45K Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions multik-core/src/commonMain/kotlin/org/jetbrains/kotlinx/multik/api/linalg/norm.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
10 changes: 10 additions & 0 deletions ...k-kotlin/src/commonTest/kotlin/org/jetbrains/kotlinx/multik_kotlin/linAlg/KELinAlgTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
}


Expand Down
10 changes: 10 additions & 0 deletions ...as/src/commonTest/kotlin/org/jetbrains/kotlinx/multik/openblas/linalg/NativeLinAlgTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}
}