zadt 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbc3136e504bb61d48ef017ca9fc1ccf398d2fdb
-  data.tar.gz: be82f8e8688f3074e381a293fa1aea983587c994
+  metadata.gz: f16f371f690982be0edc05ae1e5624cdcd812233
+  data.tar.gz: ce2efe26d5f47a2b670b73a679e8c5f5886fe4ff
 SHA512:
-  metadata.gz: 878cc14d73b9ac881fcc787d214c6541afc91990aa551df86692c1bd2dd2178a1288ab22806a6ca66768a3241b648b343e2104d07c397eb528a74ff5a67370dc
-  data.tar.gz: cf9047e02fa9921b30e7925c00a7700b30d4ce812c15e3d696f792f22309818b1864f63ff55f74fd933ec99a5e9f1d527770dd05b5101745a33543d7315badaa
+  metadata.gz: c118568e9464acbb25783cee710f56fb3776e1eae551363cc24430fb843c63d584ad0a99a80863940cc7db04333270b056df80a5e7feef0dc7c91346b546ff11
+  data.tar.gz: 8fe21e9f1f74b97b82711a9710bbe701523b3a64e977b7877460739642c8d45af45765b465665ec7b0aedbc14ebc97041e029094d37ebee1ee0162062cb1bb4f

data/lib/ADT_requireables.rb

@@ -1,6 +1,12 @@
 require_relative 'zadt/AbstractDataTypes/ADT.rb'
-require_relative 'zadt/AbstractDataTypes/Stack.rb'
-require_relative 'zadt/AbstractDataTypes/Queue.rb'
-require_relative 'zadt/AbstractDataTypes/StackQueue.rb'
-require_relative 'zadt/AbstractDataTypes/MinMaxStack.rb'
-require_relative 'zadt/AbstractDataTypes/MinMaxStackQueue.rb'
+require_relative 'zadt/AbstractDataTypes/MinMaxStackQueue/Stack.rb'
+require_relative 'zadt/AbstractDataTypes/MinMaxStackQueue/Queue.rb'
+require_relative 'zadt/AbstractDataTypes/MinMaxStackQueue/StackQueue.rb'
+require_relative 'zadt/AbstractDataTypes/MinMaxStackQueue/MinMaxStack.rb'
+require_relative 'zadt/AbstractDataTypes/MinMaxStackQueue/MinMaxStackQueue.rb'
+
+require_relative 'zadt/AbstractDataTypes/Graph/vertex.rb'
+require_relative 'zadt/AbstractDataTypes/Graph/edge.rb'
+require_relative 'zadt/AbstractDataTypes/Graph/graph.rb'
+require_relative 'zadt/AbstractDataTypes/Graph/face.rb'
+require_relative 'zadt/AbstractDataTypes/Graph/face_graph.rb'

data/lib/zadt/AbstractDataTypes/ADT.rb

@@ -2,12 +2,19 @@ module Zadt
   class ADT
     def self.help
       puts "Thank you for using Zagorski Advanced Data Types!"
-      puts "This package contains the following Array-like Data Types:"
+      puts "This package contains the following Data Types:"
+      puts "Array-Like Data Types"
       puts "-Stack, a LIFO array with functions push and pop"
       puts "-Queue, a FIFO array with functions enqueue and dequeue"
       puts "-StackQueue, a Queue that is Stack-based (no real difference)"
       puts "-MinMaxStack, a Stack that can return Min and Max in constant time"
       puts "-MinMaxStackQueue, a Queue that can return Min and Max in constant time"
+      puts "Graph Data Types"
+      puts "-Graph, consisting of Vertices connected by Edges"
+      puts "--Vertex, a 'spot' on the graph"
+      puts "--Edge, connects two vertices"
+      puts "-FaceGraph, a sub-class of Graph which includes Faces"
+      puts "--Face, a space surrounded by Edges.  Consists of Vertices and the Edges connecting them"
       puts ""
       puts "Each data type also has a help function.  Type Zadt::Stack::help for a list of Stack functions, and so on."
     end

data/lib/zadt/AbstractDataTypes/Graph/edge.rb

@@ -0,0 +1,29 @@
+module Zadt
+  class Edge
+    attr_accessor :connection
+    def initialize(v1, v2)
+      @connection = [v1, v2]
+    end
+    
+    def self.help
+      puts "Edge has one method:"
+      puts "#connection, which returns the vertices the edge connects"
+    end
+
+    def self.methods
+      self.help
+    end
+
+    def help
+      self.help
+    end
+
+    def methods
+      help
+    end
+
+    def inspect
+      @connection.to_s
+    end
+  end
+end

data/lib/zadt/AbstractDataTypes/Graph/face.rb

@@ -0,0 +1,84 @@
+# require_relative 'vertex.rb'
+# require_relative 'edge.rb'
+module Zadt
+  class Face
+    attr_reader :edges, :vertices, :neighboring_faces
+    def initialize(edges_array, neighboring_faces = {})
+      raise "Not enough edges" if edges_array.length < 3
+      @edges = edges_array
+      vertices = edges_array.map{ |edge| edge.connection}.inject(:+).uniq
+      @vertices = ensure_cyclic(vertices)
+      @neighboring_faces = neighboring_faces
+      @neighbor_id = @neighboring_faces.length
+    end
+
+    def self.help
+      puts "Here are the functions for Face:"
+      puts "#add_neighbor(face)"
+      puts "#remove_neighbor(neighbor)"
+    end
+
+    def self.methods
+      self.help
+    end
+
+    def help
+      self.help
+    end
+
+    def methods
+      help
+    end
+
+    def add_neighbor(face)
+      # face_info is a catalog of information about the face's neighbor
+      # It has three properties: face, which is the neighbor face itself,
+        # as well as "shared_vertices" and "shared_edges".
+      face_info = {}
+      face_info["face"] = face
+      face_info["shared_vertices"] = @vertices.select{|vertex| face.vertices.include?(vertex)}
+      face_info["shared_edges"] = @edges.select{|edge| face.edges.include?(edge)}
+      raise "No connecting edges or vertices" if face_info["shared_vertices"].empty? && face_info["shared_edges"].empty?
+      @neighboring_faces[@neighbor_id] = face_info
+      @neighbor_id += 1
+    end
+
+    def remove_neighbor(neighbor)
+      id_of_neighbor = -1
+      @neighboring_faces.each do |id, face_info|
+        id_of_neighbor = id if face_info["face"] == neighbor
+      end
+      raise "Not a neighbor" if id_of_neighbor == -1
+      @neighboring_faces.delete(id_of_neighbor)
+    end
+
+
+    def inspect
+      output = "This face contains the following vertices:"
+      output += @vertices.to_s
+      output = "This face contains the following edges:"
+      output += @edges.to_s
+      output
+    end
+
+    private
+    def ensure_cyclic(vertices)
+      connect_testers = vertices.dup
+      connected_vertices = []
+      connected_vertices << connect_testers.pop
+      until connected_vertices.length == vertices.length
+        continue = false
+        connect_testers.each do |vert|
+          if (connected_vertices.last).is_connected?(vert)
+            connected_vertices << vert
+            continue = true
+            break
+          end
+        end
+        connect_testers.delete(connected_vertices.last)
+        raise "Not cyclic edges" if continue == false
+      end
+      connected_vertices
+    end
+  end
+end

data/lib/zadt/AbstractDataTypes/Graph/face_graph.rb

@@ -0,0 +1,166 @@
+require_relative 'face.rb'
+require_relative 'graph.rb'
+
+module Zadt
+  class FaceGraph < Graph
+    attr_reader :faces
+
+    def initialize
+      #@faces is ALL faces on the graph
+      @faces = []
+      super
+    end
+
+    def self.help
+      puts "Here are the functions for FaceGraph:"
+      puts "#add_face(edges_array)"
+      puts "#make_original_face(num_edges)"
+      puts "#add_attached_face(vertex_array, num_edges)"
+      puts "#add_attached_face(vertex_array, num_edges)"
+      puts "#find_neighbors(vertex_array)"
+      puts "#make_vertex_line(vertex_array)"
+      puts "#make_neighbors(face1, face2)"
+      puts "#remove_neighbors(face1, face2)"
+      puts "FaceGraph also inherits the following functions from Graph:"
+      puts "#add_vertex"
+      puts "#remove_vertex(vertex)"
+      puts "#make_connection(v1,v2)"
+      puts "#break_connection(v1,v2)"
+      puts "#find_connection(v1,v2)"
+      puts "#is_connected?(v1,v2)"
+    end
+
+    def self.methods
+      self.help
+    end
+
+    def help
+      self.help
+    end
+
+    def methods
+      help
+    end
+
+    def add_face(edges_array)
+      face = Face.new(edges_array)
+      @faces << face
+      face
+    end
+
+    # Makes a face with num_edges edges, which will be attached to nothing.
+    def make_original_face(num_edges)
+
+      # Make the vertices
+      vert_ref = Array.new(num_edges) {Vertex.new}
+      edge_ref = []
+
+      # Connect each vertex to the one before it (including the first one :)
+      (num_edges).times do |vert_id|
+        edge_ref << make_connection(vert_ref[vert_id - 1], vert_ref[vert_id])
+      end
+
+      # Make the face and store it
+      face = add_face(edge_ref)
+      # Store the new vertices
+      @vertices += vert_ref
+      # Store the new edges
+      @edges += edge_ref
+
+      face
+    end
+
+    # This adds a face that will be attached to the given vertices
+    #   Make sure the vertices are connected, or it will raise an error
+    # All new vertices and edges will be created
+    # This will automatically make_neighbors with any faces that share
+    #   a vertex with the new face
+    def add_attached_face(vertex_array, num_edges)
+      # Make the vertices into a line
+      # p vertex_array
+      vertex_line = make_vertex_line(vertex_array)
+      # This finds the "ends" of the vertex line
+      end_vertices = [vertex_line.first, vertex_line.last]
+      # Find the neighbors that will be added later
+      new_neighbors = find_neighbors(vertex_array)
+      # How many vertices and edges to be made
+      vertices_to_make = num_edges - vertex_array.length
+      edges_to_make = vertices_to_make + 1
+
+      vert_ref = []
+      # Make new vertices
+      vert_ref = Array.new(vertices_to_make) {Vertex.new}
+
+      edge_ref = []
+      # Connect new vertices in a line
+      (edges_to_make - 2).times do |vert_id|
+        # Connect each vertex to the one after it
+        edge_ref << make_connection(vert_ref[vert_id], vert_ref[vert_id + 1])
+      end
+      # Connect "ends" of new vertices to "ends" of vertex line (making a circuit)
+        # Connect "first" of new vertices to "first end" of old ones
+        edge_ref << make_connection(vert_ref.first, end_vertices.first)
+        # Connect "last" of new vertices to "last end" of old ones
+        edge_ref << make_connection(vert_ref.last, end_vertices.last)
+
+      # Add edges from vertex_line to edge_ref
+      (vertex_line.length - 1).times do |vert_id|
+        edge_ref << find_connection(vertex_line[vert_id], vertex_line[vert_id + 1])
+      end
+
+      face_border = edge_ref
+      # Make a face out of the new circuit, and store it
+      face = add_face(face_border)
+      # Store the new vertices
+      @vertices += vert_ref
+      # Store the new edges
+      @edges += edge_ref
+
+      new_neighbors.each do |neighbor|
+        # Add all the new_neighbors
+        face.add_neighbor(neighbor)
+        # Make this a neighbor to all new_neighbors
+        neighbor.add_neighbor(face)
+      end
+      face
+    end
+
+    # Return all faces containing the given vertices
+    def find_neighbors(vertex_array)
+      neighbors = []
+      vertex_array.each do |vertex|
+        @faces.each do |face|
+          neighbors << face if face.vertices.include?(vertex)
+        end
+      end
+      neighbors.uniq
+    end
+
+    def make_vertex_line(vertex_array)
+      connection_line = []
+      connection_line << vertex_array.first
+      continue = true
+      until connection_line.length == vertex_array.length || !continue
+        continue = false
+        vertex_array.each do |vertex|
+          if vertex.is_connected?(connection_line.last) && !connection_line.include?(vertex)
+            continue = true
+            connection_line << vertex
+          end
+        end
+        raise "Vertices not connected" if continue == false
+      end
+      connection_line
+    end
+
+    def make_neighbors(face1, face2)
+      face1.add_neighbor(face2)
+      face2.add_neighbor(face1)
+    end
+
+    def remove_neighbors(face1, face2)
+      face2.remove_neighbor(face1)
+      face1.remove_neighbor(face2)
+    end
+  end
+end

data/lib/zadt/AbstractDataTypes/Graph/graph.rb

@@ -0,0 +1,98 @@
+require_relative 'vertex.rb'
+
+module Zadt
+  class Graph
+    attr_reader :vertices, :edges
+
+    #init_v allows for initial vertices (not generally used)
+    def initialize
+      #@vertices is ALL vertices on the graph
+      @vertices = []
+      #@edges is ALL edges on the graph
+      @edges = []
+    end
+
+    def self.help
+      puts "Here are the functions for Graph:"
+      puts "#add_vertex"
+      puts "#remove_vertex(vertex)"
+      puts "#make_connection(v1,v2)"
+      puts "#break_connection(v1,v2)"
+      puts "#find_connection(v1,v2)"
+      puts "#is_connected?(v1,v2)"
+    end
+
+    def self.methods
+      self.help
+    end
+
+    def help
+      self.help
+    end
+
+    def methods
+      help
+    end
+
+    # Add a vertex
+    def add_vertex
+      vertex = Vertex.new
+      @vertices << vertex
+      vertex
+    end
+
+    # Remove a vertex
+    def remove_vertex(vertex)
+      # The vertex must exist
+      if !vertex
+        raise "Vertex does not exist"
+      # The vertex must not be connected to anything
+      elsif !vertex.connections.empty?
+        raise "Vertex has edges.  Break them first."
+      # If it exists and isn't connected, delete it
+      else
+        @vertices.delete(vertex)
+      end
+    end
+
+    # Make an edge between two vertices
+    def make_connection(v1, v2)
+      raise "already connected" if is_connected?(v1, v2)
+      # Connect the two using the vertex method "connect"
+      edge = v1.connect(v2)
+      # Add to edge catalog
+      @edges << edge
+      edge
+    end
+
+    def break_connection(v1, v2)
+      raise "First vertex does not exist" if !v1
+      raise "Second vertex does not exist" if !v2
+
+      if is_connected?(v1, v2)
+        # Find edge
+        edge = find_connection(v1, v2)
+        # Remove edge from edges catalog
+        @edges.delete(edge)
+        #Remove edge from vertices
+        v1.edges.delete(edge)
+        v2.edges.delete(edge)
+        v1.connections.delete(v2)
+        v2.connections.delete(v1)
+      else
+        raise "Vertices are not connected"
+      end
+    end
+
+    # Find the edge connecting two vertices
+    def find_connection(v1, v2)
+      connection = v1.edges.select {|edge| edge.connection.include?(v2)}
+      connection.first
+    end
+
+    # Returns whether two vertices are connected
+    def is_connected?(v1, v2)
+      v1.connections.include?(v2)
+    end
+  end
+end

data/lib/zadt/AbstractDataTypes/Graph/vertex.rb

@@ -0,0 +1,66 @@
+require_relative 'edge.rb'
+module Zadt
+  class Vertex
+    attr_accessor :edges, :connections
+    def initialize
+      # List of edges attached to vertex
+      @edges = []
+      # List of vertices "connected" to this one
+      @connections = []
+    end
+
+    def self.help
+      puts "Here are the functions for Vertex:"
+      puts "#connect(other_vertex)"
+      puts "#is_connected?(other_vertex)"
+      puts "#make_connection(v1,v2)"
+      puts "#break_connection(v1,v2)"
+      puts "#find_connection(v1,v2)"
+      puts "#is_connected?(v1,v2)"
+    end
+
+    def self.methods
+      self.help
+    end
+
+    def help
+      self.help
+    end
+
+    def methods
+      help
+    end
+
+    # Make an edge between this vertex and another
+    def connect(other_vertex)
+      return nil if !other_vertex
+      raise "already connected" if is_connected?(other_vertex)
+
+      edge = Edge.new(self, other_vertex)
+      # Store connection info in this vertex
+      @edges << edge
+      @connections << other_vertex
+      # Store connection info in other vertex
+      other_vertex.store_connection_info(self, edge)
+      edge
+    end
+
+    # Returns if another vertex is "connected" to this one
+    def is_connected?(other_vertex)
+      @connections.include?(other_vertex)
+    end
+
+    def inspect
+      "Vertex"
+    end
+
+    # Used to store connection info in the second vertex
+    #  involved in a connection
+    # Must needs be public, since it's called by a different vertex
+    def store_connection_info(vertex, edge)
+      @edges << edge
+      @connections << vertex
+    end
+
+  end
+end

data/lib/zadt/AbstractDataTypes/{MinMaxStack.rb → MinMaxStackQueue/MinMaxStack.rb}

@@ -9,14 +9,14 @@ module Zadt
 
     def self.help
       puts "Here are the functions for MinMaxStack:"
-      puts "push(value)"
-      puts "pop"
-      puts "peek"
-      puts "min"
-      puts "max"
-      puts "length"
-      puts "show"
-      puts "empty?"
+      puts "#push(value)"
+      puts "#pop"
+      puts "#peek"
+      puts "#min"
+      puts "#max"
+      puts "#length"
+      puts "#show"
+      puts "#empty?"
     end
 
     def self.methods
@@ -24,7 +24,7 @@ module Zadt
     end
 
     def help
-      MinMaxStack.help
+      self.help
     end
 
     def methods

data/lib/zadt/AbstractDataTypes/{MinMaxStackQueue.rb → MinMaxStackQueue/MinMaxStackQueue.rb}

@@ -12,13 +12,13 @@ module Zadt
 
     def self.help
       puts "Here are the functions for MinMaxStackQueue:"
-      puts "show"
-      puts "enqueue(value)"
-      puts "dequeue"
-      puts "min"
-      puts "max"
-      puts "length"
-      puts "empty?"
+      puts "#show"
+      puts "#enqueue(value)"
+      puts "#dequeue"
+      puts "#min"
+      puts "#max"
+      puts "#length"
+      puts "#empty?"
     end
 
     def self.methods

data/lib/zadt/AbstractDataTypes/{Queue.rb → MinMaxStackQueue/Queue.rb}

@@ -6,11 +6,11 @@ module Zadt
 
     def self.help
       puts "Here are the functions for Queue:"
-      puts "show"
-      puts "enqueue(value)"
-      puts "dequeue"
-      puts "length"
-      puts "empty?"
+      puts "#show"
+      puts "#enqueue(value)"
+      puts "#dequeue"
+      puts "#length"
+      puts "#empty?"
     end
 
     def self.methods

data/lib/zadt/AbstractDataTypes/{Stack.rb → MinMaxStackQueue/Stack.rb}

@@ -6,11 +6,11 @@ module Zadt
 
     def self.help
       puts "Here are the functions for Stack:"
-      puts "show"
-      puts "push(value)"
-      puts "pop"
-      puts "length"
-      puts "empty?"
+      puts "#show"
+      puts "#push(value)"
+      puts "#pop"
+      puts "#length"
+      puts "#empty?"
     end
 
     def self.methods

data/lib/zadt/AbstractDataTypes/{StackQueue.rb → MinMaxStackQueue/StackQueue.rb}

@@ -11,11 +11,11 @@ module Zadt
 
     def self.help
       puts "Here are the functions for StackQueue:"
-      puts "show"
-      puts "enqueue(value)"
-      puts "dequeue"
-      puts "length"
-      puts "empty?"
+      puts "#show"
+      puts "#enqueue(value)"
+      puts "#dequeue"
+      puts "#length"
+      puts "#empty?"
     end
 
     def self.methods

data/lib/zadt/version.rb

@@ -1,3 +1,3 @@
 module Zadt
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zadt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Benjamin Zagorski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,13 +73,19 @@ files:
 - bin/console
 - bin/setup
 - lib/ADT_requireables.rb
+- lib/helper_functions.rb
 - lib/zadt.rb
 - lib/zadt/AbstractDataTypes/ADT.rb
-- lib/zadt/AbstractDataTypes/MinMaxStack.rb
-- lib/zadt/AbstractDataTypes/MinMaxStackQueue.rb
-- lib/zadt/AbstractDataTypes/Queue.rb
-- lib/zadt/AbstractDataTypes/Stack.rb
-- lib/zadt/AbstractDataTypes/StackQueue.rb
+- lib/zadt/AbstractDataTypes/Graph/edge.rb
+- lib/zadt/AbstractDataTypes/Graph/face.rb
+- lib/zadt/AbstractDataTypes/Graph/face_graph.rb
+- lib/zadt/AbstractDataTypes/Graph/graph.rb
+- lib/zadt/AbstractDataTypes/Graph/vertex.rb
+- lib/zadt/AbstractDataTypes/MinMaxStackQueue/MinMaxStack.rb
+- lib/zadt/AbstractDataTypes/MinMaxStackQueue/MinMaxStackQueue.rb
+- lib/zadt/AbstractDataTypes/MinMaxStackQueue/Queue.rb
+- lib/zadt/AbstractDataTypes/MinMaxStackQueue/Stack.rb
+- lib/zadt/AbstractDataTypes/MinMaxStackQueue/StackQueue.rb
 - lib/zadt/version.rb
 - zadt.gemspec
 homepage: https://github.com/MrMicrowaveOven/zadt.git