zadt 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0c11ab2bf7da2e0f74cce5774efd9f9cb863e35
-  data.tar.gz: a7c1eb72e05d0d7d6b55f296274d4c6c7cce011e
+  metadata.gz: 5422fde4c7568acba5ed3f8781201d95b27a96b7
+  data.tar.gz: 213d340850bbf767e01e6cce0cec8ffef7859e12
 SHA512:
-  metadata.gz: 66c8828077da9414c71df8eac48dd92b6027f3687f472012f4231773fe678d58c105aa95d9661ff72d07c61eefed1a6f009ab81533afdc38d401cf1eb16b603f
-  data.tar.gz: bef7aa8acee94683807112bac4a19eba9d5f9b8ff2735b46186ac2eed4979140d8ea807dca0eb83f185f52b022b5ef7bbeb1c09fe27c2d496f13d1dc0ad4835e
+  metadata.gz: a647ad6ae68fe4fda78de921b5092f5795312572958516ac66f25672d4c62373df9f8eb45c7f111e54d2784db8d4534f6f95f7f0de822042ecbab27afe368915
+  data.tar.gz: 2e0cc6c118d0d43ed677238fcd06b85a9e9fd6d30cb27de04405dc507e34d02185ee53379cc20c18029b517209e05580b58ecd88e9283948894ef09c4bf70bf7

data/0.1.1

@@ -0,0 +1 @@
+Successfully installed randoq-0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # zadt
 
-Zagorski ADT is a collection of data types that are not included in the standard Ruby library.
+Zagorski ADT is a collection of abstract data types that are not included in the standard Ruby library.
 
 ## Installation
 
@@ -113,7 +113,6 @@ A FaceGraph has the following methods, in addition to its inheritance from Graph
 
 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.
@@ -122,31 +121,39 @@ Within the universe, you can create Points and Spheres (though the more proper t
 
 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
+#### HyperSphere
+
+A HyperSphere 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).
 
-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 HyperSphere is given a radius and a center (default is the 4-dimensional Unit Sphere, of radius 1 and center [0,0,0,0]).  HyperSpheres are immutable.
 
-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 HyperSphere has the following methods
+* on?(point) will return if a point is on the HyperSphere.
+* inside?(point) will return if a point is within the boundaries of the HyperSphere.
+* outside?(point) will return if a point is outside the boundaries of the HyperSphere.
+* how_far(point) will return how far a point is from the boundaries of the HyperSphere.
 
-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.
+##### Sphere
 
-The following methods are available exclusively for 3-dimensional spheres.
+A Sphere is a sub-class of the HyperSphere that has 3 dimensions and the following additional methods.
 * 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
+##### Circle
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+A Circle is a sub-class of the HyperSphere that has 2 dimensions and the following additional methods.
+* area, returns the area of the sphere
+* circumference, returns the circumference 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] will return "x^2 + (y - 1)^2 = 4".
+<!-- ## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org]("https://rubygems.org").
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org]("https://rubygems.org"). -->
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zadt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrmicrowaveoven/zadt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
@@ -155,4 +162,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Contact
 
-This gem was written in its entirety by Benjamin Zagorski, who can be contacted at Benj@Zagorski.com.  Feel free to contact me with any questions or comments, as I'm very open to suggestions.
+This gem was written in its entirety by Benjamin Zagorski, who can be contacted at Benj@Zagorski.com.  My portfolio can be found at [BenjZagorski.online](http://benjzagorski.online).  Feel free to contact me with any questions or comments, as I'm very open to suggestions.

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

@@ -0,0 +1,63 @@
+require_relative "hypersphere.rb"
+
+class Circle < HyperSphere
+
+  def initialize(radius = 1, center = [0,0], pct_error = 1)
+    super(radius, center, pct_error)
+  end
+
+  def help
+    Circle.help
+  end
+
+  def self.help
+    Circle.show_help_message
+  end
+
+  def area
+    dim_check(2)
+    Math::PI * (@radius ** 2)
+  end
+
+  def circumference
+    dim_check(2)
+    2 * Math::PI * @radius
+  end
+
+  def inspect
+    "Circle: #{equation}"
+  end
+
+  private
+
+  def self.show_help_message
+    super
+    Zadt::ADT::show_circle_help_message
+  end
+
+  def circle_equation
+    dim_check(2)
+    center_point = @center.dup
+    coord_names = ["x", "y"]
+    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 = #{@radius ** 2}"
+  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
+
+
+
+end

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

@@ -0,0 +1,72 @@
+require_relative 'point.rb'
+
+class HyperSphere
+  attr_reader :radius, :center
+  attr_accessor :pct_error
+
+  def initialize(radius = 1, center = [0,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?(point)
+    Zadt::Universe.distance(@center, point).round(2) == radius.round(2)
+  end
+
+  def inside?(point)
+    Zadt::Universe.distance(@center, point) <= @radius
+  end
+
+  def outside?(point)
+    !inside?(point)
+  end
+
+  def how_far(point)
+    (@radius - Zadt::Universe.distance(@center, point)).abs
+  end
+
+  def equation
+    dims = @center.dims
+    return circle_equation if dims == 2
+    center_point = @center.dup
+    # Only get the variables used in that dimension
+    coord_names = ("a".."z").to_a.slice(-dims, dims)
+    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
+    final_string = ""
+    (dims - 1).times do |index|
+      final_string += "#{coord_names[index]}^2 + "
+    end
+    final_string += "#{coord_names[dims - 1]}^2"
+    final_string += " = "
+    final_string += "#{@radius ** 2}"
+    final_string
+  end
+
+  private
+
+  def dim_check(num)
+    raise "dimension error" unless num == @center.dims
+  end
+
+  def self.show_help_message
+    Zadt::ADT::show_hypersphere_help_message
+  end
+
+end

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

@@ -1,34 +1,9 @@
-require_relative 'point.rb'
+require_relative "hypersphere.rb"
 
-class Sphere
-
-  attr_reader :radius, :center
-  attr_accessor :pct_error
+class Sphere < HyperSphere
 
   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
+    super(radius, center, pct_error)
   end
 
   def volume
@@ -41,22 +16,6 @@ class Sphere
     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
@@ -64,6 +23,7 @@ class Sphere
   private
 
   def self.show_help_message
+    super
     Zadt::ADT::show_sphere_help_message
   end
 
@@ -74,8 +34,4 @@ class Sphere
     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

@@ -1,4 +1,5 @@
 require_relative 'point.rb'
+require_relative 'circle.rb'
 require_relative 'sphere.rb'
 
 module Zadt

data/lib/zadt/AbstractDataTypes/LinkedList/SinglyLinkedList.rb

@@ -0,0 +1,9 @@
+module Zadt
+  class SinglyLinkedListNode
+    attr_accessor :val, :next
+    def initialize(val = nil, next_ = nil)
+      @val = val
+      @next = next_
+    end
+  end
+end

data/lib/zadt/HelpModules/adt_geometrics_help.rb

@@ -7,15 +7,26 @@ module Zadt
       puts "#self.distance(pointA, pointB)"
     end
 
+    def self.show_hypersphere_help_message
+      puts "Here are the methods for HyperSphere:"
+      puts "#on?(point)"
+      puts "#inside?(point)"
+      puts "#outside?(point)"
+      puts "#how_far(point)"
+    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 "The following methods are specific to 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
+    
+    def self.show_circle_help_message
+      puts "The following methods are specific to a Circle (2-dimensions):"
+      puts "#area"
+      puts "#circumference"
+      puts "#equation, which returns a string in the form of (x-a)^2 + (y-b)^2 = r^2"
+    end
   end
 end

data/lib/zadt/version.rb

@@ -1,3 +1,3 @@
 module Zadt
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zadt
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Benjamin Zagorski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,6 +69,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- 0.1.1
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -79,6 +80,8 @@ files:
 - lib/ADT_requireables.rb
 - lib/helper_functions.rb
 - lib/zadt.rb
+- lib/zadt/AbstractDataTypes/Geometrics/circle.rb
+- lib/zadt/AbstractDataTypes/Geometrics/hypersphere.rb
 - lib/zadt/AbstractDataTypes/Geometrics/point.rb
 - lib/zadt/AbstractDataTypes/Geometrics/sphere.rb
 - lib/zadt/AbstractDataTypes/Geometrics/universe.rb
@@ -88,6 +91,7 @@ files:
 - lib/zadt/AbstractDataTypes/Graph/face_graph.rb
 - lib/zadt/AbstractDataTypes/Graph/graph.rb
 - lib/zadt/AbstractDataTypes/Graph/vertex.rb
+- lib/zadt/AbstractDataTypes/LinkedList/SinglyLinkedList.rb
 - lib/zadt/AbstractDataTypes/StackQueue/MinMaxStack.rb
 - lib/zadt/AbstractDataTypes/StackQueue/MinMaxStackQueue.rb
 - lib/zadt/AbstractDataTypes/StackQueue/Queue.rb