cossincalc 1.0.6 → 1.0.7

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Molte Emil Strange Andersen
+Copyright (c) 2010-2011 Molte Emil Strange Andersen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -0,0 +1,112 @@
+CosSinCalc
+==========
+
+CosSinCalc is a [web application](http://cossincalc.com/) able to calculate the variables of a triangle and even draw it for you!
+
+This is an offline version of the calculator available as a Ruby gem.
+You can use the included command line utility to generate a PDF page containing all the results, formulae and a drawing of the triangle, *or* you can include it as a library in your Ruby application and use just the features you care about.
+
+The main features are:
+
+*   Calculating the missing variables of the triangle
+*   Calculating additional variables (ie. altitudes, medians, angle bisectors, area, circumference)
+*   Generating an SVG or PNG (via [ImageMagick](http://www.imagemagick.org/)) drawing of the triangle
+*   Generating a LaTeX or PDF (via `pdflatex`) document containing the calculations, the steps performed and a drawing.
+
+Usage
+-----
+
+For instructions on how to use the command line utility, please run `cossincalc --help` after installation.
+
+Basic usage through an `irb` console:
+
+    >> require 'rubygems'
+    => true
+    >> require 'cossincalc'
+    => true
+    
+    # Pass the known side and angle values to the initialization method as two
+    # hashes. The valid keys (variable names) are :a, :b and :c.
+    # It is important that you provide the values as strings as they wouldn't
+    # be parsed and converted properly, otherwise.
+    >> triangle = CosSinCalc::Triangle.new({ :a => "3.0", :c => "5" }, { :c => "90" })
+    => #<CosSinCalc::Triangle:0x25058e8>
+    
+    >> triangle.calculate!
+    => true
+    
+    # Fetch angle A, but in radians and unrounded.
+    >> triangle.angle(:a)
+    => 0.643501108793284
+    
+    # Fetch angle A in degrees and rounded.
+    >> triangle.humanize.angle(:a)
+    => "36.87"
+    
+    # Change the output precision.
+    >> triangle.humanize(3).angle(:a)
+    => "36.870"
+    
+    # Fetch another variable (side b).
+    >> triangle.humanize.side(:b)
+    => "4.00"
+    
+    # There are many available variables:
+    # altitude(:c), median(:a), angle_bisector(:a), area(), circumference()
+
+### Change angle unit ###
+The default unit used for angles is degrees, however both radians and gon may be used.
+
+    >> triangle = CosSinCalc::Triangle.new({ :a => "3.0", :c => "5" }, { :c => (Math::PI/2).to_s, :unit => :radian })
+    => #<CosSinCalc::Triangle:0x25058e8>
+    
+    >> triangle = CosSinCalc::Triangle.new({ :a => "3.0", :c => "5" }, { :c => "100", :unit => :gon })
+    => #<CosSinCalc::Triangle:0x25058e8>
+
+Note that no unit is used for side values as it doesn't matter to the calculation.
+
+### Generate an SVG or PNG drawing ###
+    >> triangle = ...; triangle.calculate!
+    => true
+    
+    # Save an SVG version of the drawing by initializing a new Drawing
+    # instance and passing the name of the file to be created to the save_svg
+    # method.
+    >> CosSinCalc::Triangle::Drawing.new(triangle.humanize).save_svg('my-vector-drawing')
+    => true
+    
+    # Save a PNG version of the drawing by initializing a new Drawing
+    # instance and passing the name of the file to be created to the save_png
+    # method.
+    # In fact, an SVG file is created first and then converted to a PNG image
+    # by ImageMagick. Make sure to have ImageMagick installed if you want to
+    # use this feature.
+    >> CosSinCalc::Triangle::Drawing.new(triangle.humanize).save_png('my-png-drawing')
+    => true
+
+### Generate a PDF document ###
+    >> triangle = ...; triangle.calculate!
+    => true
+    
+    # Pass the wanted filename to the save_pdf method of the Latex instance.
+    # Make sure to have a LaTeX distribution installed (as well as the
+    # amsmath, amsfonts and graphicx packages) if you want to make use
+    # of this feature.
+    >> CosSinCalc::Triangle::Formatter::Latex.new(triangle.humanize).save_pdf('my-result-document')
+    => true
+
+Installation
+------------
+
+To install it as a Ruby gem, please run
+
+    gem install cossincalc
+
+In order for this to work, you must have [Ruby](http://www.ruby-lang.org/) and [RubyGems](http://rubygems.org) installed.
+
+- - -
+
+Feature requests, ideas, questions etc. is recieved at <http://getsatisfaction.com/cossincalc>.  
+Bugs should be submitted to the [issue tracker](http://github.com/molte/cossincalc_offline/issues).
+
+Copyright (c) 2010-2011 Molte Emil Strange Andersen, released under the MIT license.

data/lib/cossincalc/triangle/calculator.rb

@@ -29,8 +29,9 @@ module CosSinCalc
       end
       
       private
-      def each(*args, &block)
-        @triangle.each(*args, &block)
+      # Returns the first variable in the given array and the rest of the variables separately.
+      def first(vars)
+        return vars.first, rest(vars.first)
       end
       
       def sq(value)
@@ -39,73 +40,54 @@ module CosSinCalc
       
       # Calculates all three angles when all three sides are known.
       def calculate_three_angles
-        each do |v, r|
-          unless angle(v)
-            angle[v] = calculate_angle_by_sides(v, r)
-            equation('@1=\arccos\left(\frac{$2^2+$3^2-$1^2}{2 * $2 * $3}\right)', v, *r)
-          end
+        each(angles.unknown) do |v, r|
+          angle[v] = calculate_angle_by_sides(v, r)
+          equation('@1=\arccos\left(\frac{$2^2+$3^2-$1^2}{2 * $2 * $3}\right)', v, *r)
         end
       end
       
       # Calculates two unknown angles when two sides and one angle are known.
       def calculate_two_angles
-        each do |v, r|
-          if angle(v)
-            unless side(v)
-              side[v] = sqrt sq(sides(r)).inject(&:+) -
-                2 * sides(r).inject(&:*) * cos(angle(v))
-              equation('$1=\sqrt{$2^2+$3^2-2 * $2 * $3 * \cos(@1)}', v, *r)
-              calculate_three_angles
-              break
-            end
-            
-            each(r) do |v2|
-              if side(v2)
-                angle[v2] = asin sin(angle(v)) * side(v2) / side(v)
-                equation('@2=\arcsin\left(\frac{\sin(@1) * $2}{$1}\right)', v, v2)
-                
-                if ambiguous_case?(v, v2)
-                  @alt = CosSinCalc::Triangle.new(sides, angles, self)
-                  @alt.angle[v2] = PI - angle(v2)
-                  @alt.equation('@2=@pi-\arcsin\left(\frac{\sin(@1) * $2}{$1}\right)', v, v2)
-                  @alt.calculate_side_and_angle
-                end
-                
-                calculate_two_sides
-                break
-              end
-            end
-            break
-          end
+        v, r = first(angles.known)
+        
+        unless side(v)
+          side[v] = sqrt sq(sides(r)).inject(&:+) -
+            2 * sides(r).inject(&:*) * cos(angle(v))
+          equation('$1=\sqrt{$2^2+$3^2-2 * $2 * $3 * \cos(@1)}', v, *r)
+          calculate_three_angles
+          return
+        end
+        
+        v2, r2 = first sides.known(r)
+        angle[v2] = asin sin(angle(v)) * side(v2) / side(v)
+        equation('@2=\arcsin\left(\frac{\sin(@1) * $2}{$1}\right)', v, v2)
+        
+        if ambiguous_case?(v, v2)
+          @alt = CosSinCalc::Triangle.new(sides, angles, self)
+          @alt.angle[v2] = PI - angle(v2)
+          @alt.equation('@2=@pi-\arcsin\left(\frac{\sin(@1) * $2}{$1}\right)', v, v2)
+          @alt.calculate_side_and_angle
         end
+        
+        calculate_two_sides
       end
       
       # Calculates up to two unknown sides when at least one side and two angles are known.
       def calculate_two_sides
         calculate_last_angle
-        
-        each do |v, r|
-          if side(v)
-            each(r) do |v2|
-              unless side(v2)
-                side[v2] = sin(angle(v2)) * side(v) / sin(angle(v))
-                equation('$2=\frac{\sin(@2) * $1}{\sin(@1)}', v, v2)
-              end
-            end
-            break
-          end
+        v, r = first(sides.known)
+
+        each sides.unknown(r) do |v2|
+          side[v2] = sin(angle(v2)) * side(v) / sin(angle(v))
+          equation('$2=\frac{\sin(@2) * $1}{\sin(@1)}', v, v2)
         end
       end
       
       # Calculates the last unknown angle.
       def calculate_last_angle
-        each do |v, r|
-          unless angle(v)
-            angle[v] = PI - angles(r).inject(&:+)
-            equation('@1=@pi-@2-@3', v, *r)
-            break
-          end
-        end
+        v, r = first(angles.unknown)
+        angle[v] = PI - angles(r).inject(&:+)
+        equation('@1=@pi-@2-@3', v, *r)
       end
       
       # Calculates and returns whether the triangle has multiple solutions.

data/lib/cossincalc/triangle/variable_hash.rb

@@ -19,6 +19,16 @@ module CosSinCalc
       def amount
         self.values.compact.size
       end
+      
+      # Returns an array of variables whose values are known.
+      def known(vars = CosSinCalc::Triangle::VARIABLES)
+        vars.reject { |v| !self[v] }
+      end
+      
+      # Returns an array of variables whose values are unknown.
+      def unknown(vars = CosSinCalc::Triangle::VARIABLES)
+        vars.reject { |v| self[v] }
+      end
     end
   end
 end

data/lib/cossincalc/triangle.rb

@@ -54,8 +54,8 @@ module CosSinCalc
     # Returns the length of the line which starts at the corner and is perpendicular with the opposite side.
     def altitude(v)
       require_calculation
-      r = rest(v)
-      Math.sin(angle(r[0])) * side(r[1])
+      r1, r2 = *rest(v)
+      Math.sin(angle(r1)) * side(r2)
     end
     
     # Returns the length of the line going from the corner to the middle of the opposite side.
@@ -67,14 +67,15 @@ module CosSinCalc
     # Returns the length of the line between a corner and the opposite side which bisects the angle at the corner.
     def angle_bisector(v)
       require_calculation
-      r = rest(v)
-      Math.sin(angle(r[0])) * side(r[1]) / Math.sin(angle(r[1]) + angle(v) / 2)
+      r1, r2 = *rest(v)
+      Math.sin(angle(r1)) * side(r2) / Math.sin(angle(r2) + angle(v) / 2)
     end
     
     # Returns the area of the triangle.
     def area
       require_calculation
-      side(VARIABLES[0]) * side(VARIABLES[1]) * Math.sin(angle(VARIABLES[2])) / 2
+      v1, v2, v3 = *VARIABLES
+      side(v1) * side(v2) * Math.sin(angle(v3)) / 2
     end
     
     # Returns the circumference of the triangle.

data/lib/cossincalc/version.rb

@@ -1,3 +1,3 @@
 module CosSinCalc
-  VERSION = "1.0.6"
+  VERSION = "1.0.7"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cossincalc
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Molte Emil Strange Andersen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-14 00:00:00 +01:00
+date: 2011-04-20 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.markdown
 - MIT-LICENSE
 - Rakefile
 - lib/core_ext.rb
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Triangle calculator