kmath/kmath-ast
Iaroslav Postovalov c97f81b277
Merge remote-tracking branch 'origin/dev' into even-more-docs
# Conflicts:
#	build.gradle.kts
#	kmath-core/src/commonMain/kotlin/kscience/kmath/operations/Complex.kt
#	kmath-memory/src/commonMain/kotlin/kscience/kmath/memory/Memory.kt
#	kmath-memory/src/commonMain/kotlin/kscience/kmath/memory/MemorySpec.kt
#	kmath-memory/src/commonMain/kotlin/kscience/memory/Memory.kt
#	kmath-memory/src/commonMain/kotlin/kscience/memory/MemorySpec.kt
#	kmath-memory/src/commonMain/kotlin/scientifik/memory/Memory.kt
#	kmath-memory/src/commonMain/kotlin/scientifik/memory/MemorySpec.kt
#	kmath-memory/src/jsMain/kotlin/kscience/kmath/memory/DataViewMemory.kt
#	kmath-memory/src/jsMain/kotlin/kscience/memory/DataViewMemory.kt
#	kmath-memory/src/jsMain/kotlin/scientifik/memory/DataViewMemory.kt
#	kmath-memory/src/jvmMain/kotlin/kscience/kmath/memory/ByteBufferMemory.kt
#	kmath-memory/src/jvmMain/kotlin/kscience/memory/ByteBufferMemory.kt
#	kmath-memory/src/jvmMain/kotlin/scientifik/memory/ByteBufferMemory.kt
2020-09-28 03:10:24 +07:00
..
reference Update num token in reference 2020-07-27 15:58:09 +07:00
src Merge remote-tracking branch 'origin/dev' into even-more-docs 2020-09-28 03:10:24 +07:00
build.gradle.kts Fix things after merge 2020-09-20 22:25:50 +03:00
README.md scientifik -> kscience 2020-09-20 22:39:27 +03:00

Abstract Syntax Tree Expression Representation and Operations (kmath-ast)

This subproject implements the following features:

  • Expression Language and its parser.
  • MST (Mathematical Syntax Tree) as expression language's syntax intermediate representation.
  • Type-safe builder for MST.
  • Evaluating expressions by traversing MST.

Artifact:

This module is distributed in the artifact kscience.kmath:kmath-ast:0.1.4-dev-8.

Gradle:

repositories {
    maven { url 'https://dl.bintray.com/mipt-npm/kscience' }
    maven { url 'https://dl.bintray.com/mipt-npm/dev' }
    maven { url https://dl.bintray.com/hotkeytlt/maven' }
}

dependencies {
    implementation 'kscience.kmath:kmath-ast:0.1.4-dev-8'
}

Gradle Kotlin DSL:

repositories {
    maven("https://dl.bintray.com/mipt-npm/kscience")
    maven("https://dl.bintray.com/mipt-npm/dev")
    maven("https://dl.bintray.com/hotkeytlt/maven")
}

dependencies {
    implementation("kscience.kmath:kmath-ast:0.1.4-dev-8")
}

Dynamic Expression Code Generation with ObjectWeb ASM

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.

For example, the following builder:

RealField.mstInField { symbol("x") + 2 }.compile()

… leads to generation of bytecode, which can be decompiled to the following Java class:

package kscience.kmath.asm.generated;

import java.util.Map;
import kscience.kmath.asm.internal.MapIntrinsics;
import kscience.kmath.expressions.Expression;
import kscience.kmath.operations.RealField;

public final class AsmCompiledExpression_1073786867_0 implements Expression<Double> {
    private final RealField algebra;

    public final Double invoke(Map<String, ? extends Double> arguments) {
        return (Double)this.algebra.add(((Double)MapIntrinsics.getOrFail(arguments, "x")).doubleValue(), 2.0D);
    }

    public AsmCompiledExpression_1073786867_0(RealField algebra) {
        this.algebra = algebra;
    }
}

Example Usage

This API extends MST and MstExpression, so you may optimize as both of them:

RealField.mstInField { symbol("x") + 2 }.compile()
RealField.expression("x+2".parseMath())

Known issues

  • The same classes may be generated and loaded twice, so it is recommended to cache compiled expressions to avoid class loading overhead.
  • This API is not supported by non-dynamic JVM implementations (like TeaVM and GraalVM) because of using class loaders.

Contributed by Iaroslav Postovalov.