kmath/kmath-ast/README.md

120 lines
4.0 KiB
Markdown
Raw Normal View History

# Abstract Syntax Tree Expression Representation and Operations (`kmath-ast`)
2020-06-15 11:02:13 +03:00
This subproject implements the following features:
2021-03-16 22:46:22 +03:00
- [expression-language](src/jvmMain/kotlin/space/kscience/kmath/ast/parser.kt) : Expression language and its parser
- [mst](src/commonMain/kotlin/space/kscience/kmath/ast/MST.kt) : MST (Mathematical Syntax Tree) as expression language's syntax intermediate representation
- [mst-building](src/commonMain/kotlin/space/kscience/kmath/ast/MstAlgebra.kt) : MST building algebraic structure
- [mst-interpreter](src/commonMain/kotlin/space/kscience/kmath/ast/MST.kt) : MST interpreter
- [mst-jvm-codegen](src/jvmMain/kotlin/space/kscience/kmath/asm/asm.kt) : Dynamic MST to JVM bytecode compiler
- [mst-js-codegen](src/jsMain/kotlin/space/kscience/kmath/estree/estree.kt) : Dynamic MST to JS compiler
2020-12-22 14:02:02 +03:00
> #### Artifact:
2020-12-22 14:02:02 +03:00
>
2021-03-16 22:46:22 +03:00
> This module artifact: `space.kscience:kmath-ast:0.3.0-dev-3`.
2020-12-22 14:02:02 +03:00
>
> Bintray release version: [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-ast/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-ast/_latestVersion)
>
> Bintray development version: [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-ast/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-ast/_latestVersion)
>
> **Gradle:**
>
> ```gradle
> repositories {
2021-02-19 10:52:56 +03:00
> maven { url 'https://repo.kotlin.link' }
2020-12-22 14:02:02 +03:00
> maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
2021-02-19 10:52:56 +03:00
> maven { url "https://dl.bintray.com/kotlin/kotlin-eap" } // include for builds based on kotlin-eap
> }
>
> dependencies {
2021-03-16 22:46:22 +03:00
> implementation 'space.kscience:kmath-ast:0.3.0-dev-3'
> }
> ```
> **Gradle Kotlin DSL:**
>
> ```kotlin
> repositories {
2021-02-19 10:52:56 +03:00
> maven("https://repo.kotlin.link")
> maven("https://dl.bintray.com/kotlin/kotlin-eap") // include for builds based on kotlin-eap
> maven("https://dl.bintray.com/hotkeytlt/maven") // required for a
> }
>
> dependencies {
2021-03-16 22:46:22 +03:00
> implementation("space.kscience:kmath-ast:0.3.0-dev-3")
> }
> ```
2020-12-22 12:00:51 +03:00
## Dynamic expression code generation
### On JVM
2020-12-22 14:02:02 +03:00
`kmath-ast` JVM module supports runtime code generation to eliminate overhead of tree traversal. Code generator builds
a special implementation of `Expression<T>` with implemented `invoke` function.
2020-12-22 14:02:02 +03:00
For example, the following builder:
```kotlin
2021-03-16 21:17:26 +03:00
DoubleField.mstInField { symbol("x") + 2 }.compile()
```
2021-03-17 19:11:26 +03:00
… leads to generation of bytecode, which can be decompiled to the following Java class:
```java
2021-02-19 10:52:56 +03:00
package space.kscience.kmath.asm.generated;
import java.util.Map;
2020-12-22 12:00:51 +03:00
import kotlin.jvm.functions.Function2;
2021-02-18 11:17:28 +03:00
import space.kscience.kmath.asm.internal.MapIntrinsics;
import space.kscience.kmath.expressions.Expression;
import space.kscience.kmath.expressions.Symbol;
2020-12-22 12:00:51 +03:00
public final class AsmCompiledExpression_45045_0 implements Expression<Double> {
private final Object[] constants;
2021-02-11 19:35:45 +03:00
public final Double invoke(Map<Symbol, ? extends Double> arguments) {
2020-12-22 12:00:51 +03:00
return (Double)((Function2)this.constants[0]).invoke((Double)MapIntrinsics.getOrFail(arguments, "x"), 2);
}
2020-12-22 12:00:51 +03:00
public AsmCompiledExpression_45045_0(Object[] constants) {
this.constants = constants;
}
}
2020-06-26 12:05:13 +03:00
```
### Example Usage
2020-12-22 14:02:02 +03:00
This API extends MST and MstExpression, so you may optimize as both of them:
```kotlin
2021-03-16 21:17:26 +03:00
DoubleField.mstInField { symbol("x") + 2 }.compile()
DoubleField.expression("x+2".parseMath())
```
2020-12-22 12:00:51 +03:00
#### Known issues
- The same classes may be generated and loaded twice, so it is recommended to cache compiled expressions to avoid
2020-12-22 14:02:02 +03:00
class loading overhead.
- This API is not supported by non-dynamic JVM implementations (like TeaVM and GraalVM) because of using class loaders.
2020-12-22 12:00:51 +03:00
### On JS
A similar feature is also available on JS.
```kotlin
2021-03-16 21:17:26 +03:00
DoubleField.mstInField { symbol("x") + 2 }.compile()
2020-12-22 12:00:51 +03:00
```
The code above returns expression implemented with such a JS function:
```js
var executable = function (constants, arguments) {
return constants[1](constants[0](arguments, "x"), 2);
};
```
#### Known issues
- This feature uses `eval` which can be unavailable in several environments.