teldufalsari/kmath
2
0
Fork 0
forked from kscience/kmath
Code Pull Requests 1 Activity

TensorLinearStructure doc

Browse Source
This commit is contained in:
Roland Grinis 2021-05-06 09:48:43 +01:00
parent 0680a3a1cb
commit a1cbd7a457
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/core/algebras/TensorLinearStructure.kt
View File

@ -56,7 +56,12 @@ internal fun stepIndex(index: IntArray, shape: IntArray, nDim: Int): IntArray {
return res return res
} }
/**
* This [Strides] implemetation follow the last dimension first convention
* For more information: https://numpy.org/doc/stable/reference/generated/numpy.ndarray.strides.html
*
* @param shape the shape of the tensor.
*/
public class TensorLinearStructure(override val shape: IntArray) : Strides public class TensorLinearStructure(override val shape: IntArray) : Strides
{ {
override val strides: IntArray override val strides: IntArray
@ -65,6 +70,7 @@ public class TensorLinearStructure(override val shape: IntArray) : Strides
override fun index(offset: Int): IntArray = override fun index(offset: Int): IntArray =
indexFromOffset(offset, strides, shape.size) indexFromOffset(offset, strides, shape.size)
// TODO: documentation (Alya)
public fun stepIndex(index: IntArray): IntArray = public fun stepIndex(index: IntArray): IntArray =
stepIndex(index, shape, shape.size) stepIndex(index, shape, shape.size)