From 7418228d08be2693fdd10bceadf1af967ef45379 Mon Sep 17 00:00:00 2001 From: Iaroslav Postovalov Date: Tue, 19 Jan 2021 00:27:28 +0700 Subject: [PATCH] Update KDoc comments --- .../kotlin/kscience/kmath/linear/FeaturedMatrix.kt | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/kmath-core/src/commonMain/kotlin/kscience/kmath/linear/FeaturedMatrix.kt b/kmath-core/src/commonMain/kotlin/kscience/kmath/linear/FeaturedMatrix.kt index 54e4c3777..38c81b646 100644 --- a/kmath-core/src/commonMain/kotlin/kscience/kmath/linear/FeaturedMatrix.kt +++ b/kmath-core/src/commonMain/kotlin/kscience/kmath/linear/FeaturedMatrix.kt @@ -74,7 +74,14 @@ public fun > GenericMatrixContext.one(rows: Int, c /** - * Returns virtual matrix of zeroes. + * Returns a [VirtualMatrix] of zeroes. + * + * @param T the type of matrix's items. + * @param R the type of ring over the matrix's items. + * @receiver the matrix context to provide the [R] ring. + * @param rows the count of rows. + * @param columns the count of columns. + * @return a new virtual matrix. */ public fun > GenericMatrixContext.zero(rows: Int, columns: Int): FeaturedMatrix = VirtualMatrix(rows, columns) { _, _ -> elementContext.zero } @@ -82,6 +89,7 @@ public fun > GenericMatrixContext.zero(rows: Int, /** * Matrices with this feature were transposed previously and hold the reference to their original. * + * @param T the type of matrices' items. * @property original the matrix before transposition. */ public inline class TransposedFeature(public val original: Matrix) : MatrixFeature