From 255d4ba6b7118b5621fa82760cddcc8d6c6459cc Mon Sep 17 00:00:00 2001 From: Alexander Nozik Date: Wed, 27 Mar 2024 09:51:23 +0300 Subject: [PATCH] Dump API. Update readme --- README.md | 117 ++++++++++------------------ attributes-kt/README.md | 17 ++++ attributes-kt/api/attributes-kt.api | 6 +- kmath-ast/README.md | 14 ++-- kmath-commons/README.md | 5 +- kmath-complex/README.md | 10 +-- kmath-core/README.md | 31 ++++---- kmath-coroutines/README.md | 7 +- kmath-dimensions/README.md | 5 +- kmath-ejml/README.md | 12 +-- kmath-for-real/README.md | 14 ++-- kmath-functions/README.md | 18 ++--- kmath-geometry/README.md | 7 +- kmath-histograms/README.md | 7 +- kmath-jafama/README.md | 8 +- kmath-jupyter/README.md | 7 +- kmath-kotlingrad/README.md | 12 ++- kmath-memory/README.md | 7 +- kmath-multik/README.md | 5 +- kmath-nd4j/README.md | 12 +-- kmath-optimization/README.md | 7 +- kmath-stat/README.md | 7 +- kmath-symja/README.md | 5 +- kmath-tensorflow/README.md | 5 +- kmath-tensors/README.md | 15 ++-- kmath-viktor/README.md | 5 +- 26 files changed, 166 insertions(+), 199 deletions(-) diff --git a/README.md b/README.md index cd2503a12..1abd7481a 100644 --- a/README.md +++ b/README.md @@ -56,181 +56,151 @@ module definitions below. The module stability could have the following levels: ## Modules -### [attributes-kt](attributes-kt) +### [attributes-kt](attributes-kt) > An API and basic implementation for arranging objects in a continuous memory block. > > **Maturity**: DEVELOPMENT ### [benchmarks](benchmarks) - > > **Maturity**: EXPERIMENTAL ### [examples](examples) - > > **Maturity**: EXPERIMENTAL ### [kmath-ast](kmath-ast) - > > **Maturity**: EXPERIMENTAL > > **Features:** -> - [expression-language](kmath-ast/src/commonMain/kotlin/space/kscience/kmath/ast/parser.kt) : Expression language and - its parser -> - [mst-jvm-codegen](kmath-ast/src/jvmMain/kotlin/space/kscience/kmath/asm/asm.kt) : Dynamic MST to JVM bytecode - compiler +> - [expression-language](kmath-ast/src/commonMain/kotlin/space/kscience/kmath/ast/parser.kt) : Expression language and its parser +> - [mst-jvm-codegen](kmath-ast/src/jvmMain/kotlin/space/kscience/kmath/asm/asm.kt) : Dynamic MST to JVM bytecode compiler > - [mst-js-codegen](kmath-ast/src/jsMain/kotlin/space/kscience/kmath/estree/estree.kt) : Dynamic MST to JS compiler -> - [rendering](kmath-ast/src/commonMain/kotlin/space/kscience/kmath/ast/rendering/MathRenderer.kt) : Extendable MST - rendering +> - [rendering](kmath-ast/src/commonMain/kotlin/space/kscience/kmath/ast/rendering/MathRenderer.kt) : Extendable MST rendering + ### [kmath-commons](kmath-commons) - > Commons math binding for kmath > > **Maturity**: EXPERIMENTAL ### [kmath-complex](kmath-complex) - > Complex numbers and quaternions. > > **Maturity**: PROTOTYPE > > **Features:** > - [complex](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex numbers operations -> - [quaternion](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions and their - composition +> - [quaternion](kmath-complex/src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions and their composition + ### [kmath-core](kmath-core) - > Core classes, algebra definitions, basic linear algebra > > **Maturity**: DEVELOPMENT > > **Features:** -> - [algebras](kmath-core/src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Algebraic structures like - rings, spaces and fields. -> - [nd](kmath-core/src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt) : Many-dimensional structures - and operations on them. -> - [linear](kmath-core/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. +> - [algebras](kmath-core/src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Algebraic structures like rings, spaces and fields. +> - [nd](kmath-core/src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt) : Many-dimensional structures and operations on them. +> - [linear](kmath-core/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](kmath-core/src/commonMain/kotlin/space/kscience/kmath/structures/Buffers.kt) : One-dimensional structure -> - [expressions](kmath-core/src/commonMain/kotlin/space/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. +> - [expressions](kmath-core/src/commonMain/kotlin/space/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. > - [domains](kmath-core/src/commonMain/kotlin/space/kscience/kmath/domains) : Domains -> - [autodiff](kmath-core/src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic - differentiation +> - [autodiff](kmath-core/src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic differentiation +> - [Parallel linear algebra](kmath-core/#) : Parallel implementation for `LinearAlgebra` + ### [kmath-coroutines](kmath-coroutines) - > > **Maturity**: EXPERIMENTAL ### [kmath-dimensions](kmath-dimensions) - > A proof of concept module for adding type-safe dimensions to structures > > **Maturity**: PROTOTYPE ### [kmath-ejml](kmath-ejml) - > > **Maturity**: PROTOTYPE > > **Features:** > - [ejml-vector](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlVector.kt) : Point implementations. > - [ejml-matrix](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlMatrix.kt) : Matrix implementation. -> - [ejml-linear-space](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlLinearSpace.kt) : LinearSpace - implementations. +> - [ejml-linear-space](kmath-ejml/src/main/kotlin/space/kscience/kmath/ejml/EjmlLinearSpace.kt) : LinearSpace implementations. + ### [kmath-for-real](kmath-for-real) - > Extension module that should be used to achieve numpy-like behavior. -> All operations are specialized to work with `Double` numbers without declaring algebraic contexts. -> One can still use generic algebras though. +All operations are specialized to work with `Double` numbers without declaring algebraic contexts. +One can still use generic algebras though. > > **Maturity**: EXPERIMENTAL > > **Features:** -> - [DoubleVector](kmath-for-real/src/commonMain/kotlin/space/kscience/kmath/real/DoubleVector.kt) : Numpy-like - operations for Buffers/Points -> - [DoubleMatrix](kmath-for-real/src/commonMain/kotlin/space/kscience/kmath/real/DoubleMatrix.kt) : Numpy-like - operations for 2d real structures +> - [DoubleVector](kmath-for-real/src/commonMain/kotlin/space/kscience/kmath/real/DoubleVector.kt) : Numpy-like operations for Buffers/Points +> - [DoubleMatrix](kmath-for-real/src/commonMain/kotlin/space/kscience/kmath/real/DoubleMatrix.kt) : Numpy-like operations for 2d real structures > - [grids](kmath-for-real/src/commonMain/kotlin/space/kscience/kmath/structures/grids.kt) : Uniform grid generators -### [kmath-functions](kmath-functions) +### [kmath-functions](kmath-functions) > Functions, integration and interpolation > > **Maturity**: EXPERIMENTAL > > **Features:** -> - [piecewise](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt) : Piecewise - functions. -> - [polynomials](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/functions/Polynomial.kt) : Polynomial - functions. -> - [linear interpolation](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/interpolation/LinearInterpolator.kt) : - Linear XY interpolator. -> - [spline interpolation](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/interpolation/SplineInterpolator.kt) : - Cubic spline XY interpolator. +> - [piecewise](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt) : Piecewise functions. +> - [polynomials](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/functions/Polynomial.kt) : Polynomial functions. +> - [linear interpolation](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/interpolation/LinearInterpolator.kt) : Linear XY interpolator. +> - [spline interpolation](kmath-functions/src/commonMain/kotlin/space/kscience/kmath/interpolation/SplineInterpolator.kt) : Cubic spline XY interpolator. > - [integration](kmath-functions/#) : Univariate and multivariate quadratures -### [kmath-geometry](kmath-geometry) +### [kmath-geometry](kmath-geometry) > > **Maturity**: PROTOTYPE ### [kmath-histograms](kmath-histograms) - > > **Maturity**: PROTOTYPE ### [kmath-jafama](kmath-jafama) - > Jafama integration module > > **Maturity**: DEPRECATED > > **Features:** -> - [jafama-double](kmath-jafama/src/main/kotlin/space/kscience/kmath/jafama/) : Double ExtendedField implementations - based on Jafama +> - [jafama-double](kmath-jafama/src/main/kotlin/space/kscience/kmath/jafama/) : Double ExtendedField implementations based on Jafama + ### [kmath-jupyter](kmath-jupyter) - > > **Maturity**: PROTOTYPE ### [kmath-kotlingrad](kmath-kotlingrad) - > Kotlin∇ integration module > > **Maturity**: EXPERIMENTAL > > **Features:** -> - [differentiable-mst-expression](kmath-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt) : - MST based DifferentiableExpression. -> - [scalars-adapters](kmath-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/scalarsAdapters.kt) : - Conversions between Kotlin∇'s SFun and MST +> - [differentiable-mst-expression](kmath-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt) : MST based DifferentiableExpression. +> - [scalars-adapters](kmath-kotlingrad/src/main/kotlin/space/kscience/kmath/kotlingrad/scalarsAdapters.kt) : Conversions between Kotlin∇'s SFun and MST + ### [kmath-memory](kmath-memory) - > An API and basic implementation for arranging objects in a continuous memory block. > > **Maturity**: DEVELOPMENT ### [kmath-multik](kmath-multik) - > JetBrains Multik connector > > **Maturity**: PROTOTYPE ### [kmath-nd4j](kmath-nd4j) - > ND4J NDStructure implementation and according NDAlgebra classes > > **Maturity**: DEPRECATED @@ -240,52 +210,45 @@ module definitions below. The module stability could have the following levels: > - [nd4jarrayrings](kmath-nd4j/#) : Rings over Nd4jArrayStructure of Int and Long > - [nd4jarrayfields](kmath-nd4j/#) : Fields over Nd4jArrayStructure of Float and Double -### [kmath-optimization](kmath-optimization) +### [kmath-optimization](kmath-optimization) > > **Maturity**: EXPERIMENTAL ### [kmath-stat](kmath-stat) - > > **Maturity**: EXPERIMENTAL ### [kmath-symja](kmath-symja) - > Symja integration module > > **Maturity**: PROTOTYPE ### [kmath-tensorflow](kmath-tensorflow) - > Google tensorflow connector > > **Maturity**: PROTOTYPE ### [kmath-tensors](kmath-tensors) - > > **Maturity**: PROTOTYPE > > **Features:** -> - [tensor algebra](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/TensorAlgebra.kt) : Basic - linear algebra operations on tensors (plus, dot, etc.) -> - [tensor algebra with broadcasting](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/core/BroadcastDoubleTensorAlgebra.kt) : - Basic linear algebra operations implemented with broadcasting. -> - [linear algebra operations](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/LinearOpsTensorAlgebra.kt) : - Advanced linear algebra operations like LU decomposition, SVD, etc. +> - [tensor algebra](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/TensorAlgebra.kt) : Basic linear algebra operations on tensors (plus, dot, etc.) +> - [tensor algebra with broadcasting](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/core/BroadcastDoubleTensorAlgebra.kt) : Basic linear algebra operations implemented with broadcasting. +> - [linear algebra operations](kmath-tensors/src/commonMain/kotlin/space/kscience/kmath/tensors/api/LinearOpsTensorAlgebra.kt) : Advanced linear algebra operations like LU decomposition, SVD, etc. + ### [kmath-viktor](kmath-viktor) - > Binding for https://github.com/JetBrains-Research/viktor > -> **Maturity**: DEVELOPMENT +> **Maturity**: DEPRECATED ### [test-utils](test-utils) - > > **Maturity**: EXPERIMENTAL + ## Multi-platform support KMath is developed as a multi-platform library, which means that most of the interfaces are declared in the diff --git a/attributes-kt/README.md b/attributes-kt/README.md index 53f80fcef..96d273d5b 100644 --- a/attributes-kt/README.md +++ b/attributes-kt/README.md @@ -2,3 +2,20 @@ +## Usage + +## Artifact: + +The Maven coordinates of this project are `space.kscience:attributes-kt:0.1.0`. + +**Gradle Kotlin DSL:** +```kotlin +repositories { + maven("https://repo.kotlin.link") + mavenCentral() +} + +dependencies { + implementation("space.kscience:attributes-kt:0.1.0") +} +``` diff --git a/attributes-kt/api/attributes-kt.api b/attributes-kt/api/attributes-kt.api index 403e12f5c..c735ad1dc 100644 --- a/attributes-kt/api/attributes-kt.api +++ b/attributes-kt/api/attributes-kt.api @@ -28,14 +28,14 @@ public final class space/kscience/attributes/Attributes$Companion { } public final class space/kscience/attributes/AttributesBuilder : space/kscience/attributes/Attributes { - public fun ()V public final fun add (Lspace/kscience/attributes/SetAttribute;Ljava/lang/Object;)V public final fun build ()Lspace/kscience/attributes/Attributes; public fun equals (Ljava/lang/Object;)Z - public final fun from (Lspace/kscience/attributes/Attributes;)V public fun getContent ()Ljava/util/Map; public fun hashCode ()I public final fun invoke (Lspace/kscience/attributes/Attribute;Ljava/lang/Object;)V + public final fun put (Lspace/kscience/attributes/Attribute;Ljava/lang/Object;)V + public final fun putAll (Lspace/kscience/attributes/Attributes;)V public final fun remove (Lspace/kscience/attributes/SetAttribute;Ljava/lang/Object;)V public final fun set (Lspace/kscience/attributes/Attribute;Ljava/lang/Object;)V public fun toString ()Ljava/lang/String; @@ -50,7 +50,7 @@ public final class space/kscience/attributes/AttributesKt { public static final fun Attributes (Lspace/kscience/attributes/Attribute;Ljava/lang/Object;)Lspace/kscience/attributes/Attributes; public static final fun getOrDefault (Lspace/kscience/attributes/Attributes;Lspace/kscience/attributes/AttributeWithDefault;)Ljava/lang/Object; public static final fun isEmpty (Lspace/kscience/attributes/Attributes;)Z - public static final fun modify (Lspace/kscience/attributes/Attributes;Lkotlin/jvm/functions/Function1;)Lspace/kscience/attributes/Attributes; + public static final fun modified (Lspace/kscience/attributes/Attributes;Lkotlin/jvm/functions/Function1;)Lspace/kscience/attributes/Attributes; public static final fun plus (Lspace/kscience/attributes/Attributes;Lspace/kscience/attributes/Attributes;)Lspace/kscience/attributes/Attributes; public static final fun withAttribute (Lspace/kscience/attributes/Attributes;Lspace/kscience/attributes/Attribute;)Lspace/kscience/attributes/Attributes; public static final fun withAttribute (Lspace/kscience/attributes/Attributes;Lspace/kscience/attributes/Attribute;Ljava/lang/Object;)Lspace/kscience/attributes/Attributes; diff --git a/kmath-ast/README.md b/kmath-ast/README.md index 289114dd0..48ffa4502 100644 --- a/kmath-ast/README.md +++ b/kmath-ast/README.md @@ -2,17 +2,17 @@ Extensions to MST API: transformations, dynamic compilation and visualization. -- [expression-language](src/commonMain/kotlin/space/kscience/kmath/ast/parser.kt) : Expression language and its parser -- [mst-jvm-codegen](src/jvmMain/kotlin/space/kscience/kmath/asm/asm.kt) : Dynamic MST to JVM bytecode compiler -- [mst-js-codegen](src/jsMain/kotlin/space/kscience/kmath/estree/estree.kt) : Dynamic MST to JS compiler -- [rendering](src/commonMain/kotlin/space/kscience/kmath/ast/rendering/MathRenderer.kt) : Extendable MST rendering + - [expression-language](src/commonMain/kotlin/space/kscience/kmath/ast/parser.kt) : Expression language and its parser + - [mst-jvm-codegen](src/jvmMain/kotlin/space/kscience/kmath/asm/asm.kt) : Dynamic MST to JVM bytecode compiler + - [mst-js-codegen](src/jsMain/kotlin/space/kscience/kmath/estree/estree.kt) : Dynamic MST to JS compiler + - [rendering](src/commonMain/kotlin/space/kscience/kmath/ast/rendering/MathRenderer.kt) : Extendable MST rendering + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-ast:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-ast:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -20,7 +20,7 @@ repositories { } dependencies { - implementation("space.kscience:kmath-ast:0.4.0-dev-3") + implementation("space.kscience:kmath-ast:0.4.0") } ``` diff --git a/kmath-commons/README.md b/kmath-commons/README.md index 7ca7dacf8..2c60f4142 100644 --- a/kmath-commons/README.md +++ b/kmath-commons/README.md @@ -6,10 +6,9 @@ Commons math binding for kmath ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-commons:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-commons:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-commons:0.4.0-dev-3") + implementation("space.kscience:kmath-commons:0.4.0") } ``` diff --git a/kmath-complex/README.md b/kmath-complex/README.md index b5e4b9d58..d641452b0 100644 --- a/kmath-complex/README.md +++ b/kmath-complex/README.md @@ -2,15 +2,15 @@ Complex and hypercomplex number systems in KMath. -- [complex](src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex numbers operations -- [quaternion](src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions and their composition + - [complex](src/commonMain/kotlin/space/kscience/kmath/complex/Complex.kt) : Complex numbers operations + - [quaternion](src/commonMain/kotlin/space/kscience/kmath/complex/Quaternion.kt) : Quaternions and their composition + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-complex:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-complex:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -18,6 +18,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-complex:0.4.0-dev-3") + implementation("space.kscience:kmath-complex:0.4.0") } ``` diff --git a/kmath-core/README.md b/kmath-core/README.md index dd3935764..acb90a411 100644 --- a/kmath-core/README.md +++ b/kmath-core/README.md @@ -2,28 +2,23 @@ The core interfaces of KMath. -- [algebras](src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Algebraic structures like rings, spaces - and fields. -- [nd](src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt) : Many-dimensional structures and - operations on them. -- [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 -- [expressions](src/commonMain/kotlin/space/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. -- [domains](src/commonMain/kotlin/space/kscience/kmath/domains) : Domains -- [autodiff](src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic differentiation -- [linear.parallel](#) : Parallel implementation for `LinearAlgebra` + - [algebras](src/commonMain/kotlin/space/kscience/kmath/operations/Algebra.kt) : Algebraic structures like rings, spaces and fields. + - [nd](src/commonMain/kotlin/space/kscience/kmath/structures/StructureND.kt) : Many-dimensional structures and operations on them. + - [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 + - [expressions](src/commonMain/kotlin/space/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. + - [domains](src/commonMain/kotlin/space/kscience/kmath/domains) : Domains + - [autodiff](src/commonMain/kotlin/space/kscience/kmath/expressions/SimpleAutoDiff.kt) : Automatic differentiation + - [Parallel linear algebra](#) : Parallel implementation for `LinearAlgebra` + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-core:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-core:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -31,6 +26,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-core:0.4.0-dev-3") + implementation("space.kscience:kmath-core:0.4.0") } ``` diff --git a/kmath-coroutines/README.md b/kmath-coroutines/README.md index 5b64ccc0a..75ee7e5dc 100644 --- a/kmath-coroutines/README.md +++ b/kmath-coroutines/README.md @@ -1,13 +1,14 @@ # Module kmath-coroutines + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-coroutines:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-coroutines:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-coroutines:0.4.0-dev-3") + implementation("space.kscience:kmath-coroutines:0.4.0") } ``` diff --git a/kmath-dimensions/README.md b/kmath-dimensions/README.md index f2482f965..c7ea29b91 100644 --- a/kmath-dimensions/README.md +++ b/kmath-dimensions/README.md @@ -6,10 +6,9 @@ A proof of concept module for adding type-safe dimensions to structures ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-dimensions:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-dimensions:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-dimensions:0.4.0-dev-3") + implementation("space.kscience:kmath-dimensions:0.4.0") } ``` diff --git a/kmath-ejml/README.md b/kmath-ejml/README.md index a2c38ce8e..92ec252c1 100644 --- a/kmath-ejml/README.md +++ b/kmath-ejml/README.md @@ -2,16 +2,16 @@ EJML based linear algebra implementation. -- [ejml-vector](src/main/kotlin/space/kscience/kmath/ejml/EjmlVector.kt) : Point implementations. -- [ejml-matrix](src/main/kotlin/space/kscience/kmath/ejml/EjmlMatrix.kt) : Matrix implementation. -- [ejml-linear-space](src/main/kotlin/space/kscience/kmath/ejml/EjmlLinearSpace.kt) : LinearSpace implementations. + - [ejml-vector](src/main/kotlin/space/kscience/kmath/ejml/EjmlVector.kt) : Point implementations. + - [ejml-matrix](src/main/kotlin/space/kscience/kmath/ejml/EjmlMatrix.kt) : Matrix implementation. + - [ejml-linear-space](src/main/kotlin/space/kscience/kmath/ejml/EjmlLinearSpace.kt) : LinearSpace implementations. + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-ejml:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-ejml:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -19,6 +19,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-ejml:0.4.0-dev-3") + implementation("space.kscience:kmath-ejml:0.4.0") } ``` diff --git a/kmath-for-real/README.md b/kmath-for-real/README.md index 46762269e..c65f6db46 100644 --- a/kmath-for-real/README.md +++ b/kmath-for-real/README.md @@ -2,18 +2,16 @@ Specialization of KMath APIs for Double numbers. -- [DoubleVector](src/commonMain/kotlin/space/kscience/kmath/real/DoubleVector.kt) : Numpy-like operations for - Buffers/Points -- [DoubleMatrix](src/commonMain/kotlin/space/kscience/kmath/real/DoubleMatrix.kt) : Numpy-like operations for 2d real - structures -- [grids](src/commonMain/kotlin/space/kscience/kmath/structures/grids.kt) : Uniform grid generators + - [DoubleVector](src/commonMain/kotlin/space/kscience/kmath/real/DoubleVector.kt) : Numpy-like operations for Buffers/Points + - [DoubleMatrix](src/commonMain/kotlin/space/kscience/kmath/real/DoubleMatrix.kt) : Numpy-like operations for 2d real structures + - [grids](src/commonMain/kotlin/space/kscience/kmath/structures/grids.kt) : Uniform grid generators + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-for-real:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-for-real:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -21,6 +19,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-for-real:0.4.0-dev-3") + implementation("space.kscience:kmath-for-real:0.4.0") } ``` diff --git a/kmath-functions/README.md b/kmath-functions/README.md index 25c802077..c53bc5c11 100644 --- a/kmath-functions/README.md +++ b/kmath-functions/README.md @@ -2,20 +2,18 @@ Functions and interpolations. -- [piecewise](src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt) : Piecewise functions. -- [polynomials](src/commonMain/kotlin/space/kscience/kmath/functions/Polynomial.kt) : Polynomial functions. -- [linear interpolation](src/commonMain/kotlin/space/kscience/kmath/interpolation/LinearInterpolator.kt) : Linear XY - interpolator. -- [spline interpolation](src/commonMain/kotlin/space/kscience/kmath/interpolation/SplineInterpolator.kt) : Cubic spline - XY interpolator. -- [integration](#) : Univariate and multivariate quadratures + - [piecewise](src/commonMain/kotlin/space/kscience/kmath/functions/Piecewise.kt) : Piecewise functions. + - [polynomials](src/commonMain/kotlin/space/kscience/kmath/functions/Polynomial.kt) : Polynomial functions. + - [linear interpolation](src/commonMain/kotlin/space/kscience/kmath/interpolation/LinearInterpolator.kt) : Linear XY interpolator. + - [spline interpolation](src/commonMain/kotlin/space/kscience/kmath/interpolation/SplineInterpolator.kt) : Cubic spline XY interpolator. + - [integration](#) : Univariate and multivariate quadratures + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-functions:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-functions:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -23,6 +21,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-functions:0.4.0-dev-3") + implementation("space.kscience:kmath-functions:0.4.0") } ``` diff --git a/kmath-geometry/README.md b/kmath-geometry/README.md index 263df3a87..eed6b6cfd 100644 --- a/kmath-geometry/README.md +++ b/kmath-geometry/README.md @@ -1,13 +1,14 @@ # Module kmath-geometry + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-geometry:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-geometry:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-geometry:0.4.0-dev-3") + implementation("space.kscience:kmath-geometry:0.4.0") } ``` diff --git a/kmath-histograms/README.md b/kmath-histograms/README.md index 88f0c2dd4..5f494310a 100644 --- a/kmath-histograms/README.md +++ b/kmath-histograms/README.md @@ -1,13 +1,14 @@ # Module kmath-histograms + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-histograms:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-histograms:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-histograms:0.4.0-dev-3") + implementation("space.kscience:kmath-histograms:0.4.0") } ``` diff --git a/kmath-jafama/README.md b/kmath-jafama/README.md index 314ad47ab..2f8f365c1 100644 --- a/kmath-jafama/README.md +++ b/kmath-jafama/README.md @@ -2,14 +2,14 @@ Integration with [Jafama](https://github.com/jeffhain/jafama). -- [jafama-double](src/main/kotlin/space/kscience/kmath/jafama/) : Double ExtendedField implementations based on Jafama + - [jafama-double](src/main/kotlin/space/kscience/kmath/jafama/) : Double ExtendedField implementations based on Jafama + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-jafama:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-jafama:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,7 +17,7 @@ repositories { } dependencies { - implementation("space.kscience:kmath-jafama:0.4.0-dev-3") + implementation("space.kscience:kmath-jafama:0.4.0") } ``` diff --git a/kmath-jupyter/README.md b/kmath-jupyter/README.md index 21531f632..8a425dff0 100644 --- a/kmath-jupyter/README.md +++ b/kmath-jupyter/README.md @@ -1,13 +1,14 @@ # Module kmath-jupyter + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-jupyter:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-jupyter:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-jupyter:0.4.0-dev-3") + implementation("space.kscience:kmath-jupyter:0.4.0") } ``` diff --git a/kmath-kotlingrad/README.md b/kmath-kotlingrad/README.md index 2948799d3..697662245 100644 --- a/kmath-kotlingrad/README.md +++ b/kmath-kotlingrad/README.md @@ -2,17 +2,15 @@ [Kotlin∇](https://github.com/breandan/kotlingrad) integration module. -- [differentiable-mst-expression](src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt) : MST based - DifferentiableExpression. -- [scalars-adapters](src/main/kotlin/space/kscience/kmath/kotlingrad/scalarsAdapters.kt) : Conversions between Kotlin∇'s - SFun and MST + - [differentiable-mst-expression](src/main/kotlin/space/kscience/kmath/kotlingrad/KotlingradExpression.kt) : MST based DifferentiableExpression. + - [scalars-adapters](src/main/kotlin/space/kscience/kmath/kotlingrad/scalarsAdapters.kt) : Conversions between Kotlin∇'s SFun and MST + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-kotlingrad:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-kotlingrad:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -20,6 +18,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-kotlingrad:0.4.0-dev-3") + implementation("space.kscience:kmath-kotlingrad:0.4.0") } ``` diff --git a/kmath-memory/README.md b/kmath-memory/README.md index 8d66fe37d..5f08023b0 100644 --- a/kmath-memory/README.md +++ b/kmath-memory/README.md @@ -1,13 +1,14 @@ # Module kmath-memory + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-memory:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-memory:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-memory:0.4.0-dev-3") + implementation("space.kscience:kmath-memory:0.4.0") } ``` diff --git a/kmath-multik/README.md b/kmath-multik/README.md index 0bfc71a82..f69d5d5d0 100644 --- a/kmath-multik/README.md +++ b/kmath-multik/README.md @@ -6,10 +6,9 @@ JetBrains Multik connector ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-multik:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-multik:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-multik:0.4.0-dev-3") + implementation("space.kscience:kmath-multik:0.4.0") } ``` diff --git a/kmath-nd4j/README.md b/kmath-nd4j/README.md index 393a2a3e4..c2e0cafe0 100644 --- a/kmath-nd4j/README.md +++ b/kmath-nd4j/README.md @@ -2,16 +2,16 @@ ND4J based implementations of KMath abstractions. -- [nd4jarraystructure](#) : NDStructure wrapper for INDArray -- [nd4jarrayrings](#) : Rings over Nd4jArrayStructure of Int and Long -- [nd4jarrayfields](#) : Fields over Nd4jArrayStructure of Float and Double + - [nd4jarraystructure](#) : NDStructure wrapper for INDArray + - [nd4jarrayrings](#) : Rings over Nd4jArrayStructure of Int and Long + - [nd4jarrayfields](#) : Fields over Nd4jArrayStructure of Float and Double + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-nd4j:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-nd4j:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -19,7 +19,7 @@ repositories { } dependencies { - implementation("space.kscience:kmath-nd4j:0.4.0-dev-3") + implementation("space.kscience:kmath-nd4j:0.4.0") } ``` diff --git a/kmath-optimization/README.md b/kmath-optimization/README.md index e1e44fa4d..3728ab18e 100644 --- a/kmath-optimization/README.md +++ b/kmath-optimization/README.md @@ -1,13 +1,14 @@ # Module kmath-optimization + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-optimization:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-optimization:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-optimization:0.4.0-dev-3") + implementation("space.kscience:kmath-optimization:0.4.0") } ``` diff --git a/kmath-stat/README.md b/kmath-stat/README.md index 8de601893..63b8bc3b8 100644 --- a/kmath-stat/README.md +++ b/kmath-stat/README.md @@ -1,13 +1,14 @@ # Module kmath-stat + + ## Usage ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-stat:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-stat:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -15,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-stat:0.4.0-dev-3") + implementation("space.kscience:kmath-stat:0.4.0") } ``` diff --git a/kmath-symja/README.md b/kmath-symja/README.md index e1b1e2359..a082d8b27 100644 --- a/kmath-symja/README.md +++ b/kmath-symja/README.md @@ -6,10 +6,9 @@ Symja integration module ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-symja:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-symja:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-symja:0.4.0-dev-3") + implementation("space.kscience:kmath-symja:0.4.0") } ``` diff --git a/kmath-tensorflow/README.md b/kmath-tensorflow/README.md index 51c49e853..6c289c808 100644 --- a/kmath-tensorflow/README.md +++ b/kmath-tensorflow/README.md @@ -6,10 +6,9 @@ Google tensorflow connector ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-tensorflow:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-tensorflow:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-tensorflow:0.4.0-dev-3") + implementation("space.kscience:kmath-tensorflow:0.4.0") } ``` diff --git a/kmath-tensors/README.md b/kmath-tensors/README.md index 27ab26cbf..92f99028b 100644 --- a/kmath-tensors/README.md +++ b/kmath-tensors/README.md @@ -2,19 +2,16 @@ Common linear algebra operations on tensors. -- [tensor algebra](src/commonMain/kotlin/space/kscience/kmath/tensors/api/TensorAlgebra.kt) : Basic linear algebra - operations on tensors (plus, dot, etc.) -- [tensor algebra with broadcasting](src/commonMain/kotlin/space/kscience/kmath/tensors/core/BroadcastDoubleTensorAlgebra.kt) : - Basic linear algebra operations implemented with broadcasting. -- [linear algebra operations](src/commonMain/kotlin/space/kscience/kmath/tensors/api/LinearOpsTensorAlgebra.kt) : - Advanced linear algebra operations like LU decomposition, SVD, etc. + - [tensor algebra](src/commonMain/kotlin/space/kscience/kmath/tensors/api/TensorAlgebra.kt) : Basic linear algebra operations on tensors (plus, dot, etc.) + - [tensor algebra with broadcasting](src/commonMain/kotlin/space/kscience/kmath/tensors/core/BroadcastDoubleTensorAlgebra.kt) : Basic linear algebra operations implemented with broadcasting. + - [linear algebra operations](src/commonMain/kotlin/space/kscience/kmath/tensors/api/LinearOpsTensorAlgebra.kt) : Advanced linear algebra operations like LU decomposition, SVD, etc. + ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-tensors:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-tensors:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -22,6 +19,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-tensors:0.4.0-dev-3") + implementation("space.kscience:kmath-tensors:0.4.0") } ``` diff --git a/kmath-viktor/README.md b/kmath-viktor/README.md index 3d5ebd95c..73c8c8774 100644 --- a/kmath-viktor/README.md +++ b/kmath-viktor/README.md @@ -6,10 +6,9 @@ Binding for https://github.com/JetBrains-Research/viktor ## Artifact: -The Maven coordinates of this project are `space.kscience:kmath-viktor:0.4.0-dev-3`. +The Maven coordinates of this project are `space.kscience:kmath-viktor:0.4.0`. **Gradle Kotlin DSL:** - ```kotlin repositories { maven("https://repo.kotlin.link") @@ -17,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:kmath-viktor:0.4.0-dev-3") + implementation("space.kscience:kmath-viktor:0.4.0") } ```