Update README files
This commit is contained in:
parent
55f8c3938b
commit
a0186844f5
10
README.md
10
README.md
@ -173,6 +173,16 @@ One can still use generic algebras though.
|
||||
> **Maturity**: PROTOTYPE
|
||||
<hr/>
|
||||
|
||||
* ### [kmath-gsl](kmath-gsl)
|
||||
> Linear Algebra classes implemented with GNU Scientific Library
|
||||
>
|
||||
> **Maturity**: PROTOTYPE
|
||||
>
|
||||
> **Features:**
|
||||
> - [matrix-contexts](kmath-gsl/src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrixContext.kt) : Matrix Contexts over Double, Float and Complex implemented with GSL
|
||||
|
||||
<hr/>
|
||||
|
||||
* ### [kmath-histograms](kmath-histograms)
|
||||
>
|
||||
>
|
||||
|
@ -61,7 +61,7 @@ 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:
|
||||
… leads to generation of bytecode, which can be decompiled to the following Java class:
|
||||
|
||||
```java
|
||||
package kscience.kmath.asm.generated;
|
||||
|
44
kmath-gsl/README.md
Normal file
44
kmath-gsl/README.md
Normal file
@ -0,0 +1,44 @@
|
||||
# GNU Scientific Library Integration (`kmath-core`)
|
||||
|
||||
This subproject implements the following features:
|
||||
|
||||
- [matrix-contexts](src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrixContext.kt) : Matrix Contexts over Double, Float and Complex implemented with GSL
|
||||
|
||||
|
||||
> #### Artifact:
|
||||
>
|
||||
> This module artifact: `kscience.kmath:kmath-gsl:0.2.0-dev-6`.
|
||||
>
|
||||
> Bintray release version: [ ![Download](https://api.bintray.com/packages/mipt-npm/kscience/kmath-gsl/images/download.svg) ](https://bintray.com/mipt-npm/kscience/kmath-gsl/_latestVersion)
|
||||
>
|
||||
> Bintray development version: [ ![Download](https://api.bintray.com/packages/mipt-npm/dev/kmath-gsl/images/download.svg) ](https://bintray.com/mipt-npm/dev/kmath-gsl/_latestVersion)
|
||||
>
|
||||
> **Gradle:**
|
||||
>
|
||||
> ```gradle
|
||||
> repositories {
|
||||
> maven { url "https://dl.bintray.com/kotlin/kotlin-eap" }
|
||||
> 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-gsl:0.2.0-dev-6'
|
||||
> }
|
||||
> ```
|
||||
> **Gradle Kotlin DSL:**
|
||||
>
|
||||
> ```kotlin
|
||||
> repositories {
|
||||
> maven("https://dl.bintray.com/kotlin/kotlin-eap")
|
||||
> 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-gsl:0.2.0-dev-6")
|
||||
> }
|
||||
> ```
|
@ -2,6 +2,7 @@
|
||||
|
||||
import kscience.kmath.gsl.codegen.matricesCodegen
|
||||
import kscience.kmath.gsl.codegen.vectorsCodegen
|
||||
import ru.mipt.npm.gradle.Maturity
|
||||
|
||||
plugins {
|
||||
id("ru.mipt.npm.mpp")
|
||||
@ -50,3 +51,15 @@ kotlin {
|
||||
test.defaultSourceSet.dependsOn(nativeTest)
|
||||
}
|
||||
}
|
||||
|
||||
readme {
|
||||
description = "Linear Algebra classes implemented with GNU Scientific Library"
|
||||
maturity = Maturity.PROTOTYPE
|
||||
propertyByTemplate("artifact", rootProject.file("docs/templates/ARTIFACT-TEMPLATE.md"))
|
||||
|
||||
feature(
|
||||
id = "matrix-contexts",
|
||||
description = "Matrix Contexts over Double, Float and Complex implemented with GSL",
|
||||
ref = "src/nativeMain/kotlin/kscience/kmath/gsl/GslMatrixContext.kt"
|
||||
)
|
||||
}
|
||||
|
7
kmath-gsl/docs/README-TEMPLATE.md
Normal file
7
kmath-gsl/docs/README-TEMPLATE.md
Normal file
@ -0,0 +1,7 @@
|
||||
# GNU Scientific Library Integration (`kmath-core`)
|
||||
|
||||
This subproject implements the following features:
|
||||
|
||||
${features}
|
||||
|
||||
${artifact}
|
@ -388,8 +388,7 @@ public class GslComplexMatrixContext(internal val scope: AutofreeScope) :
|
||||
}
|
||||
|
||||
override val determinant by lazy {
|
||||
gsl_linalg_complex_LU_det(lups.first.nativeHandle,
|
||||
lups.third).toKMath()
|
||||
gsl_linalg_complex_LU_det(lups.first.nativeHandle, lups.third).toKMath()
|
||||
}
|
||||
|
||||
override val inverse by lazy {
|
||||
|
Loading…
Reference in New Issue
Block a user