created spec for labeled graph (#77)

Author: BusyByte

core/src/main/scala/aima/core/environment/map2d/LabeledGraph.scala

@@ -0,0 +1,61 @@
+package aima.core.environment.map2d
+
+/**
+  * @author Shawn Garner
+  */
+final class LabeledGraph[Vertex, Edge] {
+  import scala.collection.mutable
+  val globalEdgeLookup = new mutable.LinkedHashMap[Vertex, mutable.LinkedHashMap[Vertex, Edge]]() // TODO: get rid of mutability; ListMap should work
+  val vertexLabelsList = new mutable.ArrayBuffer[Vertex]()                                        // TODO: get rid of mutability
+
+  def addVertex(v: Vertex): Unit = {
+    checkForNewVertex(v)
+    ()
+  }
+
+  def set(from: Vertex, to: Vertex, edge: Edge): Unit = {
+    val localEdgeLookup = checkForNewVertex(from)
+    localEdgeLookup.put(to, edge)
+    checkForNewVertex(to)
+    ()
+  }
+
+  def remove(from: Vertex, to: Vertex): Unit = {
+    val localEdgeLookup = globalEdgeLookup.get(from)
+    localEdgeLookup.foreach(l => l.remove(to))
+  }
+
+  def get(from: Vertex, to: Vertex): Option[Edge] = {
+    val localEdgeLookup = globalEdgeLookup.get(from)
+    localEdgeLookup.flatMap(_.get(to))
+  }
+
+  def successors(v: Vertex): List[Vertex] = {
+    val localEdgeLookup = globalEdgeLookup.get(v)
+    localEdgeLookup.toList.flatMap(_.keySet.toList)
+  }
+
+  def vertexLabels =
+    vertexLabelsList.toList
+
+  def isVertexLabel(v: Vertex): Boolean =
+    globalEdgeLookup.get(v).isDefined
+
+  def clear(): Unit = {
+    vertexLabelsList.clear()
+    globalEdgeLookup.clear()
+  }
+
+  private def checkForNewVertex(v: Vertex): mutable.LinkedHashMap[Vertex, Edge] = {
+    val maybeExisting = globalEdgeLookup.get(v)
+    maybeExisting match {
+      case None =>
+        val m = new mutable.LinkedHashMap[Vertex, Edge]
+        globalEdgeLookup.put(v, m)
+        vertexLabelsList.append(v)
+        m
+      case Some(existing) =>
+        existing
+    }
+  }
+}

core/src/main/scala/aima/core/environment/map2d/Map2D.scala

@@ -48,63 +48,6 @@ trait Map2D {
   def position(location: String): Option[Point2D]
 }
 
-final class LabeledGraph[Vertex, Edge] {
-  import scala.collection.mutable
-  val globalEdgeLookup = new mutable.LinkedHashMap[Vertex, mutable.LinkedHashMap[Vertex, Edge]]() // TODO: get rid of mutability; ListMap should work
-  val vertexLabelsList = new mutable.ArrayBuffer[Vertex]()                                        // TODO: get rid of mutability
-
-  def addVertex(v: Vertex): Unit = {
-    checkForNewVertex(v)
-    ()
-  }
-
-  def set(from: Vertex, to: Vertex, edge: Edge): Unit = {
-    val localEdgeLookup = checkForNewVertex(from)
-    localEdgeLookup.put(to, edge)
-    checkForNewVertex(to)
-    ()
-  }
-
-  def remove(from: Vertex, to: Vertex): Unit = {
-    val localEdgeLookup = globalEdgeLookup.get(from)
-    localEdgeLookup.foreach(l => l.remove(to))
-  }
-
-  def get(from: Vertex, to: Vertex): Option[Edge] = {
-    val localEdgeLookup = globalEdgeLookup.get(from)
-    localEdgeLookup.flatMap(_.get(to))
-  }
-
-  def successors(v: Vertex): List[Vertex] = {
-    val localEdgeLookup = globalEdgeLookup.get(v)
-    localEdgeLookup.toList.flatMap(_.keySet.toList)
-  }
-
-  def vertexLabels =
-    vertexLabelsList.toList
-
-  def isVertexLabel(v: Vertex): Boolean =
-    globalEdgeLookup.get(v).isDefined
-
-  def clear(): Unit = {
-    vertexLabelsList.clear()
-    globalEdgeLookup.clear()
-  }
-
-  private def checkForNewVertex(v: Vertex): mutable.LinkedHashMap[Vertex, Edge] = {
-    val maybeExisting = globalEdgeLookup.get(v)
-    maybeExisting match {
-      case None =>
-        val m = new mutable.LinkedHashMap[Vertex, Edge]
-        globalEdgeLookup.put(v, m)
-        vertexLabelsList.append(v)
-        m
-      case Some(existing) =>
-        existing
-    }
-  }
-}
-
 final case class Point2D(x: Double, y: Double)
 final case class Distance(value: Double) extends AnyVal
 object Point2D {
@@ -141,8 +84,6 @@ class ExtendableMap2D(
     locationPositions.clear()
   }
 
-  def clearLinks(): Unit = links.clear()
-
   /**
     * Add a one-way connection to the map.
     *
@@ -173,44 +114,6 @@ class ExtendableMap2D(
     links.set(toLocation, fromLocation, distance)
   }
 
-  /**
-    * Remove a one-way connection.
-    *
-    * @param fromLocation
-    * the from location.
-    * @param toLocation
-    * the to location.
-    */
-  def removeUnidirectionalLink(fromLocation: String, toLocation: String): Unit = {
-    links.remove(fromLocation, toLocation)
-  }
-
-  /**
-    * Remove the two corresponding one-way connections.
-    *
-    * @param fromLocation
-    * the from location.
-    * @param toLocation
-    * the to location.
-    */
-  def removeBidirectionalLink(fromLocation: String, toLocation: String): Unit = {
-    links.remove(fromLocation, toLocation)
-    links.remove(toLocation, fromLocation)
-  }
-
-  /**
-    * Defines the position of a location with respect to a 2 dimensional
-    * coordinate system.
-    *
-    * @param loc
-    * the location.
-    * @param pos the x, y position
-    */
-  def setPosition(loc: String, pos: Point2D): Unit = {
-    locationPositions.put(loc, pos)
-    ()
-  }
-
   /**
     * Defines the position of a location within the map. Using this method, one
     * location should be selected as a reference position (<code>dist=0</code>

core/src/test/scala/aima/core/environment/map2d/LabeledGraphSpec.scala

@@ -0,0 +1,90 @@
+package aima.core.environment.map2d
+
+import org.specs2.mutable.Specification
+
+/**
+  * @author Shawn Garner
+  */
+class LabeledGraphSpec extends Specification {
+  "add vertex" in {
+    val graph = new LabeledGraph[Int, (Int, Int)]
+
+    graph.vertexLabels must beEmpty
+
+    graph.addVertex(2)
+
+    graph.vertexLabels must haveSize(1)
+    graph.isVertexLabel(2) must beTrue
+    graph.isVertexLabel(1) must beFalse
+
+    graph.addVertex(3)
+
+    graph.vertexLabels must haveSize(2)
+    graph.isVertexLabel(3) must beTrue
+    graph.isVertexLabel(2) must beTrue
+    graph.isVertexLabel(1) must beFalse
+
+    graph.vertexLabels must contain(exactly(2, 3))
+  }
+
+  "edge creation" in {
+    val graph = new LabeledGraph[Int, (Int, Int)]
+
+    graph.addVertex(2)
+
+    graph.vertexLabels must haveSize(1)
+    graph.isVertexLabel(2) must beTrue
+
+    graph.addVertex(6)
+
+    graph.vertexLabels must haveSize(2)
+    graph.isVertexLabel(6) must beTrue
+
+    graph.set(2, 6, (2, 6))
+
+    graph.vertexLabels must haveSize(2)
+
+    graph.set(3, 12, (3, 12))
+
+    graph.vertexLabels must haveSize(4)
+    graph.isVertexLabel(3) must beTrue
+    graph.isVertexLabel(12) must beTrue
+
+    graph.set(2, 12, (2, 12))
+
+    graph.vertexLabels must haveSize(4)
+
+    graph.set(3, 6, (3, 6))
+
+    graph.vertexLabels must haveSize(4)
+
+    graph.set(6, 12, (6, 12))
+
+    graph.vertexLabels must haveSize(4)
+
+    graph.get(2, 3) must beNone
+    graph.get(2, 6) must beSome((2, 6))
+    graph.get(3, 6) must beSome((3, 6))
+    graph.get(3, 12) must beSome((3, 12))
+    graph.get(6, 12) must beSome((6, 12))
+  }
+
+  "get successors" in {
+    val graph = new LabeledGraph[Int, (Int, Int)]
+
+    graph.successors(2) must beEmpty
+
+    graph.set(2, 12, (2, 12))
+    graph.set(3, 12, (3, 12))
+    graph.set(2, 6, (2, 6))
+    graph.set(3, 6, (3, 6))
+    graph.set(6, 12, (6, 12))
+
+    graph.successors(2) must contain(exactly(6, 12))
+    graph.successors(3) must contain(exactly(6, 12))
+
+    graph.successors(6) must contain(exactly(12))
+    graph.successors(12) must beEmpty
+  }
+
+}