symmetry_axis 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70556ef99614ea62c841ad75365fa26624e3df95
-  data.tar.gz: f4c84a985efa555eab3412a7fa59d79897b3a3bf
+  metadata.gz: 7ac00b6ca3f12a6cf9ff5f8f34ef6e440bbc8e6d
+  data.tar.gz: 0da763b5764c2e3098aabce450ce456f1074f31d
 SHA512:
-  metadata.gz: 96a80e0db01959db3a6009c66c41065eda379be0caffe82f543b064542ca061bf85945e99967d59cf4d26f7d12c9154e70d8c714e856eba5c3692f5c957ed6ec
-  data.tar.gz: 8657f232c02798b274f3bdf79b251b477db057906a286f8e85783441fd122351c7aacf7d2f18d25921a8c96e7453d32b09f37999f9c90e998ec4372a89cc088d
+  metadata.gz: 4bad29fbf34ede0252c1db5ec83af74531e3aa1ea9c8c32ab723c287095ea0f0faf26215443cd88480e861e17ab73a4a401ca60db1e2e924b9bb5655771383fd
+  data.tar.gz: cabbcf950fb5891d326775907f34c86c1193dea00f94f0da442175a6420c77b8327af5d05861aa975a718b746f0832d867478b92615f43e895c9e845bcb434e9

data/lib/symmetry_axis/line.rb

@@ -1,3 +1,7 @@
+# Every line here defined by the coefficients of the equation:
+#     y = a + bx
+# But this equation can not describe vertical lines (infinite +b+).
+# So the vertical lines are defined by +x+.
 class Line
   attr_reader :a, :b, :x
   EPS, TOO_BIG_B = 0.000001, 100_000_000
@@ -11,6 +15,8 @@ class Line
     end
   end
 
+  # Shorthand for constructor.
+  # @return [Line]
   def self.for_points(p1, p2)
     Line.new(p1[0], p1[1], p2[0], p2[1])
   end
@@ -19,30 +25,41 @@ class Line
     self.class.aeq(self, other) && self.class.beq(self, other)
   end
 
+  # @return [String]
   def to_s
-    if !vertical
+    if !vertical?
       "(a=#{@a}, b=#{@b})"
     else
       "(x=#{@x})"
     end
   end
 
-  def vertical
+  # Is the line strictly vertical. This line could be created from
+  # almost vertical pair of points (+b+ coefficient was just Too Big).
+  #
+  # If +true+, you cannot use +a+ and +b+ fields
+  # (you can read +x+ field instead).
+  def vertical?
     @vertical = (nil == @b) || (TOO_BIG_B <= @b.abs) if nil == @vertical
     @vertical
   end
 
+  # Zero means three o'clock, +pi/2+ means noon.
+  # @return [Float]
   def angle_rad
-    return (Math::PI / 2) if vertical
+    return (Math::PI / 2) if vertical?
     Math.atan(@b)
   end
 
+  # Zero means three o'clock, 90 means noon.
+  # @return [Float]
   def angle_degrees
     angle_rad / Math::PI * 180
   end
 
-  def on_me(x, y)
-    if vertical
+  # Does the point lie on the line.
+  def on_me?(x, y)
+    if vertical?
       (@x - x).abs < EPS
     else
       f = @a + @b * x
@@ -57,10 +74,14 @@ class Line
     e
   end
 
+  # Symmetry line of two points.
+  # The perpendicular line drawn through the center
+  # of the line segment between the points.
+  # @return [Line]
   def self.symmetryof(x1, y1, x2, y2)
     line = Line.new(x1, y1, x2, y2)
     x, y = (x1 + x2) / 2, (y1 + y2) / 2
-    if line.vertical
+    if line.vertical?
       Line.new(0, y, 1, y)
     else
       r = line.angle_rad + (Math::PI / 2)
@@ -69,11 +90,15 @@ class Line
     end
   end
 
+  # Draw a parallel line through the point.
+  # @return [Line]
   def parallel(x, y)
-    return Line.new(x, y, x, y + 1) if vertical
+    return Line.new(x, y, x, y + 1) if vertical?
     Line.new(x, y, x + 1, y + @b)
   end
 
+  private :on_me_eps
+
   private
 
   def resolve_coefs(xmin, yxmin, xmax, yxmax)
@@ -83,7 +108,7 @@ class Line
       @b = (yxmax - yxmin) / Float(xmax - xmin)
       @a = yxmin - @b * xmin
     end
-    @x, @a = xmin, 0 if vertical
+    @x, @a = xmin, 0 if vertical?
   end
 
   def self.aeq(o1, o2)
@@ -91,8 +116,8 @@ class Line
   end
 
   def self.beq(o1, o2)
-    if o1.vertical || o2.vertical
-      return false unless o1.vertical && o2.vertical
+    if o1.vertical? || o2.vertical?
+      return false unless o1.vertical? && o2.vertical?
       (o1.x - o2.x).abs < (2 * EPS)
     else
       (o1.b - o2.b).abs < (2 * EPS)

data/lib/symmetry_axis.rb

@@ -1,13 +1,18 @@
+# The algorithm, based on principle, every point have a pair.
+# It uses the first got point and iterates over +(N - 1)+ 
+# other points to find a line,
+# all points lie by twos on lines parallel to.
+# The perpendicular line to this line is the symmetry axis.
 class SymmetryAxis
   attr_reader :line
 
   def initialize(point_array)
     @input = point_array
+    return if @input.size.odd?
     @impossible_angles = []
     @two_points_cursor = 1
-    @s1counter, @s2counter, @s2loopcounter = 0, 0, 0
     loop do
-      take_two_points # step 1
+      return unless take_two_points # step 1
       break if points_are_on_parallel_lines # step 2
     end
     find_axis # step 3
@@ -16,15 +21,14 @@ class SymmetryAxis
   private
 
   def take_two_points
-    @s1counter += 1
     @two_points = [@input.first]
     (@two_points_cursor...(@input.size)).each do |i|
       rad = Line.for_points(@two_points[0], @input[i]).angle_rad
       next if impossible?(rad)
       choose_point i
-      return
+      return true
     end
-    fail 'There is no suitable pair of points.'
+    false
   end
 
   def choose_point(i)
@@ -40,15 +44,17 @@ class SymmetryAxis
   end
 
   def points_are_on_parallel_lines
-    @s2counter += 1
-    points = @input.select { |p| !@two_points.include?(p) }
-    @perpendicular_points_pairs_list = [@two_points.dup]
+    other_points = @input.select { |p| !@two_points.include?(p) }
+    @axis_perpendicular_points = @two_points.dup
+    check_perpendiculars(other_points)
+  end
+
+  def check_perpendiculars(points)
     loop do
       break if points.empty?
-      @s2loopcounter += 1
       line = @two_points_line.parallel(*points.first)
       size0 = points.size
-      on_line = points.select { |p2| line.on_me(*p2) }
+      on_line = points.select { |p2| line.on_me?(*p2) }
       points -= on_line
       return false if size0 - points.size < 2
       save_perpendicular_points(on_line, line)
@@ -59,11 +65,11 @@ class SymmetryAxis
   def save_perpendicular_points(points, line)
     return if line != @two_points_line
     points += @two_points
-    @perpendicular_points_pairs_list[0] = pppair(points, line)
+    @axis_perpendicular_points = pppair(points, line)
   end
 
   def pppair(points, line)
-    if line.vertical
+    if line.vertical?
       [points.min_by { |p| p[1] }, points.max_by { |p| p[1] }]
     else
       [points.min_by { |p| p[0] }, points.max_by { |p| p[0] }]
@@ -71,9 +77,7 @@ class SymmetryAxis
   end
 
   def find_axis
-    # puts "\n   Iterations:\n    Step1 = #{@s1counter}\n    Step2 = #{@s2counter}\n    Step2Loop = #{@s2loopcounter}"
-    points = @perpendicular_points_pairs_list[0]
-    p1, p2 = points[0], points[1]
+    p1, p2 = *@axis_perpendicular_points
     @line = Line.symmetryof(p1[0], p1[1], p2[0], p2[1])
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: symmetry_axis
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - "Георгий Устинов"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-28 00:00:00.000000000 Z
+date: 2015-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Symmetry axis from a point list. It has the restriction: no points must
   be on axis. Thus every point must have a pair. You can separately use the Line class
   from the gem. It allows you to compare for equality the lines, defined by different
@@ -74,3 +88,4 @@ signing_key:
 specification_version: 4
 summary: Symmetry axis from a point list.
 test_files: []
+has_rdoc: