Clean up and add documentation

README.adoc

@@ -0,0 +1,33 @@
+= Playground-Game-of-Life
+Dmitrij Drandarov <https://github.com/dmitrij-drandarov>
+:imagesdir: img
+
+== Authors
+
+* Dmitrij Drandarov | link:https://github.com/dmitrij-drandarov[image:github.png[20px, 20px]] | link:https://twitter.com/drandarov_io[image:twitter.png[20px, 20px]] | link:https://www.xing.com/profile/Dmitrij_Drandarov[image:xing.png[20px, 20px]] | link:https://www.linkedin.com/in/dmitrij-drandarov/[image:linkedin.png[20px, 20px]]
+
+== Demo
+=== Kotlin-Functional-Processing-3D
+image:gol_3D.png[3D Visualization (above), seperate layers (below)]
+
+== Variants
+
+=== link:/java-functional/src/main/java/io/drandarov/gol[Java-Functional]
+
+=== link:/java-functional-3d/src/main/java/io/drandarov/gol[Java-Functional-3D (no GUI)]
+
+=== link:/kotlin-converted-from-java-functional/src/main/java/io/drandarov/gol[Kotlin converted-from-Java-Functional]
+
+=== link:/kotlin-functional/src/main/java/io/drandarov/gol[Kotlin-Functional]
+
+=== link:/kotlin-functional-processing/src/main/java/io/drandarov/gol[Kotlin-Functional-Processing (GUI)]
+
+- Right Arrow: Step
+
+=== link:/kotlin-functional-processing-3d/src/main/java/io/drandarov/gol[Kotlin-Functional-Processing-3D (GUI)]
+
+- Right Arrow: Step
+- W, S: Zoom
+- A, D: Rotate
+- Q, E: Change cube gaps
+- C : Show/Hide coordinate lines

kotlin-functional-processing-3d/src/main/kotlin/io/drandarov/gol/functional/GoL.kt → kotlin-functional-processing-3d/src/main/kotlin/io/drandarov/gol/GoL.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 typealias World = List<List<List<Boolean>>>
 

kotlin-functional-processing-3d/src/main/kotlin/io/drandarov/gol/functional/GoLDemo.kt → kotlin-functional-processing-3d/src/main/kotlin/io/drandarov/gol/GoLDemo.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 import processing.core.PApplet
 
@@ -18,6 +18,7 @@ class GoLDemo : PApplet() {
         val sliceWidth = world.width * (size + gap) + sliceGap
         var sliceWidthSum = sliceWidth * world.depth - sliceGap
         val sliceHeightSum = world.height * (size + gap)
+        var showCoords = true
 
         var size3D = 20f
         var gap3D = 0f
@@ -66,6 +67,8 @@ class GoLDemo : PApplet() {
             gap3D += 2f
         if (key == 'q')
             gap3D = max(0f, gap3D - 2f)
+        if (key == 'c')
+            showCoords = !showCoords
     }
 
     override fun mouseClicked() {
@@ -103,10 +106,13 @@ class GoLDemo : PApplet() {
                 (world.depth - 1) * (size3D + gap3D))
         rotateY(rotation)
 
-        stroke(200f, 0f, 0f)
-        line(-200f, 0f, 0f, 200f, 0f, 0f)
-        line(0f, -200f, 0f, 0f, 200f, 0f)
-        line(0f, 0f, -200f, 0f, 0f, 200f)
+        if (showCoords) {
+            val l = 10f * size3D
+            stroke(l, 0f, 0f)
+            line(-l, 0f, 0f, l, 0f, 0f)
+            line(0f, -l, 0f, 0f, l, 0f)
+            line(0f, 0f, -l, 0f, 0f, l)
+        }
 
         world.forEachIndexed { z, slice ->
             slice.forEachIndexed { y, row ->

kotlin-functional-processing-3d/src/test/kotlin/io/drandarov/gol/GoLTest.kt

@@ -0,0 +1,47 @@
+package io.drandarov.gol
+
+import org.junit.jupiter.api.Assertions.*
+import org.junit.jupiter.api.Test
+
+class GoLTest {
+
+    companion object {
+        private val testWorld: World = createWorld(10, 12, 5)
+                .flipAt(1, 0, 0)
+                .flipAt(2, 1, 0)
+                .flipAt(0, 2, 0)
+                .flipAt(1, 2, 0)
+                .flipAt(2, 2, 0)
+                .flipAt(9, 14, 0)
+    }
+
+    @Test
+    fun neighborCountTest() {
+        assertEquals(1, testWorld.neighbourCount(1, 0, 0))
+        assertEquals(3, testWorld.neighbourCount(2, 1, 0))
+        assertEquals(1, testWorld.neighbourCount(0, 2, 0))
+        assertEquals(3, testWorld.neighbourCount(1, 2, 0))
+        assertEquals(2, testWorld.neighbourCount(2, 2, 0))
+        assertEquals(0, testWorld.neighbourCount(9, 11, 0))
+    }
+
+    @Test
+    fun isAliveTest() {
+        assertTrue(testWorld.isAliveNeighbor(0, 0, 0, 1, 0, 0))
+        assertTrue(testWorld.isAliveNeighbor(1, 1, 0, 2, 1, 0))
+        assertTrue(testWorld.isAliveNeighbor(1, 1, 0, 1, 2, 0))
+
+        assertFalse(testWorld.isAliveNeighbor(1, 0, 0, 0, -1, 0))
+        assertFalse(testWorld.isAliveNeighbor(-100, 5, 0, -101, 6, 0))
+    }
+
+    @Test
+    fun flipAtTest() {
+        assertTrue(testWorld.flipAt(8, 8, 0).isAlive(8, 8, 0))
+
+        assertFalse(testWorld.flipAt(2, 2, 0).isAlive(2, 2, 0))
+        assertFalse(testWorld.flipAt(1, 80, 0).isAlive(1, 80, 0))
+    }
+
+}
+

kotlin-functional/src/main/kotlin/io/drandarov/gol/functional/GoL.kt → kotlin-functional-processing/src/main/kotlin/io/drandarov/gol/GoL.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 typealias World = List<List<Boolean>>
 

kotlin-functional-processing/src/main/kotlin/io/drandarov/gol/functional/GoLDemo.kt → kotlin-functional-processing/src/main/kotlin/io/drandarov/gol/GoLDemo.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 import processing.core.PApplet
 

kotlin-functional/src/test/kotlin/io/drandarov/gol/functional/GoLTest.kt → kotlin-functional-processing/src/test/kotlin/io/drandarov/gol/GoLTest.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.BeforeAll

kotlin-functional-processing/src/main/kotlin/io/drandarov/gol/functional/GoL.kt → kotlin-functional/src/main/kotlin/io/drandarov/gol/GoL.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 typealias World = List<List<Boolean>>
 

kotlin-functional/src/main/kotlin/io/drandarov/gol/functional/GoLDemo.kt → kotlin-functional/src/main/kotlin/io/drandarov/gol/GoLDemo.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 fun main(args: Array<String>) {
     var world: World = createWorld(10, 15)

kotlin-functional-processing-3d/src/test/kotlin/io/drandarov/gol/functional/GoLTest.kt → kotlin-functional/src/test/kotlin/io/drandarov/gol/GoLTest.kt

@@ -1,4 +1,4 @@
-package io.drandarov.gol.functional
+package io.drandarov.gol
 
 import org.junit.jupiter.api.Assertions.*
 import org.junit.jupiter.api.BeforeAll