geometry 6.4 → 6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2071223ccd3ab40dc84675595b6b204aa0d7df10
-  data.tar.gz: ed6b83fe034a5734ca9938c7ab54f4a4fcdda736
+SHA256:
+  metadata.gz: 18aa25c45e739b77377ac376b9575f9828e2eb0566b4349a073be5b4deeea20e
+  data.tar.gz: 1ddbf89f0ad3854c222ffd344c0eaedd129d315ec9b1488f503f519dc8b5ca5b
 SHA512:
-  metadata.gz: d78e31275dd418edf77a9067157213b63690bb7139ccf8c8561b228bb51e7be9e8b72e3a9187f02beb8d77ddc95427f882454f49c4827196f832acadec131e3c
-  data.tar.gz: ba61dfc2b8d83090d59fe4d5348d3b184edeca188bf59c604d6888644a7392b943f8979ac4ea82392b1d8a026b53873128bab58c64702af149c3be68c1852057
+  metadata.gz: 69645a43932bb7b4c36a6401daabf49d2bbcbf3450f750f85d1c2f60f8d1e7944cb0f1c5110569912bc10d656f3ef8a1f5ffaa80ee9eb228a8a8f7855aaed0c8
+  data.tar.gz: 8e68aa085655950d9f499a887cf9ec0aeaac2c183e53a242675105f093652fdcb141aae4cc91226bedadf97e0dd94651b25956026c78c4a98e60b57d7b232dfa

data/.github/workflows/ruby.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+        os: [ubuntu-latest]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - run: bundle exec rake

data/Gemfile

@@ -3,5 +3,8 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
+    gem 'minitest'
     gem 'rake'
 end
+
+gem "matrix", "~> 0.4.2"

data/README.markdown

@@ -1,7 +1,6 @@
 Geometry for Ruby
 =================
 
-[![Build Status](https://travis-ci.org/bfoz/geometry.png)](https://travis-ci.org/bfoz/geometry)
 [![Gem Version](https://badge.fury.io/rb/geometry.svg)](http://badge.fury.io/rb/geometry)
 
 Classes and methods for the handling of all of the basic geometry that you 
@@ -15,7 +14,7 @@ that don't work in higher dimensions and I'll do my best to fix them.
 License
 -------
 
-Copyright 2012-2014 Brandon Fosdick <bfoz@bfoz.net> and released under the BSD license.
+Copyright 2012-2024 Brandon Fosdick <bfoz@bfoz.net> and released under the BSD license.
 
 Primitives
 ----------

data/geometry.gemspec

@@ -2,8 +2,9 @@
 $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
+    spec = s
   s.name        = "geometry"
-  s.version     = '6.4'
+    spec.version	= '6.6'
   s.authors     = ["Brandon Fosdick"]
   s.email       = ["bfoz@bfoz.net"]
   s.homepage    = "http://github.com/bfoz/geometry"
@@ -18,4 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.required_ruby_version = '>= 2.0'
+
+    spec.add_development_dependency "bundler", "~> 2"
+    spec.add_development_dependency "rake", "~> 13"
 end

data/lib/geometry/annulus.rb

@@ -22,7 +22,7 @@ known as a Ring, is a circle that ate another circle.
 	# @!attribute inner_radius
 	#   @return [Number]  the radius of the inside of the {Annulus}
 	def inner_radius
-	    @inner_radius || (@inner_diameter && @inner_diameter/2)
+	    @inner_radius || (@inner_diameter && @inner_diameter.to_r/2)
 	end
 
 	# @!attribute outer_diameter
@@ -34,7 +34,7 @@ known as a Ring, is a circle that ate another circle.
 	# @!attribute outer_radius
 	#   @return [Number]  the outer radius
 	def outer_radius
-	    @outer_radius || (@outer_diameter && @outer_diameter/2)
+	    @outer_radius || ((@outer_diameter && @outer_diameter).to_r/2)
 	end
 
 	# @!attribute diameter
@@ -66,6 +66,24 @@ known as a Ring, is a circle that ate another circle.
 	    @outer_diameter = options[:outer_diameter] || options[:diameter]
 	    @outer_radius = options[:outer_radius] || options[:radius]
 	end
+
+	# @!attribute	max
+	# @return [Point]   The upper right corner of the bounding {Rectangle}
+	def max
+	    @center+radius
+	end
+
+	# @!attribute	min
+	# @return [Point]   The lower left corner of the bounding {Rectangle}
+	def min
+	    @center-radius
+	end
+
+	# @!attribute	minmax
+	# @return [Array<Point>]    The lower left and upper right corners of the bounding {Rectangle}
+	def minmax
+	    [self.min, self.max]
+	end
     end
 
     # Ring is an alias of Annulus because that's the word that most people use,

data/lib/geometry/arc.rb

@@ -17,8 +17,15 @@ An {Arc} with its center at [1,1] and a radius of 2 that starts at the X-axis an
 	include ClusterFactory
 
 	attr_reader :center
+
+	# @return [Number]  the radius of the {Arc}
 	attr_reader :radius
-	attr_reader :start_angle, :end_angle
+
+	# @return [Number]  the starting angle of the {Arc} as radians from the x-axis
+	attr_reader :start_angle
+
+	# @return [Number]  the ending angle of the {Arc} as radians from the x-axis
+	attr_reader :end_angle
 
 	# @overload new(center, start, end)
 	#  Create a new {Arc} given center, start and end {Point}s
@@ -90,5 +97,69 @@ An {Arc} with its center at [1,1] and a radius of 2 that starts at the X-axis an
 	# The end point of the {Arc}
 	# @return [Point]
 	alias :last :end
+
+	def ==(other)
+	    if other.is_a?(ThreePointArc)
+		(self.center == other.center) && (self.end == other.end) && (self.start == other.start)
+	    else
+		super other
+	    end
+	end
+
+    # @group Attributes
+
+	# @return [Point]   The upper-right corner of the bounding rectangle that encloses the {Path}
+	def max
+	    minmax.last
+	end
+
+	# @return [Point]   The lower-left corner of the bounding rectangle that encloses the {Path}
+	def min
+	    minmax.first
+	end
+
+	# @return [Array<Point>]    The lower-left and upper-right corners of the enclosing bounding rectangle
+	def minmax
+	    a = [self.start, self.end]
+	    quadrants = a.map(&:quadrant)
+
+	    # If the Arc spans more than one quadrant, then it must cross at
+	    #  least one axis. Each axis-crossing is a potential extrema.
+	    if quadrants.first != quadrants.last
+		range = (quadrants.first...quadrants.last)
+		# If the Arc crosses the X axis...
+		if quadrants.first > quadrants.last
+		    range = (quadrants.first..4).to_a + (1...quadrants.last).to_a
+		end
+
+		a = range.map do |q|
+		    case q
+			when 1 then self.center + Point[0,radius]
+			when 2 then self.center + Point[-radius, 0]
+			when 3 then self.center + Point[0,-radius]
+			when 4 then self.center + Point[radius,0]
+		    end
+		end.push(*a)
+		a.reduce([a.first, a.first]) {|memo, e| [memo.first.min(e), memo.last.max(e)] }
+	    else
+		[a.first.min(a.last), a.first.max(a.last)]
+	    end
+	end
+
+	def end_angle
+	    a = (self.end - self.center)
+	    Math.atan2(a.y, a.x)
+	end
+
+	def radius
+	    (self.start - self.center).magnitude
+	end
+
+	def start_angle
+	    a = (self.start - self.center)
+	    Math.atan2(a.y, a.x)
+	end
+
+    # @endgroup
     end
 end

data/lib/geometry/edge.rb

@@ -1,5 +1,3 @@
-require 'mathn'
-
 require_relative 'point'
 
 module Geometry
@@ -42,6 +40,25 @@ An edge. It's a line segment between 2 points. Generally part of a {Polygon}.
 	    end
 	end
 
+    # @group Attributes
+
+	# @return [Point]   The upper-right corner of the bounding rectangle that encloses the {Edge}
+	def max
+	    first.max(last)
+	end
+
+	# @return [Point]   The lower-left corner of the bounding rectangle that encloses the {Edge}
+	def min
+	    first.min(last)
+	end
+
+	# @return [Array<Point>]    The lower-left and upper-right corners of the enclosing bounding rectangle
+	def minmax
+	    first.minmax(last)
+	end
+
+    # @endgroup
+
 	# Return a new {Edge} with swapped endpoints
 	def reverse
 	    self.class.new(@last, @first)
@@ -128,8 +145,8 @@ An edge. It's a line segment between 2 points. Generally part of a {Polygon}.
 		    nil
 		end
 	    else
-		s = (-v1[1] * p.x + v1[0] * p.y) / denominator	# v1 x (p0 - p2) / denominator
-		t = ( v2[0] * p.y - v2[1] * p.x) / denominator	# v2 x (p0 - p2) / denominator
+		s = (-v1[1] * p.x + v1[0] * p.y).to_r / denominator	# v1 x (p0 - p2) / denominator
+		t = ( v2[0] * p.y - v2[1] * p.x).to_r / denominator	# v2 x (p0 - p2) / denominator
 
 		p0 + v1 * t if ((0..1) === s) && ((0..1) === t)
 	    end

data/lib/geometry/line.rb

@@ -31,6 +31,15 @@ Supports two-point, slope-intercept, and point-slope initializer forms
     class Line
 	include ClusterFactory
 
+	# @!attribute [r] horizontal?
+	#   @return [Boolean]	true if the slope is zero
+
+	# @!attribute [r] slope
+	#   @return [Number]	the slope of the {Line}
+
+	# @!attribute [r] vertical?
+	#   @return [Boolean]	true if the slope is infinite
+
 	# @overload [](Array, Array)
 	#   @return [TwoPointLine]
 	# @overload [](Point, Point)
@@ -85,15 +94,34 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	end
     end
 
+    module SlopedLine
+	# @!attribute slope
+	#   @return [Number]  the slope of the {Line}
+	attr_reader :slope
+
+	# @!attribute horizontal?
+	#   @return [Boolean]  true if the slope is zero
+	def horizontal?
+	    slope.zero?
+	end
+
+	# @!attribute vertical?
+	#   @return [Boolean]  true if the slope is infinite
+	def vertical?
+	    slope.infinite? != nil
+	rescue	# Non-Float's don't have an infinite? method
+	    false
+	end
+    end
+
     # @private
     class PointSlopeLine < Line
+	include SlopedLine
+
 	# @!attribute point
 	#   @return [Point]  the stating point
 	attr_reader :point
 
-	# @return [Number]  the slope of the {Line}
-	attr_reader :slope
-
 	# @param point	[Point]	    a {Point} that lies on the {Line}
 	# @param slope	[Number]    the slope of the {Line}
 	def initialize(point, slope)
@@ -126,12 +154,23 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	def to_s
 	    'Line(' + @slope.to_s + ',' + @point.to_s + ')'
 	end
+
+	# Find the requested axis intercept
+	# @param axis	[Symbol]    the axis to intercept (either :x or :y)
+	# @return [Number]  the location of the intercept
+	def intercept(axis=:y)
+	    case axis
+		when :x
+		    vertical? ? point.x : (horizontal? ? nil : (slope * point.x - point.y))
+		when :y
+		    vertical? ? nil : (horizontal? ? point.y : (point.y - slope * point.x))
+	    end
+	end
     end
 
     # @private
     class SlopeInterceptLine < Line
-	# @return [Number]  the slope of the {Line}
-	attr_reader :slope
+	include SlopedLine
 
 	# @param slope	    [Number]    the slope
 	# @param intercept  [Number]	the location of the y-axis intercept
@@ -151,7 +190,7 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 		    ((other.first.y == slope * other.first.x + intercept)) && (other.last.y == (slope * other.last.x + intercept))
 		else
 		    self.eql? other
-		end
+	    end
 	end
 
 	# Two {SlopeInterceptLine}s are equal if both have equal slopes and intercepts
@@ -160,13 +199,9 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	    (intercept == other.intercept) && (slope == other.slope)
 	end
 
-	def horizontal?
-	    0 == @slope
-	end
-	def vertical?
-	    (1/0.0) == @slope
-	end
-
+	# Find the requested axis intercept
+	# @param axis	[Symbol]    the axis to intercept (either :x or :y)
+	# @return [Number]  the location of the intercept
 	def intercept(axis=:y)
 	    case axis
 		when :x
@@ -183,11 +218,21 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 
     # @private
     class TwoPointLine < Line
-	attr_reader :first, :last
-
-	def initialize(point0, point1)
-	    @first, @last = [Point[point0], Point[point1]]
+	# @!attribute first
+	#   @return [Point]  the {Line}'s starting point
+	attr_reader :first
+
+	# @!attribute last
+	#   @return [Point]  the {Line}'s end point
+	attr_reader :last
+
+	# @param first	[Point]	the starting point
+	# @param last	[Point]	the end point
+	def initialize(first, last)
+	    @first = Point[first]
+	    @last = Point[last]
 	end
+
 	def inspect
 	    'Line(' + @first.inspect + ', ' + @last.inspect + ')'
 	end
@@ -206,7 +251,7 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 		    ((first.y == other.slope * first.x + other.intercept)) && (last.y == (other.slope * last.x + other.intercept))
 		else
 		    self.eql?(other) || ((first == other.last) && (last == other.first))
-		end
+	    end
 	end
 
 	# Two {TwoPointLine}s are equal if both have equal endpoints
@@ -221,6 +266,27 @@ Supports two-point, slope-intercept, and point-slope initializer forms
 	def slope
 	    (last.y - first.y)/(last.x - first.x)
 	end
+
+	def horizontal?
+	    first.y == last.y
+	end
+
+	def vertical?
+	    first.x == last.x
+	end
+
+	# Find the requested axis intercept
+	# @param axis	[Symbol]    the axis to intercept (either :x or :y)
+	# @return [Number]  the location of the intercept
+	def intercept(axis=:y)
+	    case axis
+		when :x
+		    vertical? ? first.x : (horizontal? ? nil : (first.x - first.y/slope))
+		when :y
+		    vertical? ? nil : (horizontal? ? first.y : (first.y - slope * first.x))
+	    end
+	end
+
 # @endgroup
     end
 end

data/lib/geometry/obround.rb

@@ -180,8 +180,6 @@ The {Obround} class cluster represents a rectangle with semicircular end caps
     end
 
     class SizedObround < Obround
-	# @return [Point]   The {Obround}'s center
-	attr_reader :center
 	# @return [Point]	The {Obround}'s origin
 	attr_accessor :origin
 	# @return [Size]	The {Size} of the {Obround}
@@ -219,6 +217,7 @@ The {Obround} class cluster represents a rectangle with semicircular end caps
 	alias :== :eql?
 
 # @group Accessors
+	# @return [Point]   The {Obround}'s center
 	def center
 	    @origin + @size/2
 	end

data/lib/geometry/path.rb

@@ -52,11 +52,38 @@ An object representing a set of connected elements, each of which could be an
 	    end
 	end
 
+	def ==(other)
+	    if other.is_a?(Path)
+		@elements == other.elements
+	    else
+		super other
+	    end
+	end
+
+    # @group Attributes
+
+	# @return [Point]   The upper-right corner of the bounding rectangle that encloses the {Path}
+	def max
+	    elements.reduce(elements.first.max) {|memo, e| memo.max(e.max) }
+	end
+
+	# @return [Point]   The lower-left corner of the bounding rectangle that encloses the {Path}
+	def min
+	    elements.reduce(elements.first.min) {|memo, e| memo.min(e.max) }
+	end
+
+	# @return [Array<Point>]    The lower-left and upper-right corners of the enclosing bounding rectangle
+	def minmax
+	    elements.reduce(elements.first.minmax) {|memo, e| [memo.first.min(e.min), memo.last.max(e.max)] }
+	end
+
 	# @return [Geometry]	The last element in the {Path}
 	def last
 	    @elements.last
 	end
 
+    # @endgroup
+
 	# Append a new geometry element to the {Path}
 	# @return [Path]
 	def push(arg)

data/lib/geometry/point.rb

@@ -21,8 +21,6 @@ geometry class (x, y, z).
     point = Geometry::Point[x,y]
 =end
     class Point < Vector
-	attr_reader :x, :y, :z
-
 	# Allow vector-style initialization, but override to support copy-init
 	# from Vector or another Point
 	#
@@ -34,15 +32,15 @@ geometry class (x, y, z).
 	    return array[0] if array[0].is_a?(Point)
 	    array = array[0] if array[0].is_a?(Array)
 	    array = array[0].to_a if array[0].is_a?(Vector)
-	    super *array
+	    super(*array)
 	end
 
-	# Creates and returns a new {PointIso} instance. Or, a {Point} full of ones if the size argument is given.
+	# Creates and returns a new {PointIso} instance. Or, a {Point} full of the given value if the size argument is given.
 	# @param value [Number]	the value of the elements
 	# @param size [Number] the size of the new {Point} full of ones
 	# @return [PointIso] A new {PointIso} instance
 	def self.iso(value, size=nil)
-	    size ? Point[Array.new(size, 1)] : PointIso.new(value)
+	    size ? Point[Array.new(size, value)] : PointIso.new(value)
 	end
 
 	# Creates and returns a new {PointOne} instance. Or, a {Point} full of ones if the size argument is given.
@@ -119,6 +117,8 @@ geometry class (x, y, z).
 	    'Point' + @elements.to_s
 	end
 
+    # @group Attributes
+
 	# @override max()
 	# @return [Number]  The maximum value of the {Point}'s elements
 	# @override max(point)
@@ -128,7 +128,13 @@ geometry class (x, y, z).
 		@elements.max
 	    else
 		args = args.first if 1 == args.size
-		self.class[@elements.zip(args).map(&:max)]
+		case args
+		    when PointIso   then    self.class[@elements.map {|e| [e, args.value].max }]
+		    when PointOne   then    self.class[@elements.map {|e| [e, 1].max }]
+		    when PointZero  then    self.class[@elements.map {|e| [e, 0].max }]
+		    else
+			self.class[@elements.zip(args).map(&:max)]
+		end
 	    end
 	end
 
@@ -141,7 +147,13 @@ geometry class (x, y, z).
 		@elements.min
 	    else
 		args = args.first if 1 == args.size
-		self.class[@elements.zip(args).map(&:min)]
+		case args
+		    when PointIso   then    self.class[@elements.map {|e| [e, args.value].min }]
+		    when PointOne   then    self.class[@elements.map {|e| [e, 1].min }]
+		    when PointZero  then    self.class[@elements.map {|e| [e, 0].min }]
+		    else
+			self.class[@elements.zip(args).map(&:min)]
+		end
 	    end
 	end
 
@@ -157,6 +169,46 @@ geometry class (x, y, z).
 	    end
 	end
 
+	# Return the {Point}'s quadrant in the 2D Cartesian Euclidean Plane
+	# https://en.wikipedia.org/wiki/Quadrant_(plane_geometry)
+	# @note Undefined for all points on the axes, and for dimensionalities other than 2
+	# @todo Define the results for points on the axes
+	# @return [Bool]    The {Point}'s quadrant in the 2D Cartesian Euclidean Plane
+	def quadrant
+	    return nil unless elements[1]
+	    if elements.first > 0
+		(elements[1] > 0) ? 1 : 4
+	    else
+		(elements[1] > 0) ? 2 : 3
+	    end
+	end
+
+    # @endgroup
+
+	# Returns a new {Point} with the given number of elements removed from the end
+	# @return [Point]   the popped elements
+	def pop(count=1)
+	    self.class[to_a.pop(count)]
+	end
+
+	# Returns a new {Point} with the given elements appended
+	# @return [Point]
+	def push(*args)
+	    self.class[to_a.push(*args)]
+	end
+
+	# Removes the first element and returns it
+	# @return [Point]   the shifted elements
+	def shift(count=1)
+	    self.class[to_a.shift(count)]
+	end
+
+	# Prepend the given objects and return a new {Point}
+	# @return [Point]
+	def unshift(*args)
+	    self.class[to_a.unshift(*args)]
+	end
+
 # @group Accessors
 	# @param [Integer]  i	Index into the {Point}'s elements
 	# @return [Numeric] Element i (starting at 0)
@@ -262,4 +314,3 @@ geometry class (x, y, z).
 
     end
 end
-

data/lib/geometry/point_iso.rb

@@ -1,5 +1,3 @@
-require_relative 'point'
-
 module Geometry
 =begin rdoc
 An object repesenting a N-dimensional {Point} with identical elements.
@@ -91,6 +89,18 @@ An object repesenting a N-dimensional {Point} with identical elements.
 	    end
 	end
 
+	# Returns a new {Point} with the given number of elements removed from the end
+	# @return [Point]   the popped elements
+	def pop(count=1)
+	    Point[Array.new(count, @value)]
+	end
+
+	# Removes the first element and returns it
+	# @return [Point]   the shifted elements
+	def shift(count=1)
+	    Point[Array.new(count, @value)]
+	end
+
 # @group Accessors
 	# @param i [Integer]	Index into the {Point}'s elements
 	# @return [Numeric] Element i (starting at 0)