.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v6.0.0
+    rev: v4.5.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -12,6 +12,6 @@ repos:
       - id: trailing-whitespace
       - id: check-yaml
   - repo: https://git.garrity.co/garrity-software/gs-pre-commit-scala
-    rev: v1.0.2
+    rev: v1.0.1
     hooks:
       - id: scalafmt

.scalafmt.conf

@@ -1,5 +1,5 @@
 // See: https://github.com/scalameta/scalafmt/tags for the latest tags.
-version = 3.10.4
+version = 3.10.2
 runner.dialect = scala3
 maxColumn = 80
 

build.sbt

@@ -1,4 +1,4 @@
-val scala3: String = "3.8.2"
+val scala3: String = "3.7.4"
 
 ThisBuild / scalaVersion  := scala3
 ThisBuild / versionScheme := Some("semver-spec")
@@ -31,14 +31,14 @@ val Deps = new {
   }
 
   val Fs2 = new {
-    val Core: ModuleID = "co.fs2" %% "fs2-core" % "3.13.0"
+    val Core: ModuleID = "co.fs2" %% "fs2-core" % "3.12.2"
   }
 
   val Gs = new {
-    val Datagen: ModuleID = "gs" %% "gs-datagen-core-v0" % "0.4.1"
+    val Datagen: ModuleID = "gs" %% "gs-datagen-core-v0" % "0.3.3"
   }
 
-  val MUnit: ModuleID = "org.scalameta" %% "munit" % "1.2.4"
+  val MUnit: ModuleID = "org.scalameta" %% "munit" % "1.1.1"
 }
 
 lazy val testSettings = Seq(
@@ -51,7 +51,6 @@ lazy val testSettings = Seq(
 lazy val `gs-graph` = project
   .in(file("."))
   .aggregate(core, cats, fs2)
-  .settings(noPublishSettings)
   .settings(sharedSettings)
   .settings(testSettings)
   .settings(name := s"${gsProjectName.value}-v${semVerMajor.value}")

modules/core/src/main/scala/gs/graph/v0/Adjacency.scala

@@ -20,26 +20,6 @@ final class Adjacency(val neighbors: Vector[Vector[Vertex]]):
     */
   def at(vertex: Vertex): Vector[Vertex] = neighbors(vertex.ordinal)
 
-  /** Get the vector of _incoming_ [[Vertex]] that point _to_ some input
-    * [[Vertex]].
-    *
-    * @param vertex
-    *   The [[Vertex]] for which to retrieve the incoming vertices.
-    * @return
-    *   The list of [[Vertex]] that have an edge _to_ the input [[Vertex]].
-    */
-  def incoming(vertex: Vertex): Vector[Vertex] =
-    if vertex.ordinal >= neighbors.length then Vector.empty
-    else
-      neighbors.zipWithIndex
-        .filter {
-          // ignore the neighbors of the input vertex
-          case (_, index) => index != vertex.ordinal
-        }
-        .filter(_._1.contains(vertex))
-        .map(_._2)
-        .map(Vertex(_))
-
   /** Express this [[Adjacency]] as a vector of [[Edge]].
     *
     * @return
@@ -51,9 +31,10 @@ final class Adjacency(val neighbors: Vector[Vector[Vertex]]):
       tos.map(to => Edge(from, to)).distinct
     }
 
-  /** The number of vertices represented by this adjacency list.
+  /** @return
+    *   The number of vertices represented by this adjacency list.
     */
-  lazy val numberOfVertices: Size = Size.fromVector(neighbors)
+  def numberOfVertices: Size = Size.fromVector(neighbors)
 
   /** Perform a linear traversal for each [[gs.graph.v0.Vertex]] to calculate
     * the total number of edges in this adjacency list.
@@ -61,11 +42,9 @@ final class Adjacency(val neighbors: Vector[Vector[Vertex]]):
     * @return
     *   The number of edges in this adjacency list.
     */
-  lazy val numberOfEdges: Size = Size(neighbors.map(_.length).reduce(_ + _))
+  def numberOfEdges: Size = Size(neighbors.map(_.length).reduce(_ + _))
 
-  /** All vertices that do not have inbound connections.
+  def findRoots(): Vector[Vertex] =
-    */
-  lazy val roots: Vector[Vertex] =
     val counts = Array.fill(neighbors.length)(0)
     neighbors.foreach { ns =>
       // Each vertex listed here is receiving an inbound connection, if we
@@ -95,17 +74,6 @@ object Adjacency:
     */
   def apply(adj: Vector[Vector[Vertex]]): Adjacency = new Adjacency(adj)
 
-  /** Create an empty adjacency list for some number of vertices. No vertex has
-    * any connections to another vertex.
-    *
-    * @param numberOfVertices
-    *   The number of vertices in this disconnected graph.
-    * @return
-    *   Some new empty adjacency.
-    */
-  def empty(numberOfVertices: Size): Adjacency =
-    new Adjacency(Vector.fill(numberOfVertices.value)(Vector.empty))
-
   given CanEqual[Adjacency, Adjacency] = CanEqual.derived
 
   /** @return
@@ -118,8 +86,7 @@ object Adjacency:
     */
   final val Single: Adjacency = new Adjacency(Vector(Vector.empty))
 
-  /** Calculate an [[Adjacency]] from some collection of [[Edge]], where those
+  /** Calculate an [[Adjacency]] from some collection of [[Edge]].
-    * edges are assumed to be directed.
     *
     * @param numberOfVertices
     *   The number of [[Vertex]] (`N`) in this graph.

modules/core/src/main/scala/gs/graph/v0/Edge.scala

@@ -1,7 +1,5 @@
 package gs.graph.v0
 
-import java.util.Objects
-
 /** Represents a relationship between two [[Vertex]].
   *
   * When used is a directed context, the edge goes _from_ `v1` _to_ `v2`.
@@ -43,11 +41,6 @@ final class Edge(
       case other: Edge => v1 == other.v1 && v2 == other.v2
       case _           => false
 
-  /** @inheritDocs
-    */
-  override def hashCode(): Int =
-    Objects.hash(v1, v2)
-
 end Edge
 
 object Edge:

modules/core/src/main/scala/gs/graph/v0/GraphDisposition.scala

@@ -1,10 +1,5 @@
 package gs.graph.v0
 
-/** Describes the fundamental disposition of some graph.
-  *
-  * @param name
-  *   The string value of this disposition.
-  */
 sealed abstract class GraphDisposition(val name: String):
 
   override def equals(that: Any): Boolean =
@@ -20,12 +15,7 @@ object GraphDisposition:
 
   given CanEqual[GraphDisposition, GraphDisposition] = CanEqual.derived
 
-  /** The graph has directed relationships between vertices.
-    */
   case object Directed   extends GraphDisposition("directed")
-
-  /** The graph has relationships between vertices with no logical direction.
-    */
   case object Undirected extends GraphDisposition("undirected")
 
 end GraphDisposition

modules/core/src/main/scala/gs/graph/v0/directed/Digraph.scala

@@ -29,8 +29,6 @@ class Digraph(
     */
   override def selectRoots(): Vector[Vertex] = roots
 
-  /** @inheritDocs
-    */
   override def equals(that: Any): Boolean =
     that match
       case other: Digraph =>
@@ -80,7 +78,7 @@ object Digraph:
     new Digraph(
       numberOfVertices = adjacency.numberOfVertices,
       adjacency = adjacency,
-      roots = adjacency.roots
+      roots = adjacency.findRoots()
     )
 
   /** Find all roots for the given collection of [[Edge]].

modules/core/src/main/scala/gs/graph/v0/directed/SingleRootDigraph.scala

@@ -6,30 +6,14 @@ import gs.graph.v0.GraphException
 import gs.graph.v0.Size
 import gs.graph.v0.Vertex
 
-/** Specialization of [[Digraph]] that always has a single root vertex.
-  *
-  * @param n
-  *   The number of [[Vertex]] present in this graph.
-  * @param a
-  *   The [[Adjacency]] that describes this graph.
-  * @param r
-  *   The singular root [[Vertex]].
-  */
 class SingleRootDigraph(
   n: Size,
   a: Adjacency,
-  root: Vertex
+  r: Vertex
-) extends Digraph(n, a, Vector(root))
+) extends Digraph(n, a, Vector(r))
 
 object SingleRootDigraph:
 
-  /** Attempt to show that the given [[Digraph]] has a single root.
-    *
-    * @param dg
-    *   The input [[Digraph]].
-    * @return
-    *   [[SingleRootDigraph]] or `None` if the number of roots is not 1.
-    */
   def fromDirectedGraph(dg: Digraph): Option[SingleRootDigraph] =
     if dg.roots.size == 1 then
       Some(
@@ -41,18 +25,6 @@ object SingleRootDigraph:
       )
     else None
 
-  /** Given some edges, build a [[SingleRootDigraph]]. Throw an exception if
-    * this operation fails.
-    *
-    * @param numberOfVertices
-    *   The number of [[Vertex]] in the graph.
-    * @param edges
-    *   The collection of [[Edge]] that describe the graph.
-    * @param root
-    *   The root [[Vertex]].
-    * @return
-    *   The new [[SingleRootDigraph]].
-    */
   def fromEdgesUnsafe(
     numberOfVertices: Size,
     edges: Iterable[Edge],
@@ -66,17 +38,6 @@ object SingleRootDigraph:
       )
     else throw GraphException.RootOutOfBounds(root, numberOfVertices)
 
-  /** Given some edges, build a [[SingleRootDigraph]] if that collection
-    * represents a graph with a single root.
-    *
-    * @param numberOfVertices
-    *   The number of [[Vertex]] in the graph.
-    * @param edges
-    *   The collection of [[Edge]] that describe the graph.
-    * @return
-    *   The new [[SingleRootDigraph]], or `None` if the edges do not describe a
-    *   digraph with a single root.
-    */
   def fromEdges(
     numberOfVertices: Size,
     edges: Iterable[Edge]
@@ -92,19 +53,6 @@ object SingleRootDigraph:
       )
     else None
 
-  /** Given some [[Adjacency]] and a given root [[Vertex]], instantiate a new
-    * [[SingleRootDigraph]].
-    *
-    * Throws an exception if the given root is not contained within the
-    * [[Adjacency]].
-    *
-    * @param adjacency
-    *   The [[Adjacency]] which describes the graph.
-    * @param root
-    *   The root [[Vertex]].
-    * @return
-    *   New [[SingleRootDigraph]]
-    */
   def fromAdjacencyUnsafe(
     adjacency: Adjacency,
     root: Vertex
@@ -117,20 +65,10 @@ object SingleRootDigraph:
       )
     else throw GraphException.RootOutOfBounds(root, adjacency.numberOfVertices)
 
-  /** Given some [[Adjacency]] and a given root [[Vertex]], instantiate a new
-    * [[SingleRootDigraph]] if the [[Vertex]] is within the graph..
-    *
-    * @param adjacency
-    *   The [[Adjacency]] which describes the graph.
-    * @param root
-    *   The root [[Vertex]].
-    * @return
-    *   New [[SingleRootDigraph]], or `None` if the given root is not valid.
-    */
   def fromAdjacency(
     adjacency: Adjacency
   ): Option[SingleRootDigraph] =
-    val roots = adjacency.roots
+    val roots = adjacency.findRoots()
     if roots.size == 1 then
       Some(
         new SingleRootDigraph(

modules/core/src/test/scala/gs/graph/v0/AdjacencyTests.scala

@@ -1,27 +0,0 @@
-package gs.graph.v0
-
-class AdjacencyTests extends munit.FunSuite:
-
-  test("should provide incoming connections") {
-    val N  = Size(7)
-    val vs = (0 until N.value).map(Vertex(_)).toArray
-    val E  = List(
-      Edge(vs(0), vs(1)),
-      Edge(vs(0), vs(2)),
-      Edge(vs(0), vs(3)),
-      Edge(vs(1), vs(4)),
-      Edge(vs(2), vs(4)),
-      Edge(vs(3), vs(4)),
-      Edge(vs(3), vs(5)),
-      Edge(vs(4), vs(6))
-    )
-    val A = Adjacency.fromDirectedEdges(N, E)
-
-    assertEquals(A.incoming(vs(0)), Vector.empty)
-    assertEquals(A.incoming(vs(1)), Vector(vs(0)))
-    assertEquals(A.incoming(vs(2)), Vector(vs(0)))
-    assertEquals(A.incoming(vs(3)), Vector(vs(0)))
-    assertEquals(A.incoming(vs(4)), Vector(vs(1), vs(2), vs(3)))
-    assertEquals(A.incoming(vs(5)), Vector(vs(3)))
-    assertEquals(A.incoming(vs(6)), Vector(vs(4)))
-  }

project/build.properties

@@ -1 +1 @@
-sbt.version=1.12.8
+sbt.version=1.11.7

project/plugins.sbt

@@ -28,6 +28,6 @@ externalResolvers := Seq(
   "Garrity Software Releases" at "https://maven.garrity.co/gs"
 )
 
-addSbtPlugin("org.scoverage" % "sbt-scoverage"        % "2.4.4")
+addSbtPlugin("org.scoverage" % "sbt-scoverage"        % "2.3.1")
-addSbtPlugin("gs"            % "sbt-garrity-software" % "0.7.0")
+addSbtPlugin("gs"            % "sbt-garrity-software" % "0.6.0")
 addSbtPlugin("gs"            % "sbt-gs-semver"        % "0.3.0")