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

[WIP] Tensor algebra design

Browse Source
This commit is contained in:
Alexander Nozik 2021-01-20 11:43:01 +03:00
parent 9ef32db236
commit 9011579d2c
2 changed files with 40 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
build.gradle.kts
View File

@ -4,7 +4,7 @@ plugins {
id("ru.mipt.npm.project")
}
internal val kmathVersion: String by extra("0.2.0-dev-5")
internal val kmathVersion: String by extra("0.2.0-dev-6")
internal val bintrayRepo: String by extra("kscience")
internal val githubProject: String by extra("kmath")

74
kmath-core/src/commonMain/kotlin/kscience/kmath/tensors/TensorAlgebra.kt
View File

@ -1,10 +1,13 @@
package kscience.kmath.tensors
import kscience.kmath.misc.UnstableKMathAPI
import kscience.kmath.operations.Field
import kscience.kmath.operations.Ring
import kscience.kmath.structures.MutableNDStructure
public typealias Tensor<T> = MutableNDStructure<T>
@UnstableKMathAPI
public val <T : Any> Tensor<T>.value: T
get() {
require(shape.contentEquals(intArrayOf(1))) { "Value available only for a tensor with no dimensions" }
@ -13,59 +16,60 @@ public val <T : Any> Tensor<T>.value: T
// https://proofwiki.org/wiki/Definition:Algebra_over_Ring
/**
* To be moved to a separate project
* TODO To be moved to a separate project
*/
public interface TensorAlgebra<T, TensorType : Tensor<T>> : Ring<TensorType> {
@UnstableKMathAPI
public interface TensorAlgebra<T, TT : Tensor<T>> : Ring<TT> {
public operator fun T.plus(other: TensorType): TensorType
public operator fun TensorType.plus(value: T): TensorType
public operator fun TensorType.plusAssign(value: T): Unit
public operator fun TensorType.plusAssign(other: TensorType): Unit
public operator fun T.plus(other: TT): TT
public operator fun TT.plus(value: T): TT
public operator fun TT.plusAssign(value: T): Unit
public operator fun TT.plusAssign(other: TT): Unit
public operator fun T.minus(other: TensorType): TensorType
public operator fun TensorType.minus(value: T): TensorType
public operator fun TensorType.minusAssign(value: T): Unit
public operator fun TensorType.minusAssign(other: TensorType): Unit
public operator fun T.minus(other: TT): TT
public operator fun TT.minus(value: T): TT
public operator fun TT.minusAssign(value: T): Unit
public operator fun TT.minusAssign(other: TT): Unit
public operator fun T.times(other: TensorType): TensorType
public operator fun TensorType.times(value: T): TensorType
public operator fun TensorType.timesAssign(value: T): Unit
public operator fun TensorType.timesAssign(other: TensorType): Unit
public operator fun T.times(other: TT): TT
public operator fun TT.times(value: T): TT
public operator fun TT.timesAssign(value: T): Unit
public operator fun TT.timesAssign(other: TT): Unit
public infix fun TensorType.dot(other: TensorType): TensorType
public infix fun TensorType.dotAssign(other: TensorType): Unit
public infix fun TensorType.dotRightAssign(other: TensorType): Unit
public infix fun TT.dot(other: TT): TT
public infix fun TT.dotAssign(other: TT): Unit
public infix fun TT.dotRightAssign(other: TT): Unit
public fun diagonalEmbedding(
diagonalEntries: TensorType,
diagonalEntries: TT,
offset: Int = 0, dim1: Int = -2, dim2: Int = -1,
): TensorType
): TT
public fun TensorType.transpose(i: Int, j: Int): TensorType
public fun TensorType.transposeAssign(i: Int, j: Int): Unit
public fun TT.transpose(i: Int, j: Int): TT
public fun TT.transposeAssign(i: Int, j: Int): Unit
public fun TensorType.view(shape: IntArray): TensorType
public fun TT.view(shape: IntArray): TT
public fun TensorType.abs(): TensorType
public fun TensorType.absAssign(): Unit
public fun TensorType.sum(): TensorType
public fun TensorType.sumAssign(): Unit
public fun abs(tensor: TT): TT
public fun TT.absAssign(): Unit
public fun TT.sum(): TT
public fun TT.sumAssign(): Unit
}
// https://proofwiki.org/wiki/Definition:Division_Algebra
public interface TensorPartialDivisionAlgebra<T, TensorType : Tensor<T>> : TensorAlgebra<T, TensorType> {
public interface TensorPartialDivisionAlgebra<T, TT : Tensor<T>> :
TensorAlgebra<T, TT>, Field<TT> {
public operator fun TensorType.div(other: TensorType): TensorType
public operator fun TensorType.divAssign(other: TensorType)
public operator fun TT.divAssign(other: TT)
public fun TensorType.exp(): TensorType
public fun TensorType.expAssign(): Unit
public fun TensorType.log(): TensorType
public fun TensorType.logAssign(): Unit
public fun exp(tensor: TT): TT
public fun TT.expAssign(): Unit
public fun log(tensor: TT): TT
public fun TT.logAssign(): Unit
public fun TensorType.svd(): Triple<TensorType, TensorType, TensorType>
public fun TensorType.symEig(eigenvectors: Boolean = true): Pair<TensorType, TensorType>
public fun svd(tensor: TT): Triple<TT, TT, TT>
public fun symEig(tensor: TT, eigenvectors: Boolean = true): Pair<TT, TT>
}