zadt 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ada672cf055b26e5255eabb53ec8bb8c13428330
-  data.tar.gz: 55d215e115f5cba93b15bb770620e1e4c07d4097
+  metadata.gz: cf2ef5172d8110a1e4ba6f60c3a0900f333fe3ec
+  data.tar.gz: 3d79501d0d498ebd7fc84a5c14b670571b6602a1
 SHA512:
-  metadata.gz: 3b9a3600bce768416801c549bde1ca73f0ba0e7efd636a84e63522e70c4d1cfd8b22fc872f279d080b1671cec3aa565be931e79fa7e57e9aba62d34009db047f
-  data.tar.gz: 0d7cd82210643aed5eda2ea704052431b7d4ead067e9a7e2103c4f628c10ac1780f30750ab1968006807e577c6097a1adc7f43619e31207977a07d5d93b232d0
+  metadata.gz: 96e981402ce45178ce4f4d6038c70c65740502a9458139f8ecf478625fdbe382944fe05f031e6f20430960b4c737cd2623dff057ec960934408a7dd6b4e23133
+  data.tar.gz: 423da023a5a1763b4e105d106e507129be6255cfde3c1233f495e27b2f7996612826e6f5d1ff249d5ba7c12d237db09520aa204f616c019b2bf0485fa12c8878

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 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."
+      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."
     end
   end
 end

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

@@ -13,20 +13,20 @@ module Zadt
 
     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 "#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)"
+      puts "#make_connection(v1,v2), adds an edge between two vertices"
       puts "#break_connection(v1,v2)"
-      puts "#find_connection(v1,v2)"
+      puts "#find_connection(v1,v2), returns edge connecting two given vertices"
       puts "#is_connected?(v1,v2)"
     end
 
@@ -134,6 +134,14 @@ module Zadt
       neighbors.uniq
     end
 
+    # Return all neighbors of the given faces
+      # Neighbor is defined as sharing a vertex,
+      # not necessarily sharing an edge.
+    def find_face_neighbors(face)
+      neighbors = find_neighbors(face.vertices)
+      neighbors - face
+    end
+
     def make_vertex_line(vertex_array)
       connection_line = []
       connection_line << vertex_array.first
@@ -150,7 +158,7 @@ module Zadt
       end
       connection_line
     end
-
+    private
     def make_neighbors(face1, face2)
       face1.add_neighbor(face2)
       face2.add_neighbor(face1)

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

@@ -16,9 +16,9 @@ module Zadt
       puts "Here are the functions for Graph:"
       puts "#add_vertex"
       puts "#remove_vertex(vertex)"
-      puts "#make_connection(v1,v2)"
+      puts "#make_connection(v1,v2), adds an edge between two vertices"
       puts "#break_connection(v1,v2)"
-      puts "#find_connection(v1,v2)"
+      puts "#find_connection(v1,v2), returns edge connecting two given vertices"
       puts "#is_connected?(v1,v2)"
     end
 

data/lib/zadt/version.rb

@@ -1,3 +1,3 @@
 module Zadt
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zadt
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Benjamin Zagorski