Feedback

.github/workflows/coverage.yml

@@ -0,0 +1,34 @@
+name: Measure coverage
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+      - name: Set up JDK 11
+        uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Run Test
+        run: |
+          chmod +x gradlew
+          ./gradlew test
+      - name: JaCoCO Coverage
+        id: jacoco
+        uses: Madrapps/[email protected]
+        with:
+          paths: |
+            ${{ github.workspace }}/build/reports/jacoco/test/jacocoTestReport.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+          skip-if-no-changes: true
+
+

.github/workflows/format_check.yml

@@ -0,0 +1,11 @@
+name: Run detekt - static code analyzer
+on:
+  push:
+jobs:
+  detekt:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "checkout"
+        uses: actions/checkout@v2
+      - name: "detekt"
+        uses: natiginfo/[email protected]

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Test
+
+on:
+  push:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+
+      - name: Setup JDK 11
+        uses: actions/setup-java@v4
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Build with Gradle
+        run: ./gradlew build

.gitignore

@@ -0,0 +1,8 @@
+### Gradle ###
+.gradle
+build
+build.gradle.kts
+gradle.properties
+
+### IntelliJ IDEA ###
+.idea

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Magomedov Islam, Damir Yunusov, Sofya Grishkova
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,77 @@
+[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) [![CodeFactor](https://www.codefactor.io/repository/github/spbu-coding-2023/trees-4/badge)](https://www.codefactor.io/repository/github/spbu-coding-2023/trees-4)
+
+## About Tree Lib
+
+Tree Lib is the kotlin library for working with 3 different binary tree implementations: Binary Search Tree (BST),
+AVL-Tree (AVL) and Red-Black Tree (RB).
+
+## How to use
+
+To init an object, you must provide key and value type.
+
+```
+val treeExample: BSTree<<Key>, <Value>>
+```
+
+for example
+
+```
+val treeExample = BSTree<String, Double>()
+```
+
+All trees supports basic methods:
+
+- Add values and keys as nodes to the tree:
+
+  `treeExample.add(key: "abc", value: 1.0)`
+
+- Change node's value:
+
+  `treeExample.changeVal(key: "abc", value: 37.7)`
+
+- Remove node from the tree:
+
+  `treeExample.remove(key: "Choose wisely.")`
+
+- Find node by key:
+
+  `treeExample.findByKey(key: "Anything you can compare!")`
+
+- Iterate in tree:
+
+  `for (node in treeExample) { ...`
+
+- ...and much more!
+
+With binary trees, Tree Lib provides a node type for each of them.
+You can read node's key and value(with key() and value() methods), compare
+them between each other(although they must share same type), convert them to
+pair(toPair()) or string(toString()).
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+## Contact
+
+This library was created by:
+
+* Magomedov Islam (tg @JapEmpLove) - BST
+* Damir Yunusov (tg @TopographicOcean) - RB
+* Sofya Grishkova (tg @tea_jack) - AVL
+
+## Acknowledgments
+
+[README Template](https://github.com/othneildrew/Best-README-Template)
+
+Links to Wikipages about binary trees:
+
+* [Binary Tree](https://en.wikipedia.org/wiki/Binary_tree)
+* [Binary Search Tree](https://en.wikipedia.org/wiki/Binary_search_tree)
+* [Red-Black Tree](https://en.wikipedia.org/wiki/Red%E2%80%93black_tree)
+* [AVL-Tree](https://en.wikipedia.org/wiki/AVL_tree)
+
+[Here](https://www.geeksforgeeks.org/applications-advantages-and-disadvantages-of-binary-search-tree/) are provided
+applications, advantages and disadvantages of Binary Search Tree
+
+Good [Habr article](https://habr.com/ru/articles/150732/) about AVL-Trees

build.gradle.kts

@@ -0,0 +1,39 @@
+plugins {
+    kotlin("jvm") version "1.9.23"
+    jacoco
+}
+
+group = "org.example"
+version = "1.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    testImplementation("org.jetbrains.kotlin:kotlin-test-junit5")
+    testImplementation("org.junit.jupiter:junit-jupiter-engine:5.9.2")
+}
+
+tasks.test {
+    useJUnitPlatform()
+    finalizedBy(tasks.jacocoTestReport)
+}
+tasks.jacocoTestReport {
+    dependsOn(tasks.test)
+    reports {
+        xml.required = true
+        csv.required = false
+        html.required = false
+        html.outputLocation = layout.buildDirectory.dir("jacoco")
+    }
+}
+
+kotlin {
+    jvmToolchain(21)
+}
+
+jacoco {
+    toolVersion = "0.8.11"
+    reportsDirectory = layout.buildDirectory.dir("reports/jacoco")
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Sat Mar 23 10:46:13 MSK 2024
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists