zadt 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5c19deae423e0c9c58bd1a0ca3426f9f5c35247
-  data.tar.gz: 90eccd3bfea079e453115d2f37adc811050281f6
+  metadata.gz: 14d5d23662aa56e1c863e096a68657364b276574
+  data.tar.gz: 10f4b9da70a96defbe4c75c2c4920b09a3dab714
 SHA512:
-  metadata.gz: 06af58c05476e6e9b876aa73db9d966ec36dd28a417aff76f5dede74648627eed9a28afae75de7f874aad8efa7ac592cf821959bf35e407dfeb6ba8e4af08160
-  data.tar.gz: 3a3ec25e47c7c5c5c031ff03d5275b5959450fedee8176e6ea99be9b87fa2bcb91f9174078d3b0cd9401fd80ccbd55dd9fd8fdb610be4ad9110432d71e68d3e9
+  metadata.gz: 40eb3b8f4ab8ae3fa098838ba4416ef035c1f1bedd8bd5fa7aefb77f7fccc5dbe4d4853446c9f9a2569e8624cd361944f07f0b8c721dad03385d88d1646358f6
+  data.tar.gz: cf59f864501efdc60b3388e337afddfcf4cc0bb0abac48127871715785590cbd81591899cb807b80b8f0571da69ad9df4b6e06c5cab9366f3cdd14451d418788

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 
 Zadt::ADT::help will return a list of objects in the collection, as well as a brief description of each type.
 
-I also made a "help" function for each Data Type.  Type Zadt::StackQueue.help get a list of functions for the StackQueue, and so on.
+I also made a "help" function for each Data Type.  Type Zadt::StackQueue.help get a list of methods for the StackQueue, and so on.
 
 And don't forget to require 'zadt' at the top!
 
@@ -32,11 +32,33 @@ A MinMaxStackQueue is an Queue object that allows the minimum and maximum values
 
 Since it is made out of Queues and Stacks, those data types are also available.  I also provided StackQueue (functionally the same as a Queue), and a MinMaxStack, which is a Stack version of MinMaxStackQueue.
 
-### Graph
+### Graphs
 
 A Graph is a data type that consists of Vertices, which are connected by Edges.  In addition, a FaceGraph is a Graph which also consists of Faces: the space defined inside a set of cyclic edges.
 
-I'm still working on the exact functionality of FaceGraph, since I mainly built it to use for a different project, but it should still prove useful for certain situations.  If you have any suggestions of useful bits to add, feel free to contact me below!
+I'm still working on the exact functionality of FaceGraph, since I mainly built it to use for a different project, but it should still prove useful for certain situations.  If you have any suggestions of useful bits to add, feel free to contact me!
+
+Below are the specifics of such data types.
+
+#### Graph
+
+A Graph has the following methods
+* add_vertex, adds a vertex to your graph
+* remove_vertex(vertex), removes the given vertex from the graph (vertex must not be connected)
+* make_connection(v1,v2), adds an edge between two vertices
+* break_connection(v1,v2), removes an edge between two vertices
+* find_connection(v1,v2), returns edge connecting two given vertices
+* is_connected?(v1,v2), returns true if the two vertices are connected with an edge, false otherwise
+
+#### FaceGraph
+
+A FaceGraph has the following methods, in addition to its inheritance from Graph
+* add_face(edges_array), makes a face with the given edges (must be cyclicly connected)
+* make_original_face(num_edges), which makes a standard disconnected face
+* add_attached_face(vertex_array, num_edges), which adds a face connected to the vertex_array
+* find_neighbors(vertex_array), lists all faces containing the given vertices
+* find_face_neighbors(face), which finds all neighbors of the given face.  A neighbor of a face is defined as one that shares a vertex (not necessarily an edge)
+* make_vertex_line(vertex_array), reorders a list of connected vertices by connection sequence
 
 ## Development
 

data/lib/zadt/AbstractDataTypes/ADT.rb

@@ -16,7 +16,7 @@ module Zadt
       puts "-FaceGraph, a sub-class of Graph which includes Faces"
       puts "--Face, a space surrounded by a cycle of Edges.  Consists of Vertices and the Edges connecting them"
       puts ""
-      puts "Each data type also has a help function.  Type Zadt::Stack::help or Zadt::Stack::methods for a list of Stack methods, and so on for each data type."
+      puts "Each data type also has a help function.  Type Zadt::Stack::help for a list of Stack methods, and so on for each data type."
     end
   end
 end

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

@@ -1,4 +1,3 @@
-module Zadt
   class Edge
     # Made up of a
     attr_reader :connection
@@ -9,29 +8,8 @@ module Zadt
       @value = value
     end
 
-    def self.methods
-      self.help
-    end
-
-
     def inspect
       @connection.to_s
     end
 
-    def help
-      self.help
-    end
-
-    def methods
-      help
-    end
-
-    def self.help
-      puts "Edge has one method:"
-      puts "#connection, which returns the vertices the edge connects"
-    end
-
-    private
-
   end
-end

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

@@ -1,6 +1,5 @@
 # require_relative 'vertex.rb'
 # require_relative 'edge.rb'
-module Zadt
   class Face
     attr_reader :edges, :vertices, :neighboring_faces
     # Contains
@@ -16,24 +15,6 @@ module Zadt
     end
 
     # TODO: Neighbors shouldn't be stored in Face, as FaceGraph takes care of this
-    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
@@ -86,4 +67,3 @@ module Zadt
       connected_vertices
     end
   end
-end

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

@@ -16,10 +16,15 @@ module Zadt
       super
     end
 
-    def self.methods
-      self.help
+    def self.help
+      FaceGraph.show_help_message
+    end
+
+    def help
+      FaceGraph.help
     end
 
+
     def add_face(edges_array)
       face = Face.new(edges_array)
       @faces << face
@@ -120,34 +125,6 @@ module Zadt
       neighbors - [face]
     end
 
-    def help
-      FaceGraph.help
-    end
-
-    def methods
-      help
-    end
-
-
-
-    def self.help
-      puts "Here are the functions for FaceGraph:"
-      puts "#add_face(edges_array), makes a face with the given edges (must be cyclicly connected)"
-      puts "#make_original_face(num_edges), which makes a standard disconnected face"
-      puts "#add_attached_face(vertex_array, num_edges), which adds a face connected to the vertex_array"
-      puts "#find_neighbors(vertex_array), lists all faces containing the given vertices"
-      puts "#find_face_neighbors(vertex_array), which finds all neighbors of the given face"
-      puts "--a neighbor of a face is defined as one that shares a vertex (not necessarily an edge)"
-      puts "#make_vertex_line(vertex_array), reorders a list of connected vertices by connection sequence"
-      puts ""
-      puts "FaceGraph also inherits the following functions from Graph:"
-      puts "#add_vertex"
-      puts "#remove_vertex(vertex)"
-      puts "#make_connection(v1,v2), adds an edge between two vertices"
-      puts "#break_connection(v1,v2)"
-      puts "#find_connection(v1,v2), returns edge connecting two given vertices"
-      puts "#is_connected?(v1,v2)"
-    end
 
   private
 
@@ -177,5 +154,24 @@ module Zadt
       face2.remove_neighbor(face1)
       face1.remove_neighbor(face2)
     end
+
+    def self.show_help_message
+      puts "Here are the methods for FaceGraph:"
+      puts "#add_face(edges_array), makes a face with the given edges (must be cyclicly connected)"
+      puts "#make_original_face(num_edges), which makes a standard disconnected face"
+      puts "#add_attached_face(vertex_array, num_edges), which adds a face connected to the vertex_array"
+      puts "#find_neighbors(vertex_array), lists all faces containing the given vertices"
+      puts "#find_face_neighbors(face), which finds all neighbors of the given face"
+      puts "--a neighbor of a face is defined as one that shares a vertex (not necessarily an edge)"
+      puts "#make_vertex_line(vertex_array), reorders a list of connected vertices by connection sequence"
+      puts ""
+      puts "FaceGraph also inherits the following functions from Graph:"
+      puts "#add_vertex"
+      puts "#remove_vertex(vertex)"
+      puts "#make_connection(v1,v2), adds an edge between two vertices"
+      puts "#break_connection(v1,v2)"
+      puts "#find_connection(v1,v2), returns edge connecting two given vertices"
+      puts "#is_connected?(v1,v2)"
+    end
   end
 end

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

@@ -20,8 +20,12 @@ module Zadt
       @value = Hash.new
     end
 
-    def self.methods
-      self.help
+    def help
+      Graph.help
+    end
+
+    def self.help
+      Graph.show_help_message
     end
 
     # Add a vertex
@@ -48,9 +52,12 @@ module Zadt
     # Make an edge between two vertices
     def make_connection(v1, v2)
       raise "already connected" if is_connected?(v1, v2)
+      # Make new edge
+      edge = Edge.new(v1, v2)
       # Connect the two using the vertex method "connect"
+      v1.connect(v2, edge)
+      v2.connect(v1, edge)
 
-      edge = v1.connect(v2)
       # Add to edge catalog
       @edges << edge
       edge
@@ -86,16 +93,10 @@ module Zadt
       end
     end
 
-    def help
-      Graph.help
-    end
+    private
 
-    def methods
-      help
-    end
-
-    def self.help
-      puts "Here are the functions for Graph:"
+    def self.show_help_message
+      puts "Here are the methods for Graph:"
       puts "#add_vertex"
       puts "#remove_vertex(vertex)"
       puts "#make_connection(v1,v2), adds an edge between two vertices"

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

@@ -1,4 +1,4 @@
-module Zadt
+
   class Vertex
     # Connected by
     attr_accessor :edges
@@ -17,21 +17,13 @@ module Zadt
       @value = value
     end
 
-    def self.methods
-      self.help
-    end
-
     # Make an edge between this vertex and another
-    def connect(other_vertex)
+    def connect(other_vertex, edge)
       return nil if !other_vertex.is_a?(Vertex) || other_vertex == self
       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
 
@@ -45,31 +37,4 @@ module Zadt
       description += ": empty" if @value.empty?
     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
-
-    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 help
-      Vertex.methods
-    end
-
-    def methods
-      help
-    end
-    private
   end
-end

data/lib/zadt/version.rb

@@ -1,3 +1,3 @@
 module Zadt
-  VERSION = "0.1.7"
+  VERSION = "0.1.8"
 end

data/zadt.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Zagorski ADT is a collection of advanced data types that are not included in the standard Ruby library.}
   spec.description   = %q{Includes two different categories of Advanced Data Types: Array-Based, and Graphs.
     Array-Based Data Types include Stack, Queue, StackQueue, MinMaxStack, and MinMaxStackQueue.
-    Graph Data Types include Graph, Vertex, Edge, FaceGraph, and Face.
+    Graph Data Types include Graph, which consists of Vertices and Edges, and FaceGraph, which includes Faces.
     Once installed, type "Zadt::ADT::help" for a list of datatypes
     and basic functionality.}
   spec.homepage      = "https://github.com/MrMicrowaveOven/zadt.git"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zadt
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Benjamin Zagorski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,7 +55,7 @@ dependencies:
 description: |-
   Includes two different categories of Advanced Data Types: Array-Based, and Graphs.
       Array-Based Data Types include Stack, Queue, StackQueue, MinMaxStack, and MinMaxStackQueue.
-      Graph Data Types include Graph, Vertex, Edge, FaceGraph, and Face.
+      Graph Data Types include Graph, which consists of Vertices and Edges, and FaceGraph, which includes Faces.
       Once installed, type "Zadt::ADT::help" for a list of datatypes
       and basic functionality.
 email: