rgl 0.5.10 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc32ab84139b87296c8e71d490843c6d90c83257e7876f42f25b23d0ae852cd8
-  data.tar.gz: 44177136283480e8ba77c431343d7a6361d3ac79e58b1d5864d8a74556ca4bd6
+  metadata.gz: fe8f8fb223d89b38255ea2b695204a5fc6f686773c5f127945929d75013ac2bb
+  data.tar.gz: 8df8df91c990d1c9bf564069681f9ee1176636ff9507f470db5260032af768b1
 SHA512:
-  metadata.gz: 51c96d180f5d570bfcaeaf5653749bf432fbcb3a82e75336f7883c0e45bc48de0d20e2ce6b26238fc9678bc0449e8564d7c1902f1dbd7101f6680d4481847850
-  data.tar.gz: eb9dcbd3b6ee1d870c2a2afeaab045bc29107ef5b9fc1b9fa2dc356ca5961a87c0bcf8d7d32dca2fb5add0e466598bc167128a4fbebc6f4428970439adfcd02d
+  metadata.gz: 7f4caa6a12dc76b702c4f7d0219614d2617861fd331614446731bf2270fa71dd768d2f78d44b1a786c9fb5f9934ec61f1030b77ec16a2922c92f4051b5c9403f
+  data.tar.gz: 4343592e3a7bd1bbdfd45ab839a16b38f3dec3d336a0febc1f44876c889b058db052e3dff85323a5f4a10a87293e7ca4f9f05d6b5735a23ce75048c418dff3f8

data/README.md

@@ -1,4 +1,8 @@
-# Ruby Graph Library (RGL)[![Test](https://github.com/monora/rgl/actions/workflows/test.yml/badge.svg)](https://github.com/monora/rgl/actions/workflows/test.yml) [![Doc](https://github.com/monora/rgl/actions/workflows/doc.yml/badge.svg)](https://github.com/monora/rgl/actions/workflows/doc.yml) [<img src="https://codeclimate.com/github/monora/rgl/badges/coverage.svg" />](https://codeclimate.com/github/monora/rgl/coverage) [<img src="https://badge.fury.io/rb/rgl.svg" alt="Version"/>](https://badge.fury.io/rb/rgl) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/monora/rgl)
+# Ruby Graph Library (RGL)
+[![Test](https://github.com/monora/rgl/actions/workflows/test.yml/badge.svg)](https://github.com/monora/rgl/actions/workflows/test.yml) [![Doc](https://github.com/monora/rgl/actions/workflows/doc.yml/badge.svg)](https://github.com/monora/rgl/actions/workflows/doc.yml)
+[![Version](https://badge.fury.io/rb/rgl.svg)](https://badge.fury.io/rb/rgl)
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/monora/rgl)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/monora/rgl)](https://codeclimate.com/github/monora/rgl)
 
 RGL is a framework for graph data structures and algorithms.
 

data/lib/rgl/adjacency.rb

@@ -161,6 +161,7 @@ module RGL
 
   end # class AdjacencyGraph
 
+
   module Graph
 
     # Convert a general graph to an AdjacencyGraph. If the graph is directed,

data/lib/rgl/base.rb

@@ -1,7 +1,7 @@
 # base.rb
 
 # version information
-RGL_VERSION = "0.5.10"
+RGL_VERSION = "0.6.0"
 
 # Module {RGL} defines the namespace for all modules and classes of the graph
 # library. The main module is {Graph} which defines the abstract behavior of
@@ -192,6 +192,15 @@ module RGL
       include?(v) # inherited from enumerable
     end
 
+    # Returns true if +(u, v)+ is an edge of the graph.
+    # @param (see #each_edge)
+    def has_edge?(u, v)
+      each_adjacent(u) do |w|
+        return true if v == w
+      end
+      return false
+    end
+
     # Returns true if the graph has no vertices, i.e. num_vertices == 0.
     #
     def empty?

data/lib/rgl/bellman_ford.rb

@@ -27,6 +27,7 @@ module RGL
 
   end
 
+  # This class implements {Graph#bellman_ford_shortest_paths}.
   class BellmanFordAlgorithm
 
     # Initializes Bellman-Ford algorithm for a _graph_ with provided edges weights map.
@@ -89,6 +90,7 @@ module RGL
 
   end # class BellmanFordAlgorithm
 
+
   module Graph
 
     # Finds the shortest paths from the _source_ to each vertex of the graph.

data/lib/rgl/bidirectional.rb

@@ -26,6 +26,20 @@ module RGL
       yield u
     end
 
+    alias :each_out_neighbor :each_adjacent
+
+    def has_in_edge?(u, v)
+      raise NotImplementedError
+    end
+
+    alias :has_out_edge? :has_edge?
+
+    def in_neighbors(v)
+      raise NotImplementedError
+    end
+
+    alias :out_neighbors :adjacent_vertices
+
     # Returns the number of in-edges (for directed graphs) or the number of
     # incident edges (for undirected graphs) of vertex _v_.
     # @return [int]

data/lib/rgl/bidirectional_adjacency.rb

@@ -0,0 +1,74 @@
+# bidirectional_adjacency.rb
+#
+require 'rgl/adjacency'
+require 'rgl/bidirectional'
+
+module RGL
+
+  # This implementation of {BidirectionalGraph} creates an internal
+  # {DirectedAdjacencyGraph} to store the in-edges and overrides methods
+  # to ensure that the out and in graphs remain synchronized.
+  #
+  class BidirectionalAdjacencyGraph < DirectedAdjacencyGraph
+
+    include BidirectionalGraph
+
+    # @see DirectedAdjacencyGraph#initialize
+    #
+    # In super method the in edges are also added since {add_edge} of this class
+    # also inserts edges in `@reverse`.
+    def initialize(edgelist_class = Set, *other_graphs)
+      @reverse = DirectedAdjacencyGraph.new(edgelist_class)
+      super(edgelist_class, *other_graphs)
+    end
+
+    # We don't need to override add_vertex() because the reverse graph doesn't need to
+    # contain any unconnected vertices. Vertices will be added by add_edge() as
+    # required.
+
+    # @see MutableGraph#add_edge.
+    def add_edge(u, v)
+      super(u, v)
+      @reverse.add_edge(v, u)
+    end
+
+    # @see MutableGraph#remove_vertex.
+    def remove_vertex(v)
+      super(v)
+      @reverse.remove_vertex(v)
+    end
+
+    # @see MutableGraph::remove_edge.
+    def remove_edge(u, v)
+      super(u, v)
+      @reverse.remove_edge(v, u)
+    end
+
+    # @see Graph#has_edge?
+    def has_in_edge?(u, v)
+      @reverse.has_edge?(u, v)
+    end
+
+    alias :has_out_edge? :has_edge?
+
+    # @see BidirectionalGraph#each_in_neighbor
+    def each_in_neighbor(v)
+      @reverse.each_adjacent(v)
+    end
+
+    alias :each_out_neighbor :each_adjacent
+
+    def in_neighbors(v)
+      @reverse.adjacent_vertices(v)
+    end
+
+    # Returns the number of in-edges (for directed graphs) or the number of
+    # incident edges (for undirected graphs) of vertex _v_.
+    # @return [int]
+    def in_degree(v)
+      @reverse.out_degree(v)
+    end
+
+  end
+
+end

data/lib/rgl/bipartite.rb

@@ -41,6 +41,7 @@ module RGL
 
   end # module Graph
 
+
   class BipartiteBFSIterator < BFSIterator
 
     attr_reader :bipartite_sets_map, :found_odd_cycle

data/lib/rgl/dijkstra.rb

@@ -6,6 +6,7 @@ require 'pairing_heap'
 
 module RGL
 
+  # This class implements {Graph#dijkstra_shortest_path} and {Graph#dijkstra_shortest_paths}
   class DijkstraAlgorithm
 
     # Distance combinator is a lambda that accepts the distance (usually from the source) to vertex _u_ and the weight
@@ -103,6 +104,7 @@ module RGL
 
   end # class DijkstraAlgorithm
 
+
   module Graph
 
     # Finds the shortest path from the _source_ to the _target_ in the graph.

data/lib/rgl/edge_properties_map.rb

@@ -37,6 +37,7 @@ module RGL
 
   end # EdgePropertiesMap
 
+
   class NonNegativeEdgePropertiesMap < EdgePropertiesMap
 
     private
@@ -52,4 +53,4 @@ module RGL
 
   end
 
-end
+end

data/lib/rgl/edmonds_karp.rb

@@ -116,6 +116,7 @@ module RGL
 
   end # class EdmondsKarpAlgorithm
 
+
   module Graph
 
     # Finds the maximum flow from the _source_ to the _sink_ in the graph.

data/lib/rgl/implicit.rb

@@ -97,6 +97,7 @@ module RGL
 
   end # class ImplicitGraph
 
+
   module Graph
 
     # Returns a new {ImplicitGraph} which has as vertices all vertices of the

data/lib/rgl/path_builder.rb

@@ -1,6 +1,6 @@
 module RGL
 
-    class PathBuilder
+  class PathBuilder
 
     def initialize(source, parents_map)
       @source      = source

data/lib/rgl/prim.rb

@@ -34,6 +34,7 @@ module RGL
 
   end # class PrimAlgorithm
 
+
   module Graph
 
     # Finds the minimum spanning tree of the graph.

data/lib/rgl/topsort.rb

@@ -8,10 +8,10 @@ module RGL
   #
   # The topological sort algorithm creates a linear ordering of the vertices
   # such that if edge (u,v) appears in the graph, then u comes before v in
-  # the ordering. The graph must be a directed acyclic graph (DAG).
+  # the ordering. The graph must be a directed acyclic graph.
   #
   # The iterator can also be applied to an undirected graph or to a directed graph
-  # which contains a cycle. In this case, the Iterator does not reach all
+  # which contains a cycle. In this case, the iterator does not reach all
   # vertices. The implementation of {Graph#acyclic?} uses this fact.
   #
   # @see Graph#topsort_iterator
@@ -60,6 +60,7 @@ module RGL
 
   end # class TopsortIterator
 
+
   module Graph
 
     # @return [TopsortIterator] for the graph.

data/lib/rgl/traversal.rb

@@ -104,6 +104,7 @@ module RGL
 
   end # class BFSIterator
 
+
   module Graph
 
     # @return [BFSIterator] starting at vertex _v_.
@@ -161,6 +162,7 @@ module RGL
 
   end # class DFSVisitor
 
+
   module Graph
 
     # @return [DFSIterator] staring at vertex _v_.

data/test/bidirectional_graph_test.rb

@@ -0,0 +1,169 @@
+require 'test_helper'
+
+require 'rgl/bidirectional_adjacency'
+require 'directed_graph_test'
+
+include RGL
+include RGL::Edge
+
+class TestBidirectionalAdjacencyGraph < Test::Unit::TestCase
+  def setup
+    @edges = [[1, 2], [1, 3], [2, 3], [2, 4], [2, 5], [2, 6], [3, 2], [3, 7], [3, 8],
+             [5, 10], [6, 9], [7, 9], [7, 10], [8, 10]]
+    @out_neighbors = Hash.new { |h, k| h[k] = Set.new }
+    @in_neighbors = Hash.new { |h, k| h[k] = Set.new }
+    @edges.each do |e|
+      @out_neighbors[e[0]] << e[1]
+      @in_neighbors[e[1]] << e[0]
+    end
+    @dg = BidirectionalAdjacencyGraph.new
+    @edges.each do |(src, target)|
+      @dg.add_edge(src, target)
+    end
+    @eg = BidirectionalAdjacencyGraph.new
+    @gfa = BidirectionalAdjacencyGraph[1, 2, 3, 4]
+  end
+
+  def test_empty_graph
+    assert @eg.empty?
+    assert @eg.directed?
+    assert(!@eg.has_edge?(2, 1))
+    assert(!@eg.has_out_edge?(2, 1))
+    assert(!@eg.has_in_edge?(1, 2))
+    assert(!@eg.has_vertex?(3))
+    # Non existent vertex result in a Name Error because each_key is
+    # called for nil
+    assert_raises(NoVertexError) { @eg.out_degree(3) }
+    assert_raises(NoVertexError) { @eg.in_degree(3) }
+    assert_equal([], @eg.vertices)
+    assert_equal(0, @eg.size)
+    assert_equal(0, @eg.num_vertices)
+    assert_equal(0, @eg.num_edges)
+    assert_equal(DirectedEdge, @eg.edge_class)
+    assert_empty(@eg.edges)
+  end
+
+  def test_add
+    @eg.add_edge(1, 2)
+    assert(!@eg.empty?)
+    assert(@eg.has_edge?(1, 2))
+    assert(@eg.has_out_edge?(1, 2))
+    assert(@eg.has_in_edge?(2, 1))
+    assert(!@eg.has_edge?(2, 1))
+    assert(!@eg.has_out_edge?(2, 1))
+    assert(!@eg.has_in_edge?(1, 2))
+    assert(@eg.has_vertex?(1) && @eg.has_vertex?(2))
+    assert(!@eg.has_vertex?(3))
+
+    assert_equal([1, 2], @eg.vertices.sort)
+    assert([DirectedEdge.new(1, 2)].eql?(@eg.edges))
+    assert_equal("(1-2)", @eg.edges.join)
+
+    assert_equal([2], @eg.adjacent_vertices(1))
+    assert_equal([2], @eg.out_neighbors(1))
+    assert_equal([], @eg.in_neighbors(1))
+    assert_equal([], @eg.adjacent_vertices(2))
+    assert_equal([], @eg.out_neighbors(2))
+    assert_equal([1], @eg.in_neighbors(2))
+
+    assert_equal(1, @eg.out_degree(1))
+    assert_equal(0, @eg.in_degree(1))
+    assert_equal(0, @eg.out_degree(2))
+    assert_equal(1, @eg.in_degree(2))
+  end
+
+  def test_edges
+    assert_equal(14, @dg.edges.length)
+    assert_equal(@edges.map { |e| e[0] }.to_set, @dg.edges.map { |l| l.source }.to_set)
+    assert_equal(@edges.map { |e| e[1] }.to_set, @dg.edges.map { |l| l.target }.to_set)
+    assert_equal("(1-2)(1-3)(2-3)(2-4)(2-5)(2-6)(3-2)(3-7)(3-8)(5-10)(6-9)(7-10)(7-9)(8-10)", @dg.edges.map { |l| l.to_s }.sort.join)
+  end
+
+  def test_vertices
+    assert_equal(@edges.flatten.to_set, @dg.vertices.to_set)
+  end
+
+  def test_edges_from_to?
+    @edges.each do |u, v|
+      assert @dg.has_edge?(u, v)
+      assert @dg.has_out_edge?(u, v)
+      assert @dg.has_in_edge?(v, u)
+    end
+  end
+
+  def test_remove_edges
+    @dg.remove_edge 1, 2
+    assert !@dg.has_edge?(1, 2)
+    assert !@dg.has_out_edge?(1, 2)
+    assert !@dg.has_in_edge?(2, 1)
+    @dg.remove_edge 1, 2
+    assert !@dg.has_edge?(1, 2)
+    assert !@dg.has_out_edge?(1, 2)
+    assert !@dg.has_in_edge?(2, 1)
+    @dg.remove_vertex 3
+    assert !@dg.has_vertex?(3)
+    assert !@dg.has_edge?(2, 3)
+    assert !@dg.has_out_edge?(2, 3)
+    assert !@dg.has_in_edge?(3, 2)
+    assert_equal('(2-4)(2-5)(2-6)(5-10)(6-9)(7-9)(7-10)(8-10)', @dg.edges.join)
+  end
+
+  def test_add_vertices
+    @eg.add_vertices 1, 3, 2, 4
+    assert_equal @eg.vertices.sort, [1, 2, 3, 4]
+
+    @eg.remove_vertices 1, 3
+    assert_equal @eg.vertices.sort, [2, 4]
+  end
+
+  def test_creating_from_array
+    assert_equal([1, 2, 3, 4], @gfa.vertices.sort)
+    assert_equal('(1-2)(3-4)', @gfa.edges.join)
+  end
+
+  def test_creating_from_graphs
+    dg2 = BidirectionalAdjacencyGraph.new(Set, @dg, @gfa)
+    assert_equal(dg2.vertices.to_set, (@dg.vertices + @gfa.vertices).to_set)
+    assert_equal(dg2.edges.to_set, (@dg.edges + @gfa.edges).to_set)
+  end
+
+  def test_reverse
+    # Add isolated vertex
+    @dg.add_vertex(42)
+    reverted = @dg.reverse
+
+    @dg.each_edge do |u, v|
+      assert(reverted.has_edge?(v, u))
+    end
+
+    assert(reverted.has_vertex?(42), 'Reverted graph should contain isolated Vertex 42')
+  end
+
+  def test_to_undirected
+    undirected = @dg.to_undirected
+    assert_equal '(1=2)(1=3)(2=3)(2=4)(2=5)(2=6)(3=7)(3=8)(5=10)(6=9)(7=9)(7=10)(8=10)', undirected.edges.sort.join
+  end
+
+  def test_neighbors
+    @edges.flatten.to_set.each do |v|
+      assert_equal @out_neighbors[v], @dg.out_neighbors(v).to_set
+      assert_equal @in_neighbors[v], @dg.in_neighbors(v).to_set
+    end
+  end
+
+  def test_each_neighbor
+    @edges.flatten.to_set.each do |v|
+      assert_equal @out_neighbors[v], @dg.each_out_neighbor(v).inject(Set.new) { |s, v| s << v }
+      assert_equal @in_neighbors[v], @dg.each_in_neighbor(v).inject(Set.new) { |s, v| s << v }
+    end
+  end
+
+  def test_degrees
+    @edges.flatten.to_set.each do |v|
+      assert_equal @out_neighbors[v].size, @dg.out_degree(v)
+      assert_equal @in_neighbors[v].size, @dg.in_degree(v)
+      assert_equal @out_neighbors[v].size + @in_neighbors[v].size, @dg.degree(v)
+    end
+  end
+
+end

data/test/directed_graph_test.rb

@@ -11,6 +11,7 @@ class TestDirectedGraph < Test::Unit::TestCase
     [[1, 2], [2, 3], [3, 2], [2, 4]].each do |(src, target)|
       @dg.add_edge(src, target)
     end
+    @gfa = DirectedAdjacencyGraph[1, 2, 3, 4]
   end
 
   def test_empty_graph
@@ -86,17 +87,23 @@ class TestDirectedGraph < Test::Unit::TestCase
 
   def test_add_vertices
     dg = DirectedAdjacencyGraph.new
-    dg.add_vertices 1, 3, 2, 4
-    assert_equal dg.vertices.sort, [1, 2, 3, 4]
+    dg.add_vertices(1, 3, 2, 4)
+    assert_equal(dg.vertices.sort, [1, 2, 3, 4])
 
-    dg.remove_vertices 1, 3
-    assert_equal dg.vertices.sort, [2, 4]
+    dg.remove_vertices(1, 3)
+    assert_equal(dg.vertices.sort, [2, 4])
   end
 
   def test_creating_from_array
-    dg = DirectedAdjacencyGraph[1, 2, 3, 4]
-    assert_equal([1, 2, 3, 4], dg.vertices.sort)
-    assert_equal('(1-2)(3-4)', dg.edges.join)
+    assert_equal([1, 2, 3, 4], @gfa.vertices.sort)
+    assert_equal('(1-2)(3-4)', @gfa.edges.join)
+  end
+
+  def test_creating_from_graphs
+    @gfa.each_edge { |e| @dg.add_edge(e[0], e[1])}
+    dg = DirectedAdjacencyGraph.new(Set, @dg, @gfa)
+    assert_equal(dg.vertices.to_set, (@dg.vertices + @gfa.vertices).to_set)
+    assert_equal(dg.edges.to_set, (@dg.edges + @gfa.edges).to_set)
   end
 
   def test_reverse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rgl
 version: !ruby/object:Gem::Version
-  version: 0.5.10
+  version: 0.6.0
 platform: ruby
 authors:
 - Horst Duchene
@@ -9,7 +9,7 @@ authors:
 autorequire: rgl/base
 bindir: bin
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stream
@@ -191,6 +191,7 @@ files:
 - lib/rgl/base.rb
 - lib/rgl/bellman_ford.rb
 - lib/rgl/bidirectional.rb
+- lib/rgl/bidirectional_adjacency.rb
 - lib/rgl/bipartite.rb
 - lib/rgl/condensation.rb
 - lib/rgl/connected_components.rb
@@ -215,6 +216,7 @@ files:
 - lib/rgl/traversal.rb
 - rakelib/dep_graph.rake
 - test/bellman_ford_test.rb
+- test/bidirectional_graph_test.rb
 - test/bipartite_test.rb
 - test/components_test.rb
 - test/cycles_test.rb