fibonacci 0.1.4 → 0.1.5

data/ext/fibonacci/fibonacci.c

@@ -80,6 +80,26 @@ rb_matrix_mul(VALUE ary1, VALUE ary2)
   return tmp_ary;
 }
 
+/*  call-seq:
+ *    fib.matrix(n)
+ *
+ *  Returns a 2x2 matrix(2-dimensional array).
+ *
+ *  fib.matrix(10)
+ *  #=> [[89, 55], [55, 34]]
+ *
+ *  fib.matrix(100)
+ *  #=> [[573147844013817084101, 354224848179261915075], [354224848179261915075,218922995834555169026]]
+ *
+ *  arr = fib.matrix(15)
+ *  #=> [[987, 610], [610, 377]]
+ *
+ *  arr[0][1] or arr[1][0] is the value of nth term
+ *
+ *  Refer to http://en.wikipedia.org/wiki/Fibonacci_number#Matrix_form
+ *
+ */
+
 static VALUE
 rb_matrix_form(VALUE self, VALUE n)
 {
@@ -144,6 +164,25 @@ rb_matrix_form(VALUE self, VALUE n)
   return res_ary;
 }
 
+/*  call-seq:
+ *    fib[n]
+ *
+ *  Returns a Fixnum or Bignum.
+ *
+ *  fib[100]
+ *  #=> 354224848179261915075
+ *
+ *  fib[10]
+ *  #=> 55
+ *
+ *  fib[200]
+ *  #=> 280571172992510140037611932413038677189525
+ *
+ *  The value of nth term is calculated iteratively.
+ *
+ *  Refer to http://en.wikipedia.org/wiki/Fibonacci_number#First_identity
+ */
+
 static VALUE
 rb_iterative_val(VALUE self, VALUE n)
 {
@@ -187,6 +226,26 @@ rb_iterative_val(VALUE self, VALUE n)
   return fib_n;
 }
 
+/*  call-seq:
+ *    fib.terms(n)
+ *
+ *  Returns a array with the first n terms of the series
+ *
+ *  fib.terms(5)
+ *  #=> [0, 1, 1, 2, 3]
+ *
+ *  fib.terms(10)
+ *  #=> [0, 1, 1, 2, 3, 5, 8, 13, 21, 34]
+ *
+ *  fib.terms(15)
+ *  #=> [0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377]
+ *
+ *  fib.terms(0)
+ *  #=> []
+ *
+ *  Refer to http://en.wikipedia.org/wiki/Fibonacci_number#First_identity
+ */
+
 static VALUE
 terms(VALUE self, VALUE n)
 {
@@ -223,6 +282,19 @@ terms(VALUE self, VALUE n)
   return ary;
 }
 
+/*  call-seq:
+ *    fib.print(n)
+ *
+ *  Prints the first n terms of the series.
+ *
+ *  fib.print(1)
+ *  #=>   0
+ *
+ *  fib.print(2)
+ *  #=>   0
+ *        1
+ */
+
 static VALUE
 print(VALUE self, VALUE n)
 {
@@ -230,7 +302,6 @@ print(VALUE self, VALUE n)
   VALUE fib_n_1 = ONE;
   VALUE fib_n_2 = ZERO;
   VALUE fib_n = ZERO;
-
   if(TYPE(n) != T_FIXNUM)
   {
     rb_raise(rb_eArgError, "Invalid argument for type Fixnum");
@@ -265,6 +336,20 @@ index_of(VALUE self, VALUE val)
   return Qnil;
 }
 
+/*  call-seq:
+ *    fib.num_digits(n)
+ *
+ *  Returns the number of digits in the nth term of the series
+ *
+ *  fib.num_digits(10)
+ *  #=> 2
+ *
+ *  fib.num_digits(100)
+ *  #=> 21
+ *
+ *  Refer to http://en.wikipedia.org/wiki/Fibonacci_number#Computation_by_rounding
+ */
+
 static VALUE
 num_digits(VALUE self, VALUE n)
 {

data/lib/fibonacci/version.rb

@@ -1 +1 @@
-VERSION = "0.1.4"
+VERSION = "0.1.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fibonacci
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-13 00:00:00.000000000 Z
+date: 2011-12-14 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby gem for exploring Fibonacci series
 email:
@@ -48,3 +48,4 @@ signing_key:
 specification_version: 3
 summary: Fibonacci
 test_files: []
+has_rdoc: