Feedback

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

.github/mergeable.yml

@@ -0,0 +1,29 @@
+version: 2
+mergeable:
+  - when: pull_request.*, pull_request_review.*
+    filter:
+      - do: payload
+        pull_request:
+          title:
+            must_exclude:
+              regex: ^Feedback$
+              regex_flag: none
+    validate:
+      - do: title
+        no_empty:
+          enabled: true
+          message: "The title should not be empty."
+        begins_with:
+          match: ['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z']
+          message: "The name must begin with a capital letter."
+
+      - do: description
+        no_empty:
+          enabled: true
+          message: "The description should not be empty."
+
+      - do: approvals
+        min:
+          count: 1
+        required:
+          assignees: true

.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Test with coverage
+on:
+  push:
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v2
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+        with:
+          gradle-version: current
+          gradle-home-cache-cleanup: true
+      - name: Run test
+        run: |
+          ./gradlew clean
+          ./gradlew test
+      - name: JaCoCo Coverage Report
+        env:
+          report_path: BinarySearchTrees/build/jacoco/report.csv
+        run: |
+          awk -F"," '{ instructions += $4 + $5; covered += $5; branches += $6 + $7; branches_covered +=$7 } END { print "Instructions covered:", covered"/"instructions, "--", 100*covered/instructions"%"; print "Branches covered:", branches_covered"/"branches, "--", 100*branches_covered/branches"%" }' $report_path
+      - uses: actions/upload-artifact@v3
+        with:
+          name: binarysearchtree-test-and-coverage-reports
+          path: |
+            BinarySearchTrees/build/reports

.gitignore

@@ -0,0 +1,53 @@
+# Ignore Gradle project-specific cache directory
+.gradle
+
+# Ignore Gradle build output directory
+**/build/
+!src/**/build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Avoid ignore Gradle wrappper properties
+!gradle-wrapper.properties
+
+# Cache of project
+.gradletasknamecache
+
+# Eclipse Gradle plugin generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# Out Package #
+/out/
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+.idea

BinarySearchTrees/build.gradle.kts

@@ -0,0 +1,44 @@
+plugins {
+    id("org.jetbrains.kotlin.jvm") version "1.8.10"
+    jacoco
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    // Use the Kotlin JDK 8 standard library.
+    implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+
+    testImplementation(platform("org.junit:junit-bom:5.9.2"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
+}
+
+tasks.test {
+    finalizedBy("jacocoTestReport")
+    useJUnitPlatform()
+    maxHeapSize = "2G"
+    testLogging {
+        events("passed", "skipped", "failed")
+    }
+    reports.html.outputLocation.set(file("${buildDir}/reports/test"))
+}
+
+tasks.named<JacocoReport>("jacocoTestReport") {
+    dependsOn(tasks.test)
+
+    classDirectories.setFrom(files(classDirectories.files.map {
+        fileTree(it) {
+            exclude("**/binarysearchtrees/TreesKt.*")
+        }
+    }))
+
+    reports {
+        xml.required.set(false)
+        html.required.set(true)
+        html.outputLocation.set(file("${buildDir}/reports/jacoco"))
+        csv.required.set(true)
+        csv.outputLocation.set(file("${buildDir}/jacoco/report.csv"))
+    }
+}

BinarySearchTrees/src/main/kotlin/binarysearchtrees/BinarySearchTree.kt

@@ -0,0 +1,23 @@
+package binarysearchtrees
+
+interface BinarySearchTree<K : Comparable<K>, V> {
+    val size: Int
+
+    fun isEmpty(): Boolean
+
+    fun clear()
+
+    fun getRoot(): MutableVertex<K, V>?
+
+    operator fun get(key: K): V?
+
+    fun put(key: K, value: V): V?
+
+    operator fun set(key: K, value: V)
+
+    fun remove(key: K): V?
+
+    fun remove(key: K, value: V): Boolean
+
+    operator fun iterator(): Iterator<MutableVertex<K, V>>
+}

BinarySearchTrees/src/main/kotlin/binarysearchtrees/Trees.kt

@@ -0,0 +1,19 @@
+package binarysearchtrees
+
+import binarysearchtrees.redblacktree.RedBlackTree
+
+// initializing functions
+
+fun <K : Comparable<K>, V> binarySearchTreeOf(): BinarySearchTree<K, V> {
+    return RedBlackTree<K, V>()
+}
+
+fun <K : Comparable<K>, V> binarySearchTreeOf(
+    vararg args: Pair<K, V>
+): BinarySearchTree<K, V> {
+    val tree = RedBlackTree<K, V>()
+    for (it in args) {
+        tree.put(it.first, it.second)
+    }
+    return tree
+}

BinarySearchTrees/src/main/kotlin/binarysearchtrees/Vertices.kt

@@ -0,0 +1,16 @@
+package binarysearchtrees
+
+//for extension functions like all, any, ...
+interface Vertex<K, V> {
+    val key: K
+    val value: V
+    val left: Vertex<K, V>?
+    val right: Vertex<K, V>?
+}
+
+interface MutableVertex<K, V> : Vertex<K, V> {
+    override val left: MutableVertex<K, V>?
+    override val right: MutableVertex<K, V>?
+
+    fun setValue(newValue: V): V
+}