kmath/kmath-core/README.md

50 lines
2.3 KiB
Markdown
Raw Normal View History

2021-03-15 19:45:46 +03:00
# The Core Module (`kmath-core`)
The core features of KMath:
2021-03-16 22:46:22 +03:00
- [algebras](src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Algebraic structures like rings, spaces and fields.
2021-03-17 19:11:26 +03:00
- [nd](src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt) : Many-dimensional structures and operations on them.
2021-03-16 22:46:22 +03:00
- [linear](src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Basic linear algebra operations (sums, products, etc.), backed by the `Space` API. Advanced linear algebra operations like matrix inversion and LU decomposition.
- [buffers](src/commonMain/kotlin/space/kscience/kmath/structures/Buffers.kt) : One-dimensional structure
2021-03-17 19:11:26 +03:00
- [expressions](src/commonMain/kotlin/space/kscience/kmath/expressions) : By writing a single mathematical expression once, users will be able to apply different types of
2021-03-15 19:45:46 +03:00
objects to the expression by providing a context. Expressions can be used for a wide variety of purposes from high
performance calculations to code generation.
2021-03-16 22:46:22 +03:00
- [domains](src/commonMain/kotlin/space/kscience/kmath/domains) : Domains
- [autodif](src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic differentiation
2021-03-15 19:45:46 +03:00
> #### Artifact:
>
2021-03-16 22:46:22 +03:00
> This module artifact: `space.kscience:kmath-core:0.3.0-dev-3`.
2021-03-15 19:45:46 +03:00
>
> Bintray release version: [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-core/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-core/_latestVersion)
>
> Bintray development version: [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-core/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-core/_latestVersion)
>
> **Gradle:**
>
> ```gradle
> repositories {
> maven { url 'https://repo.kotlin.link' }
> maven { url 'https://dl.bintray.com/hotkeytlt/maven' }
> 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-core:0.3.0-dev-3'
2021-03-15 19:45:46 +03:00
> }
> ```
> **Gradle Kotlin DSL:**
>
> ```kotlin
> repositories {
> 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-core:0.3.0-dev-3")
2021-03-15 19:45:46 +03:00
> }
> ```