beziercurve 0.6 → 0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27e5be3280b88a9b7f105e9684bb3e92fad3ed9c
-  data.tar.gz: a2ec45dfe488b6deb17073ca90c140d5a2acdf10
+  metadata.gz: c7550491650757d1ef4313a11191cb788974cae7
+  data.tar.gz: 66f165775867bf78cec4db74658de8b7a9bce86c
 SHA512:
-  metadata.gz: 3344ae1275b60c6fb196efcd50f0cc30e8aafc07de95a075b4e8b6509c12577dbadc805caf6aee60d82440f1dd4c8b3017c71e4b1d0e4a7f99040d8e55f80a22
-  data.tar.gz: 65a9f4e29b4d02cb99facde883c9e5a1f5c98f650ef4cb2b610bfe3aee288e15d849ff2a78bfb879c6366ac62003d8e88ad091c0aa163e1c182e98715fed488b
+  metadata.gz: a03fad9c836c26f020f3f5b5e859f9f5268b411cc5583d7022e7cf89f975cfedd16611f3cf20736451fa3d23f2ccb1a308ccf1367cdf3d4d3a50631545bc1464
+  data.tar.gz: a84249c4189caac7f6f80d93dceebab5e29e1a0068e3d6e6ddd370e7e3d491361085703ea70fcafb059ffdd1c8120b3b7aa1520bb33fdd7afc2e75b3323181c4

data/lib/beziercurve.rb

@@ -1,3 +1,4 @@
+# Curve == series of ControlPoints
 module Bezier
 
 	class ControlPoint
@@ -15,31 +16,50 @@ module Bezier
 		def inspect
 			return @x, @y
 		end
-		def to_curve
+		# @return [CurvePoint] Returns a ControlPoint, converted to CurvePoint (only naming differences).
+		def to_curvepoint
 			CurvePoint.new(self.x, self.y)
 		end
+		def to_a
+			[self.x, self.y]
+		end
 	end
+	
 	class CurvePoint < ControlPoint
-		# @return [ControlPoint] the object converted into the expected format.
-		def to_control
+		# @return [ControlPoint] point coordinates on the Bézier curve.
+		def to_controlpoint
 			ControlPoint.new(self.x, self.y)
 		end
 	end
+
 	class Curve
+		# returns hull control points
 		attr_accessor :controlpoints
 
+		# @param controlpoints [Array<ControlPoints, Array(Fixnum, Fixnum)>] list of ControlPoints defining the hull for the Bézier curve. A point can be of class ControlPoint or an Array containig 2 Fixnums, which will be converted to ControlPoint.
+		# @return [Curve] a Bézier curve object
+		# @example
+		#    initialize(p1, p2, p3)
+		#    initialize(p1, [20, 30], p3)
 		def initialize(*controlpoints)
 			# need at least 3 control points
-			if controlpoints.length < 3
-				raise 'Cannot create Bézier curve with less than 3 control points'
+			# this constraint has to be lifted, to allow adding Curves together like a 1 point curve to a 3 point curve
+			if controlpoints.size < 3
+				raise ArgumentError, 'Cannot create Bézier curve with less than 3 control points'
 			end
 
-			# check for proper types
-			if controlpoints.find {|p| p.class != ControlPoint} == nil
-				@controlpoints = controlpoints
-			end
+			@controlpoints = controlpoints.map { |e|
+				if e.class == Array
+					ControlPoint.new(*e[0..1]) # make sure ControlPoint.new gets no more than 2 arguments. 'e' should contain at least 2 elements here
+				elsif e.class == ControlPoint
+					e
+				else
+					raise 'Control points should be type of ControlPoint or Array'
+				end
+			  }
 		end
 
+		# @param point [ControlPoint] addition
 		def add(point)
 			if point.class == ControlPoint
 				@controlpoints << point
@@ -48,9 +68,10 @@ module Bezier
 			end
 		end
 
+		# @param t [CurvePoint] 
 		def point_on_curve(t)
 
-			def point_on_hull(point1, point2, t) # making this local
+			def point_on_hull(point1, point2, t) # making this method local
 				if (point1.class != ControlPoint) or (point2.class != ControlPoint)
 					raise TypeError, 'Both points should be type of ControlPoint'
 				end
@@ -59,7 +80,7 @@ module Bezier
 				return ControlPoint.new(new_x, new_y)
 			end
 
-			# imperatively ugly but works, refactor later. point_on_curve and point_on_hull should be one method
+			# imperatively ugly, but works, refactor later. point_on_curve and point_on_hull should be one method
 			ary = @controlpoints
 			return ary if ary.length <= 1 # zero or one element as argument, return unmodified
 
@@ -71,10 +92,41 @@ module Bezier
 				end
 				ary = temp
 			end
-			return temp[0].to_curve
+			return temp[0].to_curvepoint
+		end
+
+		def pascaltriangle(nth_line)
+			# @param n [Fixnum] Ye' olde factorial function
+			# @todo this is slow, should be rewritten
+			# @return [Array] an array of the specified line from the Pascal triangle
+			# @example
+			#   > fact(5)
+			#   > 
+			def fact(n)
+				(1..n).reduce(:*)
+			end
+
+			# @param n [Fixnum]
+			# @param k [Fixnum]
+			def binomial(n,k)
+				return 1 if n-k <= 0
+				return 1 if k <= 0
+				fact(n) / ( fact(k) * fact( n - k ) )
+			end
+			(0..nth_line).map { |e| binomial(nth_line, e) }
 		end
 
-		def display_points # just a helper, for quickly put CotrolPOints to STDOUT in a gnuplottable format
+		def point_on_curve_binom(t)
+
+			# locally scoped, we don't need it outside of point_on_curve_binom
+
+			coeffs = pascaltriangle(self.order)
+			coeffs.reduce { |memo, obj| 
+				memo += t**obj * (1-t)** (n - obj) 
+			}
+		end
+
+		def display_points # just a helper, for quickly put ControlPoints to STDOUT in a gnuplottable format
 			@controlpoints.map{|point| puts "#{point.x} #{point.y}"}
 		end
 
@@ -85,14 +137,15 @@ module Bezier
 	    		loop do
 	      			yielder.yield(number)
 	      			point_position += delta_t.to_f
-	      			raise StopIteration if point_position > 1
+	      			raise StopIteration if point_position > 1.0
 	      			number = point_on_curve(point_position)
 	    		end
 	  		end
 		end
 
 		def order
-			@controlpoints.length
+			@controlpoints.size
 		end
 	end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beziercurve
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.8'
 platform: ruby
 authors:
 - Földes László
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies: []
 description: Creates a Bézier curve by its control points. Implemented with de Casteljau
   method.
@@ -28,17 +28,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Create and analyze Bézier curves