Dump API. Update readme

SciProgCentre · Mar 27, 2024 · 255d4ba · 255d4ba
1 parent 48b334a
commit 255d4ba
Show file tree

Hide file tree

Showing 26 changed files with 166 additions and 199 deletions.
diff --git 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)
 
+### [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)
 
+### [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)
 
+### [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)
 
+### [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)
 
+### [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)
 
+### [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)
 
+### [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
@@ -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
@@ -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 <init> ()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
@@ -2,25 +2,25 @@
 
 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")
     mavenCentral()
 }
 
 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
@@ -6,17 +6,16 @@ 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")
     mavenCentral()
 }
 
 dependencies {
-    implementation("space.kscience:kmath-commons:0.4.0-dev-3")
+    implementation("space.kscience:kmath-commons:0.4.0")
 }
 ```