fraction 0.1 → 0.2

data/README.md

@@ -0,0 +1,45 @@
+For a [cooking website][3] I recently worked on, 
+I needed to display decimal floating point numbers as fractions. I needed to 
+come up with the fraction closest to what the user typed. For example, 0.33 
+should resolve to ⅓. When I googled for a solution, most of the code I found 
+was slow, buggy, and worst of all, too precise (returning 33/100 for the above example.)
+
+I decided to widen my search to C, and [found][1] a piece of code on Stack Overflow 
+written by David Eppstein in 1993. 
+It uses the [theory of continued fractions][2] to approach the correct value, 
+but stops when the denominator reaches some value. The limitation of such an 
+algorithm is that we can't choose to leave out unnatural denominators 
+
+So became `fraction`: it's Eppstein's code in a Ruby gem.
+
+Install it with `gem`:
+
+    gem install fraction
+
+Using this gem is easy:
+
+    require 'fraction'
+    num, den = 0.33.fraction   # num==1, den==3
+
+You can also get the error
+
+    num,den,err = 0.33.fraction   #=> [1, 3, -0.0033333333333333]
+
+you can choose a different maximum denominator than the default value of 10:
+ 
+    num, den = 0.51.fraction(100) #[51, 100, 0.0]
+
+
+The best part of this gem over others is the speed:
+
+    % ruby test.rb 
+    I'm Feeling Lucky: 19.145s
+    'fraction' gem: 2.090s
+
+subtracting the time required for an empty ruby loop, we can conclude the 
+algorithm itself requires only ½ of a second for 1,000,000 iterations on my Mac Pro.
+
+
+[1]: http://stackoverflow.com/questions/95727/how-to-convert-floats-to-human-readable-fractions
+[2]: http://www.maths.surrey.ac.uk/hosted-sites/R.Knott/Fibonacci/cfINTRO.html#termdecs
+[3]: http://freshslowcooking.com

data/fraction.c

@@ -6,7 +6,7 @@
 **
 ** Made into a ruby module by Christopher Lord, Nov 2009
 **
-** usage: require 'findfract'
+** usage: require 'fraction'
 **
 **        n,d,err = 0.33.fraction
 **
@@ -24,10 +24,12 @@
 
 #include "ruby.h"
 #include <stdio.h>
+
+
 VALUE method_html_form_for(VALUE self)
 {
    VALUE res = rb_str_new2("<span class='fraction'><span class='above'>");
-   // This is an array. to make a string form, we want to 
+   // This is an array. to make a string form, we want to
    VALUE num = rb_obj_as_string(rb_ary_entry(self, 0));
    VALUE den = rb_obj_as_string(rb_ary_entry(self, 1));
    rb_str_concat(res, rb_obj_as_string(num));
@@ -39,19 +41,23 @@ VALUE method_html_form_for(VALUE self)
    //                  font-family: Verdana, Arial, sans-serif; }
    // .above { vertical-align: 0.7ex; }
    // .below { vertical-align: -0.3ex; }
-   return res;   
+   return res;
 }
+
+
 VALUE method_string_form_for(VALUE self)
 {
    VALUE res = rb_str_new2("");
-   // This is an array. to make a string form, we want to 
+   // This is an array. to make a string form, we want to
    VALUE num = rb_obj_as_string(rb_ary_entry(self, 0));
    VALUE den = rb_obj_as_string(rb_ary_entry(self, 1));
    rb_str_concat(res, rb_obj_as_string(num));
    rb_str_cat2(res, "/");
    rb_str_concat(res, rb_obj_as_string(den));
-   return res;   
+   return res;
 }
+
+
 VALUE method_fraction_for(int argc, VALUE * argv, VALUE self)
 {
    long m11, m12,
@@ -86,10 +92,10 @@ VALUE method_fraction_for(int argc, VALUE * argv, VALUE self)
    rb_ary_store(res, 0, numer1);
    rb_ary_store(res, 1, denom1);
    rb_ary_store(res, 2, err1);
+// Although the below is very cool, it's also quite slow to execute.
   // rb_define_singleton_method(res, "to_s", method_string_form_for, 0);
   // rb_define_singleton_method(res, "to_html", method_html_form_for, 0);
 
-
    /* We can go one more step to find another candidate:
       m11 = m11 * ai + m12;
       m21 = m21 * ai + m22;
@@ -98,8 +104,64 @@ VALUE method_fraction_for(int argc, VALUE * argv, VALUE self)
    return res;
 }
 
+
+/// Same as above, but implements whole fraction simplification.
+/// the return value is: h, n, d, e = 3.5.whole_fraction
+VALUE method_whole_fraction_for(int argc, VALUE * argv, VALUE self)
+{
+   long m11, m12,
+        m21, m22;
+   VALUE res = rb_ary_new2(4);
+   VALUE maxdenr;
+   int maxden = 10; // the default
+   rb_scan_args(argc, argv, "01", &maxdenr);
+   if (!NIL_P(maxdenr))
+     maxden = NUM2INT(maxdenr);
+   int ai;
+   double x = NUM2DBL(self);
+   double startx = x;
+   m11 = m22 = 1;
+   m12 = m21 = 0;
+
+   // loop finding terms until denom gets too big
+   while (m21 *  ( ai = (long)x ) + m22 <= maxden) {
+      long t = m11 * ai + m12;
+      m12 = m11;
+      m11 = t;
+      t = m21 * ai + m22;
+      m22 = m21;
+      m21 = t;
+      if(x==(double)ai) break;
+      x = 1/(x - (double) ai);
+      if(x>(double)0x7FFFFFFF) break;
+   }
+   VALUE wholen = INT2NUM(m11 / m21);
+   VALUE numer1 = INT2NUM(m11 % m21);
+   VALUE denom1 = INT2NUM(m21);
+   VALUE err1 = rb_float_new(startx - ((double) m11 / (double) m21));
+
+   rb_ary_store(res, 0, wholen);
+   rb_ary_store(res, 1, numer1);
+   rb_ary_store(res, 2, denom1);
+   rb_ary_store(res, 3, err1);
+   return res;
+}
+
+
 void Init_fraction() {
+
+   rb_define_method(rb_cNumeric, "to_whole_fraction", method_whole_fraction_for, -1);
+   rb_define_method(rb_cFloat,   "to_whole_fraction", method_whole_fraction_for, -1);
+
+   rb_define_method(rb_cNumeric, "to_fraction", method_fraction_for, -1);
+   rb_define_method(rb_cFloat,   "to_fraction", method_fraction_for, -1);
+
+   // The following are legacy support methods. they are named a bit badly
    rb_define_method(rb_cNumeric, "fraction", method_fraction_for, -1);
    rb_define_method(rb_cFloat,   "fraction", method_fraction_for, -1);
+
+   rb_define_method(rb_cNumeric, "whole_fraction", method_whole_fraction_for, -1);
+   rb_define_method(rb_cFloat,   "whole_fraction", method_whole_fraction_for, -1);
+
 }
 

metadata

@@ -1,7 +1,11 @@
 --- !ruby/object:Gem::Specification 
 name: fraction
 version: !ruby/object:Gem::Version 
-  version: "0.1"
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Christopher Lord
@@ -11,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-27 00:00:00 -05:00
+date: 2011-05-23 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Provides a "fraction" method on all ruby floats.
+description: Provides "to_fraction" and to_whole_fraction methods on all ruby floats and numerics.
 email: christopherlord+fractiongem@gmail.com
 executables: []
 
@@ -25,8 +29,10 @@ extra_rdoc_files: []
 
 files: 
 - fraction.c
+- README.md
+- extconf.rb
 has_rdoc: true
-homepage: http://christopher.lord.ac
+homepage: https://github.com/clord/fraction
 licenses: []
 
 post_install_message: 
@@ -35,23 +41,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Provides a "fraction" method on all ruby floats.
+summary: Provides a "to_fraction" method on all ruby floats.
 test_files: []