geometry 4 → 5

data/lib/geometry/rectangle.rb

@@ -1,3 +1,4 @@
+require_relative 'cluster_factory'
 require_relative 'edge'
 require_relative 'point'
 require_relative 'size'
@@ -19,6 +20,8 @@ The {Rectangle} class cluster represents your typical arrangement of 4 corners a
 =end
 
     class Rectangle
+	include ClusterFactory
+
 	# @return [Point]   The {Rectangle}'s center
 	attr_reader :center
 	# @return [Number]  Height of the {Rectangle}
@@ -30,10 +33,6 @@ The {Rectangle} class cluster represents your typical arrangement of 4 corners a
 	# @return [Number]  Width of the {Rectangle}
 	attr_reader :width
 
-	class << self
-	    alias :original_new :new
-	end
-
 	# @overload new(width, height)
 	#   Creates a {Rectangle} of the given width and height, centered on the origin
 	#   @param [Number]   height  Height
@@ -151,10 +150,6 @@ The {Rectangle} class cluster represents your typical arrangement of 4 corners a
 	# @return [Size]	The {Size} of the {Rectangle}
 	attr_accessor :size
 
-	def self.new(*args)
-	    original_new(*args)
-	end
-
 	# @overload new(width, height)
 	#   Creates a {Rectangle} of the given width and height, centered on the origin
 	#   @param [Number]   height  Height
@@ -220,10 +215,6 @@ The {Rectangle} class cluster represents your typical arrangement of 4 corners a
 	# @return [Size]	The {Size} of the {Rectangle}
 	attr_accessor :size
 
-	def self.new(*args)
-	    original_new(*args)
-	end
-
 	# @overload new(width, height)
 	#   Creates a {Rectangle} of the given width and height with its origin at [0,0]
 	#   @param [Number]   height  Height

data/lib/geometry/rotation.rb

@@ -1,9 +1,11 @@
+require 'matrix'
+
 module Geometry
 =begin
 A generalized representation of a rotation transformation.
 =end
     class Rotation
-	# !@attribute [r] dimensions
+	# @attribute [r] dimensions
 	# @return [Integer]
 	attr_reader :dimensions
 	attr_reader :x, :y, :z
@@ -34,13 +36,38 @@ A generalized representation of a rotation transformation.
 
 		raise ArgumentError, "Dimensionality mismatch" unless all_axes_options.first.size <= @dimensions
 		if all_axes_options.first.size < @dimensions
-		    @x, @y, @z = [@x, @y, @z].map {|a| (a && (a.size < @dimensions)) ? Array.new(@dimensions) {|i| a[i] || 0 } : a }
+		    @x, @y, @z = [@x, @y, @z].map {|a| (a && (a.size != 0) && (a.size < @dimensions)) ? Array.new(@dimensions) {|i| a[i] || 0 } : a }
 		end
+
+		raise ArgumentError, "Too many axes specified (expected #{@dimensions - 1} but got #{all_axes_options.size}" unless all_axes_options.size == (@dimensions - 1)
 	    end
 	end
 
 	def identity?
 	    (!@x && !@y && !@z) || ([@x, @y, @z].select {|a| a}.all? {|a| a.respond_to?(:magnitude) ? (1 == a.magnitude) : (1 == a.size)})
 	end
+
+	# @attribute [r] matrix
+	# @return [Matrix]
+	def matrix
+	    # Force all axes to be Vectors
+	    x,y,z = [@x, @y, @z].map {|a| a.is_a?(Array) ? Vector[*a] : a}
+
+	    # Force all axes to exist
+	    if x and y
+		z = x ** y
+	    elsif x and z
+		y = x ** z
+	    elsif y and z
+		x = y ** z
+	    end
+
+	    rows = []
+	    [x, y, z].each_with_index {|a, i| rows.push(a.to_a) if i < @dimensions }
+
+	    raise ArgumentError, "Number of axes must match the dimensions of each axis" unless @dimensions == rows.size
+
+	    Matrix[*rows]
+	end
     end
 end

data/lib/geometry/size_zero.rb

@@ -29,9 +29,9 @@ everything else, regardless of dimensionality.
 	    end
 	end
 
-# !@group Arithmetic
+# @group Arithmetic
 
-# !@group Unary operators
+# @group Unary operators
 	def +@
 	    self
 	end
@@ -39,7 +39,7 @@ everything else, regardless of dimensionality.
 	def -@
 	    self
 	end
-# !@endgroup
+# @endgroup
 
 	def +(other)
 	    other
@@ -62,7 +62,7 @@ everything else, regardless of dimensionality.
 	    raise ZeroDivisionError if 0 == other
 	    self
 	end
-# !@endgroup
+# @endgroup
 
     end
 end

data/lib/geometry/square.rb

@@ -31,7 +31,7 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 	end
 
 # !@group Accessors
-	# !@attribute [r] origin
+	# @attribute [r] origin
 	# @return [Point] The lower left corner
 	def origin
 	    @points.first
@@ -46,12 +46,12 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 	    min, max = @points.minmax {|a,b| a.x <=> b.x}
 	    max.x - min.x
 	end
-# !@endgroup
+# @endgroup
     end
 
     # A {Square} created with a center point and a size
     class CenteredSquare < Square
-	# !@attribute [r] center
+	# @attribute [r] center
 	# @return [Point]   The center of the {Square}
 	attr_reader :center
 
@@ -62,14 +62,14 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 	    @size = size
 	end
 
-# !@group Accessors
-	# !@attribute [r] origin
+# @group Accessors
+	# @attribute [r] origin
 	# @return [Point] The lower left corner
 	def origin
 	    Point[@center.x - size/2, @center.y - size/2]
 	end
 
-	# !@attribute [r] points
+	# @attribute [r] points
 	# @return [Array<Point>]    The {Square}'s four points (clockwise)
 	def points
 	    half_size = @size/2
@@ -88,7 +88,7 @@ The {Square} class cluster is like the {Rectangle} class cluster, but not longer
 	def width
 	    @size
 	end
-# !@endgroup
+# @endgroup
     end
 
     # A {Square} created with an origin point and a size

data/lib/geometry/triangle.rb

@@ -0,0 +1,78 @@
+require_relative 'cluster_factory'
+require_relative 'point'
+
+module Geometry
+=begin rdoc
+A {http://en.wikipedia.org/wiki/Triangle Triangle} is not a square.
+
+== Usage
+A right {Triangle} with its right angle at the origin and sides of length 1
+    triangle = Geometry::Triangle.new [0,0], [1,0], [0,1]
+
+An isoscoles right {Triangle} created with an origin and leg length
+    triangle = Geometry::Triangle.new [0,0], 1
+=end
+
+    # @abstract Factory class that instantiates the appropriate subclasses
+    class Triangle
+
+	include ClusterFactory
+
+	# @overload new(point0, point1, point2)
+	#   Contruct a {ScaleneTriangle} using three {Point}s
+	#   @param [Point] point0   The first vertex of the {Triangle}
+	#   @param [Point] point1   Another vertex of the {Triangle}
+	#   @param [Point] point2   The final vertex of the {Triangle}
+	# @overload new(point, length)
+	#   Construct a {RightTriangle} using a {Point} and the lengths of the sides
+	#   @param [Point] point    The location of the vertex at {Triangle}'s right angle
+	#   @param [Number] base    The length of the {Triangle}'s base leg
+	#   @param [Number] height  The length of the {Triangle}'s vertical leg
+	def self.new(*args)
+	     if args.size == 3
+		ScaleneTriangle.new *args
+	     elsif args.size == 2
+		RightTriangle.new args[0], args[1], args[1]
+	     end
+	end
+    end
+
+    # {http://en.wikipedia.org/wiki/Equilateral_triangle Equilateral Triangle}
+    class EquilateralTriangle < Triangle
+	def self.new(*args)
+	    original_new(*args)
+	end
+    end
+
+    class IsoscelesTriangle < Triangle
+	def self.new(*args)
+	    original_new(*args)
+	end
+    end
+
+    # {http://en.wikipedia.org/wiki/Right_triangle Right Triangle}
+    class RightTriangle < Triangle
+	attr_reader :origin, :base, :height
+
+	# Construct a Right Triangle given a {Point} and the leg lengths
+	def initialize(origin, base, height)
+	    @origin = Point[origin]
+	    @base, @height = base, height
+	end
+
+	# An array of points corresponding to the vertices of the {Triangle} (clockwise)
+	# @return [Array<Point>]    Vertices
+	def points
+	    [@origin, @origin + Point[0,@height], @origin + Point[@base,0]]
+	end
+    end
+
+    class ScaleneTriangle < Triangle
+	attr_reader :points
+
+	# Construct a scalene {Triangle}
+	def initialize(point0, point1, point2)
+	    @points = [point0, point1, point2].map {|p| Point[p] }
+	end
+    end
+end

data/lib/geometry/vector.rb

@@ -2,7 +2,7 @@ require 'matrix'
 
 # Monkeypatch Vector to overcome some deficiencies
 class Vector
-# !@group Unary operators
+# @group Unary operators
     def +@
 	self
     end
@@ -10,5 +10,21 @@ class Vector
     def -@
 	Vector[*(@elements.map {|e| -e })]
     end
-# !@endgroup
+# @endgroup
+
+    # Cross-product of two {Vector}s
+    # @return [Vector]
+    def cross(other)
+	Vector.Raise ErrDimensionMismatch unless @elements.size == other.size
+	
+	case @elements.size
+	    when 0 then raise ArgumentError, "Can't multply zero-length Vectors"
+	    when 1 then @elements.first * other.first
+	    when 2 then @elements.first * other[1] - @elements.last * other.first
+	    when 3 then Vector[ @elements[1]*other[2] - @elements[2]*other[1],
+				@elements[2]*other[0] - @elements[0]*other[2],
+				@elements[0]*other[1] - @elements[1]*other[0]]
+	end
+    end
+    alias ** cross
 end

data/test/geometry/arc.rb

@@ -10,4 +10,13 @@ describe Geometry::Arc do
 	arc.start_angle.must_equal 0
 	arc.end_angle.must_equal 90
     end
+
+    it "must create an Arc from center, start and end points" do
+	arc = Geometry::Arc.new [1,2], [3,4], [5,6]
+	arc.must_be_kind_of Geometry::Arc
+	arc.center.must_equal Point[1,2]
+	arc.first.must_equal Point[3,4]
+	arc.last.must_equal Point[5,6]
+    end
+
 end

data/test/geometry/circle.rb

@@ -1,23 +1,59 @@
 require 'minitest/autorun'
 require 'geometry/circle'
 
-def Circle(*args)
-    Geometry::Circle.new(*args)
-end
-
 describe Geometry::Circle do
-    it "must create a Circle object from a Point and a radius" do
-	circle = Circle [1,2], 3
-	assert_kind_of(Geometry::Circle, circle)
+    Circle = Geometry::Circle
+
+    describe "when constructed with center and radius arguments" do
+	let(:circle) { Circle.new [1,2], 3 }
+
+	it "must create a Circle" do
+	    circle.must_be_instance_of(Circle)
+	end
+	
+	it "must have a center point accessor" do
+	    circle.center.must_equal Point[1,2]
+	end
+	
+	it "must have a radius accessor" do
+	    circle.radius.must_equal 3
+	end
     end
 
-    it "must have a center point accessor" do
-	circle = Circle [1,2], 3
-	assert_equal(circle.center, [1,2])
+    describe "when constructed with named center and radius arguments" do
+	let(:circle) { Circle.new :center => [1,2], :radius => 3 }
+	
+	it "must create a Circle" do
+	    circle.must_be_instance_of(Circle)
+	end
+	
+	it "must have a center point accessor" do
+	    circle.center.must_equal Point[1,2]
+	end
+	
+	it "must have a radius accessor" do
+	    circle.radius.must_equal 3
+	end
     end
 
-    it "must have a radius accessor" do
-	circle = Circle [1,2], 3
-	assert_equal(3, circle.radius)
+    describe "when constructed with a center and diameter" do
+	let(:circle) { Circle.new [1,2], :diameter => 4 }
+
+	it "must be a CenterDiameterCircle" do
+	    circle.must_be_instance_of(Geometry::CenterDiameterCircle)
+	    circle.must_be_kind_of(Circle)
+	end
+
+	it "must have a center" do
+	    circle.center.must_equal Point[1,2]
+	end
+
+	it "must have a diameter" do
+	    circle.diameter.must_equal 4
+	end
+
+	it "must calculate the correct radius" do
+	    circle.radius.must_equal 2
+	end
     end
 end

data/test/geometry/edge.rb

@@ -38,4 +38,57 @@ describe Geometry::Edge do
 	edge = Edge([0,0], [1,1])
 	assert_equal(1, edge.width)
     end
+
+    it "must convert an Edge to a Vector" do
+	Edge.new([0,0], [1,0]).vector.must_equal Vector[1,0]
+    end
+
+    it "must return the normalized direction of a vector" do
+	Edge.new([0,0], [1,0]).direction.must_equal Vector[1,0]
+    end
+
+    it "must return true for parallel edges" do
+	Edge.new([0,0], [1,0]).parallel?(Edge.new([0,0], [1,0])).must_equal 1
+	Edge.new([0,0], [1,0]).parallel?(Edge.new([1,0], [2,0])).must_equal 1
+	Edge.new([0,0], [1,0]).parallel?(Edge.new([3,0], [4,0])).must_equal 1
+	Edge.new([0,0], [1,0]).parallel?(Edge.new([3,1], [4,1])).must_equal 1
+    end
+
+    it "must return false for non-parallel edges" do
+	Edge.new([0,0], [2,0]).parallel?(Edge.new([1,-1], [1,1])).must_equal false
+    end
+
+    describe "when finding an intersection" do
+	it "must find the intersection of two end-intersecting Edges" do
+	    intersection = Edge.new([0,0],[1,1]).intersection(Edge.new([0,1],[1,1]))
+	    intersection.must_be_kind_of Geometry::Point
+	    intersection.must_equal Geometry::Point[1,1]
+	end
+
+	it "must find the itersection of two crossed Edges" do
+	    edge1 = Edge.new [0.0, 0], [2.0, 2.0]
+	    edge2 = Edge.new [2.0, 0], [0.0, 2.0]
+	    intersection = edge1.intersection edge2
+	    intersection.must_be_kind_of Geometry::Point
+	    intersection.must_equal Geometry::Point[1,1]
+	end
+
+	it "must return nil for two edges that do not intersect" do
+	    Edge.new([0,0],[1,0]).intersection(Edge.new([0,1],[1,1])).must_equal nil
+	end
+
+	it "must return true for two collinear and overlapping edges" do
+	    Edge.new([0,0],[2,0]).intersection(Edge.new([1,0],[3,0])).must_equal true
+	end
+
+	it "must return false for collinear but non-overlapping edges" do
+	    Edge.new([0,0],[2,0]).intersection(Edge.new([3,0],[4,0])).must_equal false
+	    Edge.new([0,0],[0,2]).intersection(Edge.new([0,3],[0,4])).must_equal false
+	end
+
+	it "must return nil for two parallel but not collinear edges" do
+	    Edge.new([0,0],[2,0]).intersection(Edge.new([1,1],[3,1])).must_equal nil
+	end
+
+    end
 end

data/test/geometry/path.rb

@@ -0,0 +1,67 @@
+require 'minitest/autorun'
+require 'geometry/path'
+
+describe Geometry::Path do
+    describe "construction" do
+	it "must create a Path with no arguments" do
+	    path = Geometry::Path.new
+	    path.must_be_kind_of Geometry::Path
+	    path.elements.wont_be_nil
+	    path.elements.size.must_equal 0
+	end
+
+	it "must create a Path from Points" do
+	    path = Geometry::Path.new Point[1,1], Point[2,2], Point[3,3]
+	    path.elements.size.must_equal 2
+	    path.elements.each {|a| a.must_be_kind_of Geometry::Edge }
+	end
+
+	it "with connected Edges" do
+	    path = Geometry::Path.new Edge.new([1,1], [2,2]), Edge.new([2,2], [3,3])
+	    path.elements.size.must_equal 2
+	    path.elements.each {|a| a.must_be_kind_of Geometry::Edge }
+	end
+
+	it "with disjoint Edges" do
+	    path = Geometry::Path.new Edge.new([1,1], [2,2]), Edge.new([3,3], [4,4])
+	    path.elements.size.must_equal 3
+	    path.elements.each {|a| a.must_be_kind_of Geometry::Edge }
+	end
+
+	it "with Points and Arcs" do
+	    path = Geometry::Path.new [0,0], [1.0,0.0], Geometry::Arc.new([1,1], 1, -90*Math::PI/180, 0), [2.0,1.0], [1,2]
+	    path.elements.size.must_equal 3
+	    path.elements[0].must_be_kind_of Geometry::Edge
+	    path.elements[1].must_be_kind_of Geometry::Arc
+	    path.elements[2].must_be_kind_of Geometry::Edge
+	end
+
+	it "with Edges and Arcs" do
+	    path = Geometry::Path.new Edge.new([0,0], [1.0,0.0]), Geometry::Arc.new([1,1], 1, -90*Math::PI/180, 0), Edge.new([2.0,1.0], [1,2])
+	    path.elements.size.must_equal 3
+	    path.elements[0].must_be_kind_of Geometry::Edge
+	    path.elements[1].must_be_kind_of Geometry::Arc
+	    path.elements[2].must_be_kind_of Geometry::Edge
+	end
+
+	it "with disjoint Edges and Arcs" do
+	    path = Geometry::Path.new Edge.new([0,0], [1,0]), Geometry::Arc.new([2,1], 1, -90*Math::PI/180, 0), Edge.new([3,1], [1,2])
+	    path.elements.size.must_equal 4
+	    path.elements[0].must_be_kind_of Geometry::Edge
+	    path.elements[1].must_be_kind_of Geometry::Edge
+	    path.elements[2].must_be_kind_of Geometry::Arc
+	    path.elements[3].must_be_kind_of Geometry::Edge
+	end
+
+	it "with disjoint Arcs" do
+	    path = Geometry::Path.new Geometry::Arc.new([2,1], 1, -90*Math::PI/180, 0), Geometry::Arc.new([3,1], 1, -90*Math::PI/180, 0)
+	    path.elements.size.must_equal 3
+	    path.elements[0].must_be_kind_of Geometry::Arc
+	    path.elements[1].must_be_kind_of Geometry::Edge
+	    path.elements[2].must_be_kind_of Geometry::Arc
+
+	    path.elements[0].last.must_equal path.elements[1].first
+	end
+
+    end
+end