From 1316e6548ed71ff2ebd4fe3afeb910349af22310 Mon Sep 17 00:00:00 2001 From: Alexander Nozik Date: Tue, 9 May 2023 19:01:37 +0300 Subject: [PATCH] Remove vector type from polygon --- docs/templates/README-TEMPLATE.md | 13 +++++-------- .../kotlin/space/kscience/kmath/geometry/Polygon.kt | 4 ++-- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/templates/README-TEMPLATE.md b/docs/templates/README-TEMPLATE.md index d7d5a806d..8988a887e 100644 --- a/docs/templates/README-TEMPLATE.md +++ b/docs/templates/README-TEMPLATE.md @@ -59,22 +59,21 @@ ${modules} KMath is developed as a multi-platform library, which means that most of the interfaces are declared in the [common source sets](/kmath-core/src/commonMain) and implemented there wherever it is possible. In some cases, features are delegated to platform-specific implementations even if they could be provided in the common module for performance -reasons. Currently, the Kotlin/JVM is the primary platform, however Kotlin/Native and Kotlin/JS contributions and +reasons. Currently, Kotlin/JVM is the primary platform, however, Kotlin/Native and Kotlin/JS contributions and feedback are also welcome. ## Performance -Calculation performance is one of major goals of KMath in the future, but in some cases it is impossible to achieve both +Calculation of performance is one of the major goals of KMath in the future, but in some cases it is impossible to achieve both performance and flexibility. -We expect to focus on creating convenient universal API first and then work on increasing performance for specific +We expect to focus on creating a convenient universal API first and then work on increasing performance for specific cases. We expect the worst KMath benchmarks will perform better than native Python, but worse than optimized native/SciPy (mostly due to boxing operations on primitive numbers). The best performance of optimized parts could be better than SciPy. ## Requirements -KMath currently relies on JDK 11 for compilation and execution of Kotlin-JVM part. We recommend to use GraalVM-CE 11 for -execution to get better performance. +KMath currently relies on JDK 11 for compilation and execution of Kotlin-JVM part. We recommend using GraalVM-CE 11/17 for execution to get better performance. ### Repositories @@ -94,11 +93,9 @@ dependencies { } ``` -Gradle `6.0+` is required for multiplatform artifacts. - ## Contributing The project requires a lot of additional work. The most important thing we need is a feedback about what features are required the most. Feel free to create feature requests. We are also welcome to code contributions, especially in issues marked with -[waiting for a hero](https://github.com/mipt-npm/kmath/labels/waiting%20for%20a%20hero) label. \ No newline at end of file +[good first issue](hhttps://github.com/SciProgCentre/kmath/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) label. \ No newline at end of file diff --git a/kmath-geometry/src/commonMain/kotlin/space/kscience/kmath/geometry/Polygon.kt b/kmath-geometry/src/commonMain/kotlin/space/kscience/kmath/geometry/Polygon.kt index 20f4a031e..0d82f865c 100644 --- a/kmath-geometry/src/commonMain/kotlin/space/kscience/kmath/geometry/Polygon.kt +++ b/kmath-geometry/src/commonMain/kotlin/space/kscience/kmath/geometry/Polygon.kt @@ -9,6 +9,6 @@ package space.kscience.kmath.geometry /** * A closed polygon in 2D space */ -public interface Polygon { - public val points: List> +public interface Polygon { + public val points: List } \ No newline at end of file