easy_geometry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fb6f95cfb1ee017a62c9f6ed39a3ec916fadcaf966291e239de58da7d81307
-  data.tar.gz: fe76ffe30725d0ff656ae85b706b5481ac1959eebe7482fdb608424762c59629
+  metadata.gz: dcb12969d22494d6a789551ae657851411b331e0e91413378a6d9bc64806050a
+  data.tar.gz: 7dbcd5ce78baf99a3c8b67a2ea05ee5a3dd50560bf750b6aac4d5026472de2b5
 SHA512:
-  metadata.gz: 525e81099138a5fad5f62e165e4fba932225a5a84cccf430a3033ba6d31e17467ddaa34777eb3cb06d15c8ce2fc13ce65e62f3d9371ce2ca97102aa0dfc9bcb8
-  data.tar.gz: 7941f809a621cbeeeaa7b753bb1890115d0d7fbbbf5c29837f28d7ec83ea8159ea7751f8638e34b345bde8448e4136d8e39124389fc34bdb2d3fbc3ba9a9a3d6
+  metadata.gz: 660a28139e2b469f9877e8763e63a7f74315a25068a27c6e0bc2d5ed64c60fdbe0e6555fb8011a4ec467aff09a33d713366c682ee7fc426ecdfebf66cb107484
+  data.tar.gz: 45b64a55bd38d20985af2055c2ec65c40d6d91150ee4d3023c99629985d7d106925c447cb71115996d0d497e4888f949b5a8250523d6ce88d82d0449b7cc3df9

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Henry Metlov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+Geometry for Ruby
+=================
+
+[![Gem Version](https://badge.fury.io/rb/easy_geometry.svg)](http://badge.fury.io/rb/easy_geometry)
+
+EasyGeometry gem allows one to create two-dimensional geometrical entities, such as lines and polygons, and query for information about these entities. This could include asking the area of an polygon, checking for collinearity of a set of points, or finding the intersection between two lines.
+
+
+Available geometry entities
+----------
+
+- Point, Vector
+- Line, Segment, Ray
+- Polygon, Triangle
+
+Installation
+----------
+```ruby
+gem install easy_geometry
+```
+
+Examples
+--------
+
+
+```ruby
+x = EasyGeometry::D2::Point.new(0, 0)
+y = EasyGeometry::D2::Point.new(1, 1)
+z = EasyGeometry::D2::Point.new(2, 2)
+w = EasyGeometry::D2::Point.new(1, 0)
+
+EasyGeometry::D2::Point.is_collinear?(x, y, z) # true
+EasyGeometry::D2::Point.is_collinear?(x, y, w) # false
+
+t = EasyGeometry::D2::Triangle.new(x, y, w)
+t.area      # 0.5
+t.perimeter # 3.414213562373095
+
+s1 = EasyGeometry::D2::Segment.new([0, 0], [1, 1])
+s2 = EasyGeometry::D2::Segment.new([0, 0], [-1, 1])
+s3 = EasyGeometry::D2::Segment.new([0, 0], [1, 0])
+s1.midpoint         # Point(1/2, 1/2)
+s3.length           # 1
+s1.intersection(s2) # [Point(0, 0)]
+```
+
+You can find more examples in [documentetion](https://genrih-metlov.gitbook.io/easy-geometry/) and in `specs` directory.
+
+License
+-------
+
+2019 Henry Metlov, released under the MIT license

data/easy_geometry.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "easy_geometry"
-  s.version     = "0.1.0"
+  s.version     = "0.2.0"
   s.author      = ["Henry Metlov"]
   s.date        = '2019-10-20'
   s.homepage    = "https://github.com/Metloff/easy_geometry"

data/lib/easy_geometry.rb

@@ -9,4 +9,4 @@ module EasyGeometry
   require_relative 'easy_geometry/d2/ray'
   require_relative 'easy_geometry/d2/polygon'
   require_relative 'easy_geometry/d2/triangle'
-end
+end

data/lib/easy_geometry/d2/line.rb

@@ -3,15 +3,18 @@ module EasyGeometry
     # An infinite line in 2-dimensional Euclidean space.
     class Line < LinearEntity
 
+      # Is other GeometryEntity contained in this Line?
       # 
       # Parameters:
-      #   GeometryEntity
+      #   GeometryEntity or Array of Numeric(coordinates)
       # 
       # Returns:
       #   true if `other` is on this Line.
       #   false otherwise.
       # 
       def contains?(other)
+        other = Point.new(other[0], other[1]) if other.is_a?(Array)
+        
         if other.is_a?(Point)
           return Point.is_collinear?(other, self.p1, self.p2)    
         end
@@ -25,9 +28,9 @@ module EasyGeometry
 
       # Finds the shortest distance between a line and a point.
       # 
-      # Raises
-      #   ======
-      #   TypeError is raised if `other` is not a Point
+      # Parameters:
+      #   Point or Array of Numeric(coordinates)
+      # 
       def distance(other)
         other = Point.new(other[0], other[1]) if other.is_a?(Array)
         raise TypeError, "Distance between Line and #{ other.class } is not defined" unless other.is_a?(Point)
@@ -36,10 +39,13 @@ module EasyGeometry
         self.perpendicular_segment(other).length
       end
 
-      # Returns True if self and other are the same mathematical entities
+      # Returns True if self and other are the same mathematical entities.
+      # 
+      # Parameters:
+      #   GeometryEntity
+      # 
       def ==(other)
         return false unless other.is_a?(Line)
-
         Point.is_collinear?(self.p1, other.p1, self.p2, other.p2)
       end
 

data/lib/easy_geometry/d2/linear_entity.rb

@@ -17,7 +17,7 @@ module EasyGeometry
 
       # The direction vector of the LinearEntity.
       # Returns:
-      #   Point; the ray from the origin to this point is the
+      #   Vector; the ray from the origin to this point is the
       # direction of `self`.
       # 
       def direction
@@ -180,7 +180,7 @@ module EasyGeometry
       end
 
       # Create a new Line parallel to this linear entity which passes
-      # through the point `p`
+      # through the point p
       # 
       # Parameters:
       #   Point
@@ -189,12 +189,14 @@ module EasyGeometry
       #   Line
       # 
       def parallel_line(point)
+        point = Point.new(point[0], point[1]) if point.is_a?(Array)
         raise TypeError, 'Must pass only Point.' unless point.is_a?(Point)
+
         Line.new(point, point + self.direction.to_point)
       end
 
       # Create a new Line perpendicular to this linear entity which passes
-      # through the point `point`.
+      # through the `point`.
       # 
       # Parameters:
       #   Point
@@ -203,6 +205,7 @@ module EasyGeometry
       #   Line
       # 
       def perpendicular_line(point)
+        point = Point.new(point[0], point[1]) if point.is_a?(Array)
         raise TypeError, 'Must pass only Point.' unless point.is_a?(Point)
 
         # any two lines in R^2 intersect, so blindly making
@@ -222,6 +225,7 @@ module EasyGeometry
       #   Segment or Point (if `point` is on this linear entity.)
       # 
       def perpendicular_segment(point)
+        point = Point.new(point[0], point[1]) if point.is_a?(Array)
         raise TypeError, 'Must pass only Point.' unless point.is_a?(Point)
 
         return point if self.contains?(point)
@@ -258,12 +262,14 @@ module EasyGeometry
       # A point x is 'in front' of a point y if x.dot(y) >= 0.
       # 
       # Return
-      #   -1 if `other` is behind `self.p1`, 
-      #   0 if `other` is `self.p1` 
-      #   1 if `other` is in front of `self.p1`.
+      #   -1 if other is behind self.p1 
+      #   0 if other is self.p1
+      #   1 if other is in front of self.p1.
       # 
       def span_test(other)
+        other = Point.new(other[0], other[1]) if other.is_a?(Array)
         raise TypeError, 'Must pass only Point.' unless other.is_a?(Point)
+
         return 0 if self.p1 == other
 
         rel_pos = other - self.p1

data/lib/easy_geometry/d2/point.rb

@@ -66,8 +66,7 @@ module EasyGeometry
 
       # True if every coordinate is zero, False if any coordinate is not zero.
       def zero?
-        return true if x.zero? && y.zero? 
-        return false
+        x.zero? && y.zero? 
       end
 
       # Compare self and other Point.

data/lib/easy_geometry/d2/polygon.rb

@@ -11,7 +11,7 @@ module EasyGeometry
     # and any points collinear and between two points will be removed
     # unless they are needed to define an explicit intersection (see specs).
 
-    # Must be at least 4 points
+    # Must be at least 3 points
     class Polygon
       attr_reader :vertices
 
@@ -22,9 +22,18 @@ module EasyGeometry
       end
 
       # Return True/False for cw/ccw orientation.
+      # 
+      # Parameters:
+      #   a, b, c - EasyGeometry::D2::Point or Array of Numeric(coordinates)
+      # 
       def self.is_right?(a, b, c)
+        a = Point.new(a[0], a[1]) if a.is_a?(Array)
         raise TypeError, 'Must pass only Point objects' unless a.is_a?(Point)
+
+        b = Point.new(b[0], b[1]) if b.is_a?(Array)
         raise TypeError, 'Must pass only Point objects' unless b.is_a?(Point)
+
+        c = Point.new(c[0], c[1]) if c.is_a?(Array)
         raise TypeError, 'Must pass only Point objects' unless c.is_a?(Point)
 
         ba = b - a
@@ -114,7 +123,7 @@ module EasyGeometry
       # rectangle for the geometric figure.
       # 
       # Returns:
-      #   array
+      #   Array of Numeric
       #
       def bounds
         return @bounds if defined?(@bounds)
@@ -135,10 +144,14 @@ module EasyGeometry
       #   False otherwise.
       # 
       def is_convex?
+        return @is_convex if defined?(@is_convex)
+
+        @is_convex = false
+
         cw = Polygon.is_right?(vertices[-2], vertices[-1], vertices[0])
         (1...vertices.length).each do |i|
           if cw ^ Polygon.is_right?(vertices[i - 2], vertices[i - 1], vertices[i])
-            return false
+            return @is_convex
           end
         end
 
@@ -153,19 +166,20 @@ module EasyGeometry
             sj = sides[j]
             if !points.include?(sj.p1) && !points.include?(sj.p2)
               hit = si.intersection(sj)
-              return false if !hit.empty?
+                return @is_convex if !hit.empty?
             end
           end
         end
                          
-        return true
+        @is_convex = !@is_convex
+        @is_convex
       end
 
       # Return True if p is enclosed by (is inside of) self, False otherwise.
       # Being on the border of self is considered False.
       # 
       # Parameters:
-      #   Point
+      #   Point or Array of Numeric(coordinates)
       # 
       # Returns:
       #   bool

data/lib/easy_geometry/d2/ray.rb

@@ -6,10 +6,10 @@ module EasyGeometry
       # Is other GeometryEntity contained in this Ray?
       # 
       # Parameters:
-      #   GeometryEntity
+      #   GeometryEntity or Array of Numeric(coordinates)
       # 
       # Returns:
-      #   true if `other` is on this Line.
+      #   true if `other` is on this Ray.
       #   false otherwise.
       # 
       def contains?(other)
@@ -39,10 +39,11 @@ module EasyGeometry
 
       # Finds the shortest distance between the ray and a point.
       # 
-      # Raises
-      #   ======
-      #   TypeError is raised if `other` is not a Point
+      # Parameters:
+      #   Point or Array of Numeric(coordinates)
+      # 
       def distance(other)
+        other = Point.new(other[0], other[1]) if other.is_a?(Array)
         raise TypeError, "Distance between Ray and #{ other.class } is not defined" unless other.is_a?(Point)
 
         return 0 if self.contains?(other)
@@ -56,6 +57,10 @@ module EasyGeometry
       end
 
       # Returns True if self and other are the same mathematical entities
+      # 
+      # Parameters:
+      #   GeometryEntity
+      # 
       def ==(other)
         return false unless other.is_a?(Ray)
         self.source == other.source && self.contains?(other.p2)
@@ -72,6 +77,7 @@ module EasyGeometry
       #     Positive infinity if the ray points in the positive x direction,
       #     negative infinity if the ray points in the negative x direction,
       #     or 0 if the ray is vertical.
+      #
       def xdirection
         return @xdirection if defined?(@xdirection)
 
@@ -91,7 +97,8 @@ module EasyGeometry
       # Returns:
       #     Positive infinity if the ray points in the positive y direction,
       #     negative infinity if the ray points in the negative y direction,
-      #     or 0 if the ray is vertical.
+      #     or 0 if the ray is horizontal.
+      #
       def ydirection
         return @ydirection if defined?(@ydirection)
 

data/lib/easy_geometry/d2/segment.rb

@@ -6,7 +6,7 @@ module EasyGeometry
       # Is the other GeometryEntity contained within this Segment?
       # 
       # Parameters:
-      #   GeometryEntity
+      #   GeometryEntity or Array of Numeric(coordinates)
       # 
       # Returns:
       #   true if `other` is in this Segment.
@@ -36,7 +36,11 @@ module EasyGeometry
         return false
       end
 
-      # Returns True if self and other are the same mathematical entities
+      # Returns True if self and other are the same mathematical entities.
+      # 
+      # Parameters:
+      #   GeometryEntity
+      # 
       def ==(other)
         return false unless other.is_a?(Segment)
         [p1, p2].sort_by {|p| [p.x, p.y]} == [other.p1, other.p2].sort_by {|p| [p.x, p.y]}
@@ -50,14 +54,11 @@ module EasyGeometry
       # Finds the shortest distance between a line segment and a point.
       # 
       # Parameters:
-      #   Point
+      #   Point or Array of Numeric(coordinates)
       # 
       # Returns:
       #   Number
       # 
-      # Raises
-      #   ======
-      #   TypeError is raised if `other` is not a Point
       def distance(other)
         other = Point.new(other[0], other[1]) if other.is_a?(Array)
         raise TypeError, "Distance between Segment and #{ other.class } is not defined" unless other.is_a?(Point)

data/lib/easy_geometry/d2/triangle.rb

@@ -47,6 +47,7 @@ module EasyGeometry
       end
 
       # Are two or more of the sides the same length?
+      # Precision - 10e-13
       # 
       # Returns:
       #   bool
@@ -56,6 +57,7 @@ module EasyGeometry
       end
 
       # Are all the sides of the triangle of different lengths?
+      # Precision - 10e-13
       # 
       # Returns:
       #   bool
@@ -120,12 +122,12 @@ module EasyGeometry
         @orthocenter
       end
 
-      # The circumcenter of the triangle
+      # The circumcenter of the triangle.
       # 
       # The circumcenter is the center of the circumcircle.
       # 
       # Returns:
-      #   Point or nil
+      #   Point
       # 
       def circumcenter
         return @circumcenter if defined?(@circumcenter)
@@ -139,7 +141,7 @@ module EasyGeometry
       # The radius of the circumcircle of the triangle.
       # 
       # Returns:
-      #   int
+      #   Numeric
       # 
       def circumradius
         @circumradius ||= self.vertices[0].distance(self.circumcenter)
@@ -206,7 +208,7 @@ module EasyGeometry
       # The radius of the incircle.
       # 
       # Returns:
-      #   int
+      #   Numeric
       #
       def inradius
         @inradius ||= 2 * self.area / self.perimeter
@@ -235,6 +237,7 @@ module EasyGeometry
       #
       def exradii
         return @exradii if defined?(@exradii)
+
         a = self.sides[0].length
         b = self.sides[1].length
         c = self.sides[2].length

data/lib/easy_geometry/d2/vector.rb

@@ -26,7 +26,7 @@ module EasyGeometry
       end
 
       # Returns a non-zero vector that is orthogonal to the
-      # line containing `self` and the origin.
+      # line containing self and the origin.
       def orthogonal_direction
         # if a coordinate is zero, we can put a 1 there and zeros elsewhere
         return Vector.new(1, 0) if x.zero?
@@ -38,7 +38,7 @@ module EasyGeometry
       end
 
       # It is positive if other vector should be turned counter-clockwise in order to superpose them.
-      # It is negetive if other vector should be turned clockwise in order to superpose them.
+      # It is negative if other vector should be turned clockwise in order to superpose them.
       # It is zero when vectors are collinear.
       def cross_product(other)
         raise TypeError, "Cross product between Vector and #{ other.class } is not defined" unless other.is_a?(Vector)
@@ -51,7 +51,7 @@ module EasyGeometry
         x * other.x + y * other.y
       end
 
-      # Converts the vector to a point
+      # Converts the vector to a point.
       def to_point
         Point.new(x, y)
       end

data/spec/d2/line_spec.rb

@@ -215,6 +215,7 @@ RSpec.describe EasyGeometry::D2::Line do
 
     it 'should return a parallel line' do
       expect(l3.parallel_line(p2).parallel_to?(l3)).to be true
+      expect(l3.parallel_line([1, 1]).parallel_to?(l3)).to be true
     end
   end
 
@@ -227,6 +228,7 @@ RSpec.describe EasyGeometry::D2::Line do
 
     it 'should return a perpendicular line' do
       expect(l3.perpendicular_line(p2).perpendicular_to?(l3)).to be true
+      expect(l3.perpendicular_line([1, 1]).perpendicular_to?(l3)).to be true
     end
   end
 
@@ -238,7 +240,8 @@ RSpec.describe EasyGeometry::D2::Line do
     end
 
     it 'should return the point if line contains this point' do
-      expect(l1.perpendicular_segment(p1)).to eq(p1) 
+      expect(l1.perpendicular_segment(p1)).to eq(p1)
+      expect(l1.perpendicular_segment([0, 0])).to eq(p1)
       expect(l2.perpendicular_segment(p1)).to eq(p1) 
       expect(l3.perpendicular_segment(p1)).to eq(p1) 
     end
@@ -265,6 +268,7 @@ RSpec.describe EasyGeometry::D2::Line do
 
     it 'should return correct number' do
       expect(l1.span_test(p1)).to eq(0)
+      expect(l1.span_test([0, 0])).to eq(0)
       expect(l1.span_test(p2)).to eq(1)
       expect(l1.span_test(EasyGeometry::D2::Point.new(-1, -1))).to eq(-1)
     end
@@ -273,6 +277,7 @@ RSpec.describe EasyGeometry::D2::Line do
   describe '#contains?' do
     it 'should return true' do
       expect(l1.contains?(p1)).to be true
+      expect(l1.contains?([0, 0])).to be true
       expect(l1.contains?(p2)).to be true
       expect(l1.contains?(EasyGeometry::D2::Point.new(100, 100))).to be true
       expect(l1.contains?(EasyGeometry::D2::Segment.new(
@@ -305,7 +310,8 @@ RSpec.describe EasyGeometry::D2::Line do
     end
 
     it 'should return zero if line contains point' do
-      expect(l1.distance(p1)).to eq(0) 
+      expect(l1.distance(p1)).to eq(0)
+      expect(l1.distance([0, 0])).to eq(0) 
       expect(l1.distance(p2)).to eq(0) 
       expect(l2.distance(p1)).to eq(0) 
       expect(l3.distance(p1)).to eq(0) 

data/spec/d2/polygon_spec.rb

@@ -51,6 +51,7 @@ RSpec.describe EasyGeometry::D2::Polygon do
 
     it 'should return true' do
       expect(described_class.is_right?(p1, p2, p3)).to be true
+      expect(described_class.is_right?([0, 0], [1, 1], [1, 0])).to be true
     end
 
     it 'should return false' do
@@ -265,8 +266,6 @@ RSpec.describe EasyGeometry::D2::Polygon do
     let(:polygon4) { described_class.new([1, 1], [6/5r, 1], [1, 6/5r]) }
     let(:polygon5) { described_class.new([0, 0], [4, 4], [0, 4]) }
 
-
-
     it 'should raise TypeError' do
       expect{ poly1.distance(l1) }.to raise_error(TypeError)
       expect{ poly1.distance("") }.to raise_error(TypeError)

data/spec/d2/ray_spec.rb

@@ -392,7 +392,7 @@ RSpec.describe EasyGeometry::D2::Ray do
     end
 
     it 'should return correct number' do
-      expect(r1.distance(EasyGeometry::D2::Point.new(-1, -1))).to eq(Math.sqrt(2))
+      expect(r1.distance([-1, -1])).to eq(Math.sqrt(2))
       expect(r1.distance(EasyGeometry::D2::Point.new(-1, 1))).to eq(Math.sqrt(2))
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_geometry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Henry Metlov
@@ -34,7 +34,8 @@ files:
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
-- README
+- LICENSE
+- README.md
 - easy_geometry.gemspec
 - lib/.ruby-version
 - lib/easy_geometry.rb

data/README

@@ -1,2 +0,0 @@
-# Tests
-## rspec spec/d2/polygon_spec.rb --format doc