LU decomp doc in NOA

2021-07-10 22:21:20 +01:00 · 2021-07-10 22:21:20 +01:00 · 06bc8fecf6
commit 06bc8fecf6
parent 2a29e66daa
2 changed files with 4 additions and 2 deletions
--- a/kmath-noa/src/main/kotlin/space/kscience/kmath/noa/algebras.kt
+++ b/kmath-noa/src/main/kotlin/space/kscience/kmath/noa/algebras.kt
@ -252,7 +252,9 @@ protected constructor(scope: NoaScope) :
        JNoa.qrTensor(tensor.tensorHandle, Q, R)
        return Pair(wrap(Q), wrap(R))
    }
-
+    /**
+     * this implementation satisfies `tensor = P dot L dot U`
+     */
    override fun Tensor<T>.lu(): Triple<TensorType, TensorType, TensorType> {
        val P = JNoa.emptyTensor()
        val L = JNoa.emptyTensor()