kmath/kmath-core/README.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

2021-03-22 14:32:08 +03:00
# Module kmath-core
2021-03-15 19:45:46 +03:00
2021-03-22 14:32:08 +03:00
The core interfaces of KMath.
2021-03-15 19:45:46 +03:00
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
2021-03-22 14:32:08 +03:00
## Artifact:
2021-06-09 17:40:47 +03:00
The Maven coordinates of this project are `space.kscience:kmath-core:0.3.0-dev-13`.
2021-03-22 14:32:08 +03:00
**Gradle:**
```gradle
repositories {
maven { url 'https://repo.kotlin.link' }
mavenCentral()
2021-03-22 14:32:08 +03:00
}
dependencies {
2021-06-09 17:40:47 +03:00
implementation 'space.kscience:kmath-core:0.3.0-dev-13'
2021-03-22 14:32:08 +03:00
}
```
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
2021-03-22 14:32:08 +03:00
}
dependencies {
2021-06-09 17:40:47 +03:00
implementation("space.kscience:kmath-core:0.3.0-dev-13")
2021-03-22 14:32:08 +03:00
}
```