kmath/kmath-core/README.md

56 lines
2.6 KiB
Markdown
Raw Normal View History

2020-09-21 15:53:11 +03:00
# The Core Module (`kmath-core`)
The core features of KMath:
2020-09-26 12:21:08 +03:00
2021-01-30 20:12:14 +03:00
- [algebras](src/commonMain/kotlin/kscience/kmath/operations/Algebra.kt) : Algebraic structures like rings, spaces and fields.
- [nd](src/commonMain/kotlin/kscience/kmath/structures/NDStructure.kt) : Many-dimensional structures and operations on them.
- [linear](src/commonMain/kotlin/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.
2020-09-21 15:53:11 +03:00
- [buffers](src/commonMain/kotlin/kscience/kmath/structures/Buffers.kt) : One-dimensional structure
2021-01-30 20:12:14 +03:00
- [expressions](src/commonMain/kotlin/kscience/kmath/expressions) : By writing a single mathematical expression once, users will be able to apply different types of
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.
2020-09-21 15:53:11 +03:00
- [domains](src/commonMain/kotlin/kscience/kmath/domains) : Domains
2020-10-28 09:16:21 +03:00
- [autodif](src/commonMain/kotlin/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic differentiation
2020-09-21 15:53:11 +03:00
> #### Artifact:
2020-09-26 13:57:24 +03:00
>
2021-02-19 10:52:56 +03:00
> This module artifact: `space.kscience:kmath-core:0.2.0-dev-7`.
2020-09-26 12:21:08 +03:00
>
2020-09-26 13:57:24 +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)
>
2020-09-21 15:53:11 +03:00
> **Gradle:**
>
> ```gradle
> repositories {
2021-02-19 10:52:56 +03:00
> maven { url 'https://repo.kotlin.link' }
2020-09-26 12:21:08 +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
>// Uncomment if repo.kotlin.link is unavailable
>// maven { url 'https://dl.bintray.com/mipt-npm/kscience' }
>// maven { url 'https://dl.bintray.com/mipt-npm/dev' }
2020-09-21 15:53:11 +03:00
> }
>
> dependencies {
2021-02-19 10:52:56 +03:00
> implementation 'space.kscience:kmath-core:0.2.0-dev-7'
2020-09-21 15:53:11 +03:00
> }
> ```
> **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
>// Uncomment if repo.kotlin.link is unavailable
>// maven("https://dl.bintray.com/mipt-npm/kscience")
>// maven("https://dl.bintray.com/mipt-npm/dev")
2020-09-21 15:53:11 +03:00
> }
>
> dependencies {
2021-02-19 10:52:56 +03:00
> implementation("space.kscience:kmath-core:0.2.0-dev-7")
2020-09-21 15:53:11 +03:00
> }
> ```