kscience/kmath
9
0
Fork 1
Code Issues Pull Requests 6 Packages Projects Releases 16 Wiki Activity

Update KDoc comments

Browse Source
This commit is contained in:
Iaroslav Postovalov 2021-01-19 00:27:28 +07:00
parent 6d118fc841
commit 7418228d08
No known key found for this signature in database
GPG Key ID: 46E15E4A31B3BCD7
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
kmath-core/src/commonMain/kotlin/kscience/kmath/linear/FeaturedMatrix.kt
View File

@ -74,7 +74,14 @@ public fun <T : Any, R : Ring<T>> GenericMatrixContext<T, R, *>.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 <T : Any, R : Ring<T>> GenericMatrixContext<T, R, *>.zero(rows: Int, columns: Int): FeaturedMatrix<T> =
VirtualMatrix(rows, columns) { _, _ -> elementContext.zero }
@ -82,6 +89,7 @@ public fun <T : Any, R : Ring<T>> GenericMatrixContext<T, R, *>.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<T : Any>(public val original: Matrix<T>) : MatrixFeature