zadt 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14d5d23662aa56e1c863e096a68657364b276574
-  data.tar.gz: 10f4b9da70a96defbe4c75c2c4920b09a3dab714
+  metadata.gz: 8895ef5d94147f877d0ca9d14fe2a2cadd2a159c
+  data.tar.gz: f28233fd6801797e5f304cb54bdeadbc056f94d0
 SHA512:
-  metadata.gz: 40eb3b8f4ab8ae3fa098838ba4416ef035c1f1bedd8bd5fa7aefb77f7fccc5dbe4d4853446c9f9a2569e8624cd361944f07f0b8c721dad03385d88d1646358f6
-  data.tar.gz: cf59f864501efdc60b3388e337afddfcf4cc0bb0abac48127871715785590cbd81591899cb807b80b8f0571da69ad9df4b6e06c5cab9366f3cdd14451d418788
+  metadata.gz: 7cc9788cc828d6a52c1ed4bb9e3b47ba883450db9f953f607a96440e4a7e2c92febc4a2186d6c458f30cc8495283055884dbab3403dd970086b456ea9f57a39e
+  data.tar.gz: ac0158200268b0973ecbb8f1444bfc5c552fd371b922e8cb0d5d0be884f06ddb4f3282fae3c5a88c5679539d102bf5cb0701bd84e720b543c384c7f2dddebb1b

data/README.md

@@ -26,13 +26,63 @@ I also made a "help" function for each Data Type.  Type Zadt::StackQueue.help ge
 
 And don't forget to require 'zadt' at the top!
 
-### MinMaxStackQueue
+### Stacks and Queues
+
+If you've never heard of a Stack or a Queue before, click [here](https://en.wikibooks.org/wiki/Data_Structures/Stacks_and_Queues) for an introduction.
 
 A MinMaxStackQueue is an Queue object that allows the minimum and maximum values to be found in constant time.  It's built by making a Queue out of a Stack, which has that same min/max ability.
 
 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.
 
-### Graphs
+#### Stack
+
+My Stack has the following methods:
+* show, returns the entire stack
+* push(value), adds a value to the top of the stack
+* pop, returns the value at the top of the stack, and removes it
+* peek, returns the value at the top of the stack, but doesn't remove it
+* length, number of values in the stack
+* empty?, whether or not the stack is empty
+
+#### Queue
+
+My Queue has the following methods:
+* show, returns the entire queue
+* enqueue(value), adds a value to the back of the queue
+* dequeue, returns the value at the front of the queue, and removes it
+* peek, returns the value at the front of the queue, but doesn't remove it
+* length, number of values in the queue
+* empty?, whether or not the queue is empty
+
+#### StackQueue
+
+StackQueue has the same methodology as Queue
+
+#### MinMaxStack
+
+My MinMaxStack has the following methods:
+* show, returns the entire stack
+* push(value), adds a value to the top of the stack
+* pop, returns the value at the top of the stack, and removes it
+* peek, returns the value at the top of the stack, but doesn't remove it
+* min, returns the lowest value of the stack.  Works in constant time.
+* max, returns the highest value of the stack.  Works in constant time.
+* length, number of values in the stack
+* empty?, whether or not the stack is empty
+
+#### MinMaxStackQueue
+
+My MinMaxStackQueue has the following methods:
+* show, returns the entire queue
+* enqueue(value), adds a value to the back of the queue
+* dequeue, returns the value at the front of the queue, and removes it
+* peek, returns the value at the front of the queue, but doesn't remove it
+* min, returns the lowest value of the queue.  Works in constant time.
+* max, returns the highest value of the queue.  Works in constant time.
+* length, number of values in the queue
+* empty?, whether or not the queue is empty
+
+### Graph Objects
 
 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.
 
@@ -55,10 +105,38 @@ A Graph has the following methods
 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
+* add_attached_face(vertex_array, num_edges), which adds a face connected to the vertex_array specified.  Face will consist of the number of edges specified.
 * 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
+
+### Geometrics
+
+Geometric objects, contained within a universe.
+
+
+#### Universe
+
+An universe is a Euclidean coordinate system that can be any number of dimensions.  When initialized, you can specify how many dimensions you want it, or you can leave it blank to have infinite dimensions.  Once a dimension is set, all objects in it are limited to that many dimensions.  A universe of infinite dimensions has no restrictions, and can hold objects of any number of dimensions.
+
+Within the universe, you can create Points and Spheres (though the more proper term is HyperSphere, more on that later).  The only two functions are #add_point(coordinates) and #add_sphere(radius, center).  Both will check to ensure that the number of dimensions matches the universe (if the universe has a finite number of dimensions).
+
+In addition, the universe has the class method Universe.distance(pointA, pointB), which will tell you the distance between any two points.  This will work for points in any number of dimensions, so long as the two points are of the same.
+
+#### Sphere
+
+A Sphere is a set of points within a certain number of dimensions that are equidistant (equal distance) from a given point.  The number of dimensions is defined by the number of coordinates in its center.  For example, a two-dimensional sphere (called a Circle) has a center of (x,y).  This leads to the more proper term of HyperSphere, though that is not used in syntax.
+
+Upon creation, a sphere is given a radius and a center (default is the 3-dimensional Unit Sphere, of radius 1 and center [0,0,0]).  Spheres are immutable, as of yet, and though the number of dimensions is limitless certain functionalities will only apply to a 3-dimensional sphere.
+
+A Sphere has the following methods
+* on_sphere?(point) will return if a point is on the sphere.
+* in_sphere?(point) will return if a point is within the boundaries of the sphere.
+* how_far_from_sphere(point) will return how far a point is from the boundaries of the sphere.
+
+The following methods are available exclusively for 3-dimensional spheres.
+* volume, returns the volume of the sphere
+* surface_area, returns the surface area of the sphere
+* equation, returns a string of the standard equation of the sphere.  For example, a sphere with Radius 2 and Center [0,1,-2] will return "x^2 + (y - 1)^2 + (z + 2)^2 = 4".
 
 ## Development
 

data/lib/ADT_requireables.rb

@@ -1,12 +1,20 @@
-require_relative 'zadt/AbstractDataTypes/ADT.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'
+# Note that we only require those that are included in the gem, not their dependancies.
+# This is so the client does not have access to these private classes
+# Ex. A client cannot make an edge other than within a graph.
+
+require_relative 'zadt/HelpModules/adt_help.rb'
+require_relative 'zadt/HelpModules/adt_stackqueue_help.rb'
+require_relative 'zadt/HelpModules/adt_graph_help.rb'
+require_relative 'zadt/HelpModules/adt_geometrics_help.rb'
+
+require_relative 'zadt/AbstractDataTypes/StackQueue/Stack.rb'
+require_relative 'zadt/AbstractDataTypes/StackQueue/Queue.rb'
+require_relative 'zadt/AbstractDataTypes/StackQueue/StackQueue.rb'
+require_relative 'zadt/AbstractDataTypes/StackQueue/MinMaxStack.rb'
+require_relative 'zadt/AbstractDataTypes/StackQueue/MinMaxStackQueue.rb'
+
 require_relative 'zadt/AbstractDataTypes/Graph/graph.rb'
 require_relative 'zadt/AbstractDataTypes/Graph/face.rb'
 require_relative 'zadt/AbstractDataTypes/Graph/face_graph.rb'
+
+require_relative 'zadt/AbstractDataTypes/Geometrics/universe.rb'

data/lib/zadt/AbstractDataTypes/Geometrics/point.rb

@@ -0,0 +1,7 @@
+class Point
+  attr_reader :coords, :dims
+  def initialize(coordinates)
+    @coords = coordinates
+    @dims = @coords.length
+  end
+end

data/lib/zadt/AbstractDataTypes/Geometrics/sphere.rb

@@ -0,0 +1,81 @@
+require_relative 'point.rb'
+
+class Sphere
+
+  attr_reader :radius, :center
+  attr_accessor :pct_error
+
+  def initialize(radius = 1, center = [0,0,0], pct_error = 1)
+    @radius = radius
+    @center = Point.new(center)
+    @pct_error = pct_error
+  end
+
+  def self.help
+    Sphere.show_help_message
+  end
+
+  def help
+    Sphere.help
+  end
+
+  def on_sphere?(point)
+    Zadt::Universe.distance(@center, point).round(2) == radius.round(2)
+  end
+
+  def in_sphere?(point)
+    Zadt::Universe.distance(@center, point) <= @radius
+  end
+
+  def how_far_from_sphere(point)
+    (@radius - Zadt::Universe.distance(@center, point)).abs
+  end
+
+  def volume
+    dim_check(3)
+    Math::PI * (@radius ** 3) * 4.0 / 3.0
+  end
+
+  def surface_area
+    dim_check(3)
+    4.0 * Math::PI * (@radius ** 2)
+  end
+
+  def equation
+    dim_check(3)
+    center_point = @center.dup
+    coord_names = ["x", "y", "z"]
+    center_point.coords.each_with_index do |center_coord, index|
+      if center_coord == 0
+        # coord_name is fine
+      elsif center_coord < 0
+        coord_names[index] = "(#{coord_names[index]} + #{-center_coord})"
+      else
+        coord_names[index] = "(#{coord_names[index]} - #{center_coord})"
+      end
+    end
+    "#{coord_names[0]}^2 + #{coord_names[1]}^2 + #{coord_names[2]}^2 = #{@radius ** 2}"
+  end
+
+  def inspect
+    "Sphere: #{equation}"
+  end
+
+  private
+
+  def self.show_help_message
+    Zadt::ADT::show_sphere_help_message
+  end
+
+  def close_enough(guess, exact)
+    range = Array.new
+    range[0] = exact *(100.0 - @pct_error)/100.0
+    range[1] = exact * (100.0 + @pct_error)/100.0
+    guess.between?(range[0], range[1])
+  end
+
+  def dim_check(num)
+    raise "dimension error" unless num == @center.dims
+  end
+
+end

data/lib/zadt/AbstractDataTypes/Geometrics/universe.rb

@@ -0,0 +1,54 @@
+require_relative 'point.rb'
+require_relative 'sphere.rb'
+
+module Zadt
+  class Universe
+    attr_reader :points, :objects
+    def initialize(num_dim = nil)
+      @num_dim = num_dim
+      @points = []
+      @objects = []
+    end
+
+    def self.help
+      Universe.show_help_message
+    end
+
+    def help
+      Universe.help
+    end
+
+    def self.distance(pointa, pointb)
+      raise "different dimensions" if pointa.dims != pointb.dims
+      coordinate_distances = Array.new
+      pointa.dims.times {|coord| coordinate_distances[coord] = pointa.coords[coord] - pointb.coords[coord]}
+      sum_of_squares = coordinate_distances.inject(0) {|sum, coord| sum += coord ** 2}
+      return Math.sqrt(sum_of_squares)
+    end
+
+    def add_point(coords)
+      point = Point.new(coords)
+      dim_check(point)
+      @points << point
+      point
+    end
+
+    def add_sphere(radius, center)
+      sphere = Sphere.new(radius, center)
+      dim_check(sphere.center)
+      @objects << sphere
+      sphere
+    end
+
+    private
+
+    def dim_check(point)
+      return if !@num_dim
+      raise "Wrong number of dimensions" if point.dims != @num_dim
+    end
+
+    def self.show_help_message
+      Zadt::ADT::show_universe_help_message
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Zadt
+  class DiGraph < Graph
+
+  end
+end

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

@@ -1,44 +1,19 @@
 # require_relative 'vertex.rb'
 # require_relative 'edge.rb'
   class Face
-    attr_reader :edges, :vertices, :neighboring_faces
+    attr_reader :edges, :vertices
     # Contains
     attr_accessor :value
-    def initialize(edges_array, neighboring_faces = {}, value = Hash.new)
-      raise "Not enough edges" if edges_array.length < 3
+
+    def initialize(edges_array, value = Hash.new)
+      raise "not enough edges" if edges_array.length < 3
+      edges_array.each {|edge| raise "not an edge" unless edge.is_a?(Edge)}
       @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
       @value = value
     end
 
-    # TODO: Neighbors shouldn't be stored in Face, as FaceGraph takes care of this
-
-    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

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

@@ -7,7 +7,7 @@ module Zadt
     attr_reader :faces
     #   in addition to its parent's :vertices and :edges
 
-    # Contains
+    # Contains (inherits)
     # attr_accessor :value
 
     def initialize
@@ -26,6 +26,7 @@ module Zadt
 
 
     def add_face(edges_array)
+      edge_array_check(edges_array)
       face = Face.new(edges_array)
       @faces << face
       face
@@ -33,7 +34,7 @@ module Zadt
 
     # Makes a face with num_edges edges, which will be attached to nothing.
     def make_original_face(num_edges)
-
+      num_edges_check(num_edges)
       # Make the vertices
       vert_ref = Array.new(num_edges) {Vertex.new}
       edge_ref = []
@@ -59,8 +60,10 @@ module Zadt
     # This will automatically make_neighbors with any faces that share
     #   a vertex with the new face
     def add_attached_face(vertex_array, num_edges)
+      vertex_array_check(vertex_array)
+      num_edges_check(num_edges)
       # Make the vertices into a line
-      vertex_line = make_vertex_line(vertex_array)
+      vertex_line = confirm_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
@@ -97,17 +100,12 @@ module Zadt
       # 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)
+      vertex_array_check(vertex_array)
       neighbors = []
       vertex_array.each do |vertex|
         @faces.each do |face|
@@ -121,28 +119,33 @@ module Zadt
       # Neighbor is defined as sharing a vertex,
       # not necessarily sharing an edge.
     def find_face_neighbors(face)
+      raise "not a face" unless face.is_a?(Face)
       neighbors = find_neighbors(face.vertices)
       neighbors - [face]
     end
 
-
   private
 
-    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
+    def vertex_array_check(vertex_array)
+      raise "invalid vertex array" unless vertex_array.is_a?(Array)
+      vertex_array.each {|vertex| raise "not a vertex" unless vertex.is_a?(Vertex)}
+    end
+
+    def edge_array_check(edges_array)
+      raise "not an array" unless edges_array.is_a?(Array)
+      edges_array.each {|edge| raise "not an edge" unless edge.is_a?(Edge)}
+    end
+
+    def num_edges_check(num_edges)
+      raise "invalid number of edges" unless num_edges.is_a?(Integer)
+      raise "need 3 or more edgesto make a face" unless num_edges > 2
+    end
+
+    def confirm_vertex_line(vertex_array)
+      (vertex_array.length - 1).times do |i|
+        raise "Vertices not connected" unless vertex_array[i].is_connected?(vertex_array[i+1])
       end
-      connection_line
+      vertex_array
     end
 
     def make_neighbors(face1, face2)
@@ -156,22 +159,7 @@ module Zadt
     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)"
+      Zadt::ADT::show_face_graph_help_message
     end
   end
 end

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

@@ -38,6 +38,7 @@ module Zadt
     # Remove a vertex
     def remove_vertex(vertex)
       # The vertex must exist
+      raise "not a vertex" unless vertex.is_a?(Vertex)
       if !vertex
         raise "Vertex does not exist"
       # The vertex must not be connected to anything
@@ -51,6 +52,7 @@ module Zadt
 
     # Make an edge between two vertices
     def make_connection(v1, v2)
+      raise "not a vertex" unless v1.is_a?(Vertex) && v2.is_a?(Vertex)
       raise "already connected" if is_connected?(v1, v2)
       # Make new edge
       edge = Edge.new(v1, v2)
@@ -65,12 +67,16 @@ module Zadt
 
     # Find the edge connecting two vertices
     def find_connection(v1, v2)
+      raise "not a vertex" unless v1.is_a?(Vertex) && v2.is_a?(Vertex)
+      raise "Vertices not connected" if !is_connected?(v1, v2)
       connection = v1.edges.select {|edge| edge.connection.include?(v2)}
+      raise "Error finding connection" if connection.length > 1
       connection.first
     end
 
     # Returns whether two vertices are connected
     def is_connected?(v1, v2)
+      raise "not a vertex" unless v1.is_a?(Vertex) && v2.is_a?(Vertex)
       v1.connections.include?(v2)
     end
 
@@ -96,13 +102,7 @@ module Zadt
     private
 
     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"
-      puts "#break_connection(v1,v2)"
-      puts "#find_connection(v1,v2), returns edge connecting two given vertices"
-      puts "#is_connected?(v1,v2)"
+      Zadt::ADT::show_graph_help_message
     end
   end
 end

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

@@ -19,7 +19,9 @@
 
     # Make an edge between this vertex and another
     def connect(other_vertex, edge)
-      return nil if !other_vertex.is_a?(Vertex) || other_vertex == self
+      raise "not a vertex" unless other_vertex.is_a?(Vertex)
+      raise "cannot connect vertex to self" if other_vertex == self
+      raise "not an edge" unless edge.is_a?(Edge)
       raise "already connected" if is_connected?(other_vertex)
       # Store connection info in this vertex
       @edges << edge
@@ -29,6 +31,7 @@
 
     # Returns if another vertex is "connected" to this one
     def is_connected?(other_vertex)
+      raise "not a vertex" unless other_vertex.is_a?(Vertex)
       @connections.include?(other_vertex)
     end
 

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

@@ -8,27 +8,11 @@ module Zadt
     end
 
     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?"
-    end
-
-    def self.methods
-      self.help
+      Zadt::ADT::show_minmaxstack_help_message
     end
 
     def help
-      self.help
-    end
-
-    def methods
-      help
+      MinMaxStack.help
     end
 
     def push(val)

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

@@ -11,28 +11,13 @@ module Zadt
     end
 
     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?"
-    end
-
-    def self.methods
-      self.help
+      Zadt::ADT::show_minmaxstackqueue_help_message
     end
 
     def help
       MinMaxStackQueue.help
     end
 
-    def methods
-      help
-    end
-
     def show
       @out.show.reverse + @in.show
     end
@@ -50,6 +35,15 @@ module Zadt
       @out.pop
     end
 
+    def peek
+      if @out.empty?
+        @in.length.times do
+          @out.push(@in.pop)
+        end
+      end
+      @out.peek
+    end
+
     def min
       if @in.empty?
         @out.min

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

@@ -5,26 +5,13 @@ module Zadt
     end
 
     def self.help
-      puts "Here are the functions for Queue:"
-      puts "#show"
-      puts "#enqueue(value)"
-      puts "#dequeue"
-      puts "#length"
-      puts "#empty?"
-    end
-
-    def self.methods
-      self.help
+      Zadt::ADT::show_queue_help_message
     end
 
     def help
       Queue.help
     end
 
-    def methods
-      help
-    end
-
     def show
       @values
     end
@@ -38,6 +25,10 @@ module Zadt
       @values.shift
     end
 
+    def peek
+      @values.first
+    end
+
     def length
       @values.length
     end

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

@@ -5,26 +5,13 @@ module Zadt
     end
 
     def self.help
-      puts "Here are the functions for Stack:"
-      puts "#show"
-      puts "#push(value)"
-      puts "#pop"
-      puts "#length"
-      puts "#empty?"
-    end
-
-    def self.methods
-      self.help
+      Zadt::ADT::show_stack_help_message
     end
 
     def help
       Stack.help
     end
 
-    def methods
-      help
-    end
-
     def show
       @values
     end
@@ -38,6 +25,10 @@ module Zadt
       @values.pop
     end
 
+    def peek
+      @values.last
+    end
+
     def length
       @values.length
     end

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

@@ -10,26 +10,13 @@ module Zadt
     end
 
     def self.help
-      puts "Here are the functions for StackQueue:"
-      puts "#show"
-      puts "#enqueue(value)"
-      puts "#dequeue"
-      puts "#length"
-      puts "#empty?"
-    end
-
-    def self.methods
-      self.help
+      Zadt::ADT::show_stackqueue_help_message
     end
 
     def help
       StackQueue.help
     end
 
-    def methods
-      help
-    end
-
     def show
       @out.show.reverse + @in.show
     end
@@ -47,12 +34,21 @@ module Zadt
       @out.pop
     end
 
+    def peek
+      if @out.empty?
+        @in.length.times do
+          @out.push(@in.pop)
+        end
+      end
+      @out.peek
+    end
+
     def length
       @in.length + @out.length
     end
 
     def empty?
-      @values.empty?
+      @in.empty? && @out.empty?
     end
   end
 end

data/lib/zadt/HelpModules/adt_geometrics_help.rb

@@ -0,0 +1,21 @@
+module Zadt
+  class ADT
+    def self.show_universe_help_message
+      puts "Here are the methods for Universe:"
+      puts "#add_point(coordinates)"
+      puts "#add_sphere(radius, center)"
+      puts "#self.distance(pointA, pointB)"
+    end
+
+    def self.show_sphere_help_message
+      puts "Here are the methods for Sphere:"
+      puts "#on_sphere(point)"
+      puts "#in_sphere(point)"
+      puts "#how_far_from_sphere(point)"
+      puts "The following methods are also included in a 3-dimensional sphere:"
+      puts "#volume"
+      puts "#surface_area"
+      puts "#equation, which returns a string in the form of (x-a)^2 + (y-b)^2 + (z-c)^2 = r^2"
+    end
+  end
+end

data/lib/zadt/HelpModules/adt_graph_help.rb

@@ -0,0 +1,31 @@
+module Zadt
+  class ADT
+    def self.show_graph_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"
+      puts "#break_connection(v1,v2)"
+      puts "#find_connection(v1,v2), returns edge connecting two given vertices"
+      puts "#is_connected?(v1,v2)"
+    end
+
+    def self.show_face_graph_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 ""
+      puts "FaceGraph also inherits the following methods 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/ADT.rb → HelpModules/adt_help.rb}

@@ -3,18 +3,26 @@ module Zadt
     def self.help
       puts "Thank you for using Zagorski Advanced 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 a cycle of Edges.  Consists of Vertices and the Edges connecting them"
+
+      puts "Geometrics"
+      puts "-Universe, consisting of Points and Spheres"
+      puts "--Point, a 'spot' in the universe"
+      puts "--Sphere, a set of points in a certain number of dimensions that is equidistant from a given point, called the Center"
+
       puts ""
       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

data/lib/zadt/HelpModules/adt_stackqueue_help.rb

@@ -0,0 +1,57 @@
+module Zadt
+  class ADT
+    def self.show_stack_help_message
+      puts "Here are the functions for Stack:"
+      puts "#show"
+      puts "#push(value)"
+      puts "#pop"
+      puts "#peek"
+      puts "#length"
+      puts "#empty?"
+    end
+
+    def self.show_queue_help_message
+      puts "Here are the functions for Queue:"
+      puts "#show"
+      puts "#enqueue(value)"
+      puts "#dequeue"
+      puts "#peek"
+      puts "#length"
+      puts "#empty?"
+    end
+
+    def self.show_stackqueue_help_message
+      puts "Here are the functions for StackQueue:"
+      puts "#show"
+      puts "#enqueue(value)"
+      puts "#dequeue"
+      puts "#peek"
+      puts "#length"
+      puts "#empty?"
+    end
+
+    def self.show_minmaxstack_help_message
+      puts "Here are the functions for MinMaxStack:"
+      puts "#show"
+      puts "#push(value)"
+      puts "#pop"
+      puts "#peek"
+      puts "#min"
+      puts "#max"
+      puts "#length"
+      puts "#empty?"
+    end
+
+    def self.show_minmaxstackqueue_help_message
+      puts "Here are the functions for MinMaxStackQueue:"
+      puts "#show"
+      puts "#enqueue(value)"
+      puts "#dequeue"
+      puts "#peek"
+      puts "#min"
+      puts "#max"
+      puts "#length"
+      puts "#empty?"
+    end
+  end
+end

data/lib/zadt/version.rb

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

data/zadt.gemspec

@@ -10,9 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["benj@zagorski.com"]
 
   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.
+  spec.description   = %q{Includes three different categories of Advanced Data Types: Array-Based, Graphs, and Geometrics.
     Array-Based Data Types include Stack, Queue, StackQueue, MinMaxStack, and MinMaxStackQueue.
     Graph Data Types include Graph, which consists of Vertices and Edges, and FaceGraph, which includes Faces.
+    Geometrics includes Universe, which currently consists of Points and Spheres (work in progress).
     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.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Benjamin Zagorski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,9 +53,10 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 description: |-
-  Includes two different categories of Advanced Data Types: Array-Based, and Graphs.
+  Includes three different categories of Advanced Data Types: Array-Based, Graphs, and Geometrics.
       Array-Based Data Types include Stack, Queue, StackQueue, MinMaxStack, and MinMaxStackQueue.
       Graph Data Types include Graph, which consists of Vertices and Edges, and FaceGraph, which includes Faces.
+      Geometrics includes Universe, which currently consists of Points and Spheres (work in progress).
       Once installed, type "Zadt::ADT::help" for a list of datatypes
       and basic functionality.
 email:
@@ -78,17 +79,24 @@ files:
 - lib/ADT_requireables.rb
 - lib/helper_functions.rb
 - lib/zadt.rb
-- lib/zadt/AbstractDataTypes/ADT.rb
+- lib/zadt/AbstractDataTypes/Geometrics/point.rb
+- lib/zadt/AbstractDataTypes/Geometrics/sphere.rb
+- lib/zadt/AbstractDataTypes/Geometrics/universe.rb
+- lib/zadt/AbstractDataTypes/Graph/di_graph.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/AbstractDataTypes/StackQueue/MinMaxStack.rb
+- lib/zadt/AbstractDataTypes/StackQueue/MinMaxStackQueue.rb
+- lib/zadt/AbstractDataTypes/StackQueue/Queue.rb
+- lib/zadt/AbstractDataTypes/StackQueue/Stack.rb
+- lib/zadt/AbstractDataTypes/StackQueue/StackQueue.rb
+- lib/zadt/HelpModules/adt_geometrics_help.rb
+- lib/zadt/HelpModules/adt_graph_help.rb
+- lib/zadt/HelpModules/adt_help.rb
+- lib/zadt/HelpModules/adt_stackqueue_help.rb
 - lib/zadt/version.rb
 - zadt.gemspec
 homepage: https://github.com/MrMicrowaveOven/zadt.git