ruby-mpfr 0.0.4 → 0.0.5

data/History.txt

@@ -1,6 +1,11 @@
-#  -*- rd -*-
+=== 0.0.5 2009-12-18
+* 1 major enhancement:
+  * Add methods MPFR, MPFR::Matrix, MPFR::SquareMatrix, MPFR::ColumnVector, and MPFR::RowVector.
+* 1 minor enhancement:
+  * Maintenance of docments.
+
 === 0.0.4 2009-12-17
-* 1 major enhancements
+* 1 major enhancements:
   * Add MPFR::Matrix
 
 === 0.0.2 2009-07-25

data/README.rdoc

@@ -1,17 +1,21 @@
 = ruby-mpfr
 
 * http://rubyforge.org/projects/ruby-mpfr/
+* http://gemcutter.org/gems/ruby-mpfr/
 
-== DESCRIPTION:
+== Description:
 
 ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for
 multiple-precision floating-point computations.
+ruby-mpfr also includes Matrix class of MPFR; MPFR::Matrix, MPFR::SquareMatrix,
+MPFR::ColumnVector, and MPFR::RowVector.
 
-== FEATURES/PROBLEMS:
+== Notice:
 
-* Many methods have not been tested.
+* Many methods have not been tested sufficiently.
+* Documentation is not complete.
 
-== SYNOPSIS:
+== Example:
 
  require "mpfr"
  MPFR.get_default_prec(100)
@@ -19,19 +23,21 @@ multiple-precision floating-point computations.
  b = MPFR.new('2.2')
  puts (a * b).to_strf("%.30Re")
 
-=== REQUIREMENTS:
+== Requirements:
 
 * MPFR[http://www.mpfr.org/] 2.4.1 or later
 
 For Ubuntu 9.10, we can install MPFR with the following command.
  $ sudo apt-get install libmpfr-dev
 
-== INSTALL:
+== Install:
 The package of rubygems of ruby-mpfr is provided.
+You can install ruby-mpfr with the following command
+in the system satisfying the above requirements.
  
  $ sudo gem install ruby-mpfr
 
-== LICENSE:
+== License:
 
 ruby-mpfr
 Copyright (C) 2009 Takayuki YAMAGUCHI

data/ext/mpfr/ruby_mpfr.c

@@ -373,16 +373,8 @@ static VALUE r_mpfr_alloc(VALUE self)
   return self;
 }
 
-/*
-  This method returns MPFR instance.
-  If there is not an argument, it is set NaN.
-  Possible arguments are value, rounding mode, and precesion.
-  All arguments are optional.
-*/
-static VALUE r_mpfr_initialize(int argc, VALUE *argv, VALUE self)
+static void r_mpfr_set_initial_value(MPFR *ptr, int argc, VALUE *argv)
 {
-  MPFR *ptr;
-  r_mpfr_get_struct(ptr, self);
   switch(argc){
   case 0:
     mpfr_init(ptr);
@@ -405,6 +397,29 @@ static VALUE r_mpfr_initialize(int argc, VALUE *argv, VALUE self)
     rb_raise(rb_eArgError, "Invalid number of arguments.");
     break;
   }
+}
+
+/* Return new MPFR instance. The same arguments as MPFR.new is acceptable. */
+static VALUE r_mpfr_global_new(int argc, VALUE *argv, VALUE self)
+{
+  MPFR *ptr;
+  VALUE val;
+  r_mpfr_make_struct(val, ptr);
+  r_mpfr_set_initial_value(ptr, argc, argv);
+  return val;
+}
+
+/*
+  This method returns MPFR instance.
+  If there is not an argument, it is set NaN.
+  Possible arguments are value, rounding mode, and precesion.
+  All arguments are optional.
+*/
+static VALUE r_mpfr_initialize(int argc, VALUE *argv, VALUE self)
+{
+  MPFR *ptr;
+  r_mpfr_get_struct(ptr, self);
+  r_mpfr_set_initial_value(ptr, argc, argv);
   return Qtrue;
 }
 
@@ -2506,6 +2521,12 @@ void Init_mpfr()
 
     When method have argument of MPFR and we set instance of other class to the argument,
     the method tries to convert the argument to MPFR instance.
+
+    == Conversion to String
+
+    MPFR#to_s makes a string corresponding to mpfr_printf("%.Re", fr).
+    If you want to adjust format of string, you can MPFR#to_strf.
+    MPFR#to_strf(format) returns a string corresponding to mpfr_printf(format, fr).
   */
   r_mpfr_class = rb_define_class("MPFR", rb_cNumeric);
   rb_include_module(r_mpfr_class, rb_mComparable);
@@ -2591,6 +2612,7 @@ void Init_mpfr()
   /* ------------------------------ Exception Related Functions End ------------------------------ */
 
   /* ------------------------------ MPFR allocation Start ------------------------------ */
+  rb_define_global_function("MPFR", r_mpfr_global_new, -1);
 
   rb_define_alloc_func(r_mpfr_class, r_mpfr_alloc);
   rb_define_private_method(r_mpfr_class, "initialize", r_mpfr_initialize, -1);
@@ -2728,6 +2750,9 @@ void Init_mpfr()
   /* ------------------------------ Module MPFR::Math Start ------------------------------ */
 
   /*
+    = MPFR::Math methods
+
+    == Arguments and Behaivior
     Almost all class methods in this module is the functions in "Special Functions" item of MPFR reference manual.
     First arguments of these methods takes MPFR instance.
     If it is not MPFR instance, it is converted to MPFR instance in this method.

data/ext/mpfr_matrix/mpfr/ruby_mpfr_matrix.c

@@ -44,7 +44,7 @@ VALUE r_mpfr_matrix_robj(MPFRMatrix *x)
   return ret;
 }
 
-/* Allocation function for MPF::Matrix. */
+/* Allocation function for MPFR::Matrix. */
 static VALUE r_mpfr_matrix_alloc (VALUE self)
 {
   MPFRMatrix *ptr;
@@ -59,17 +59,8 @@ static VALUE r_mpfr_matrix_alloc (VALUE self)
 /*   mpfr_matrix_set(x, ptr_src); */
 /* } */
 
-/*
-  Initialization function for MPF::Matrix.
-  If this method gets one argument which is two dimensional Array,
-  it returns MPFR::Matrix instance of which size is same as the array.
-  Getting two argument integers (i, j), it returns MPFR::Matrix instance of which
-  size is (i x j).
-*/
-static VALUE r_mpfr_matrix_initialize (int argc, VALUE *argv, VALUE self)
+static void r_mpfr_matrix_set_initial_value(MPFRMatrix *ptr, int argc, VALUE *argv)
 {
-  MPFRMatrix *ptr;
-  r_mpfr_get_matrix_struct(ptr, self);
   int row, column, i, j;
   VALUE row_ary;
   switch (argc) {
@@ -80,7 +71,7 @@ static VALUE r_mpfr_matrix_initialize (int argc, VALUE *argv, VALUE self)
     for (i = 0; i < row; i++) {
       row_ary = rb_ary_entry(argv[0], i);
       if (column != RARRAY_LEN(row_ary)) {
-	rb_raise(rb_eArgError, "MPF::Matrix.new needs Array which has arrays of same sizes.");
+	rb_raise(rb_eArgError, "MPFR::Matrix.new needs Array which has arrays of same sizes.");
       }
       for (j = 0; j < column; j++) {
 	r_mpfr_set_robj(mpfr_matrix_get_element(ptr, i, j), rb_ary_entry(row_ary, j), GMP_RNDN);
@@ -92,13 +83,37 @@ static VALUE r_mpfr_matrix_initialize (int argc, VALUE *argv, VALUE self)
     mpfr_matrix_set_zeros(ptr);
     break;
   default:
-    rb_raise(rb_eArgError, "MPF::Matrix.new needs one or two arguments.");
+    rb_raise(rb_eArgError, "MPFR::Matrix.new needs one or two arguments.");
     break;
   }
+}
+
+/* Return new MPFR::Matrix instance. The same arguments as MPFR::Matrix.new is acceptable. */
+static VALUE r_mpfr_matrix_global_new(int argc, VALUE *argv, VALUE self)
+{
+  MPFRMatrix *ptr;
+  VALUE val;
+  r_mpfr_make_matrix_struct(val, ptr);
+  r_mpfr_matrix_set_initial_value(ptr, argc, argv);
+  return val;
+}
+
+/*
+  Initialization function for MPFR::Matrix.
+  If this method gets one argument which is two dimensional Array,
+  it returns MPFR::Matrix instance of which size is same as the array.
+  Getting two argument integers (i, j), it returns MPFR::Matrix instance of which
+  size is (i x j).
+*/
+static VALUE r_mpfr_matrix_initialize (int argc, VALUE *argv, VALUE self)
+{
+  MPFRMatrix *ptr;
+  r_mpfr_get_matrix_struct(ptr, self);
+  r_mpfr_matrix_set_initial_value(ptr, argc, argv);
   return Qtrue;
 }
 
-/* Allocation function for MPF::SquareMatrix. */
+/* Allocation function for MPFR::SquareMatrix. */
 static VALUE r_mpfr_square_matrix_alloc (VALUE self)
 {
   MPFRMatrix *ptr;
@@ -106,11 +121,8 @@ static VALUE r_mpfr_square_matrix_alloc (VALUE self)
   return self;
 }
 
-/* Initialization function for MPF::SquareMatrix. */
-static VALUE r_mpfr_square_matrix_initialize (VALUE self, VALUE arg)
+static void r_mpfr_square_matrix_set_initial_value(MPFRMatrix *ptr, VALUE arg)
 {
-  MPFRMatrix *ptr;
-  r_mpfr_get_matrix_struct(ptr, self);
   int row, column, i, j;
   VALUE row_ary;
   switch(TYPE(arg)){
@@ -122,14 +134,14 @@ static VALUE r_mpfr_square_matrix_initialize (VALUE self, VALUE arg)
       for (i = 0; i < row; i++) {
 	row_ary = rb_ary_entry(arg, i);
 	if (column != RARRAY_LEN(row_ary)) {
-	  rb_raise(rb_eArgError, "MPF::Matrix.new needs Array which has arrays of same sizes.");
+	  rb_raise(rb_eArgError, "MPFR::Matrix.new needs Array which has arrays of same sizes.");
 	}
 	for (j = 0; j < column; j++) {
 	  r_mpfr_set_robj(ptr->data + i + j * row, rb_ary_entry(row_ary, j), GMP_RNDN);
 	}
       }
     }else{
-      rb_raise(rb_eArgError, "MPF::SquareMatrix.new needs two dimensinal Array which has the same sizes of row and column.");
+      rb_raise(rb_eArgError, "MPFR::SquareMatrix.new needs two dimensinal Array which has the same sizes of row and column.");
     }
     break;
   case T_FIXNUM:
@@ -138,9 +150,27 @@ static VALUE r_mpfr_square_matrix_initialize (VALUE self, VALUE arg)
     mpfr_matrix_set_zeros(ptr);
     break;
   default:
-    rb_raise(rb_eArgError, "MPF::SquareMatrix.new needs Array or Fixnum.");
+    rb_raise(rb_eArgError, "MPFR::SquareMatrix.new needs Array or Fixnum.");
     break;
   }  
+}
+
+/* Return new MPFR::SquareMatrix instance. The same arguments as MPFR::SquareMatrix.new is acceptable. */
+static VALUE r_mpfr_square_matrix_global_new(int argc, VALUE arg)
+{
+  MPFRMatrix *ptr;
+  VALUE val;
+  r_mpfr_make_matrix_struct(val, ptr);
+  r_mpfr_square_matrix_set_initial_value(ptr, arg);
+  return val;
+}
+
+/* Initialization function for MPFR::SquareMatrix. */
+static VALUE r_mpfr_square_matrix_initialize (VALUE self, VALUE arg)
+{
+  MPFRMatrix *ptr;
+  r_mpfr_get_matrix_struct(ptr, self);
+  r_mpfr_square_matrix_set_initial_value(ptr, arg);
   return Qtrue;
 }
 
@@ -155,7 +185,7 @@ static VALUE r_mpfr_matrix_initialize_copy (VALUE self, VALUE other)
   return Qtrue;
 }
 
-/* Allocation function for MPF::ColumnVector. */
+/* Allocation function for MPFR::ColumnVector. */
 static VALUE r_mpfr_col_vector_alloc (VALUE self)
 {
   MPFRMatrix *ptr;
@@ -163,11 +193,8 @@ static VALUE r_mpfr_col_vector_alloc (VALUE self)
   return self;
 }
 
-/* Initialization function for MPF::ColumnVector. */
-static VALUE r_mpfr_col_vector_initialize (VALUE self, VALUE arg)
+static void r_mpfr_col_vector_set_initial_value(MPFRMatrix *ptr, VALUE arg)
 {
-  MPFRMatrix *ptr;
-  r_mpfr_get_matrix_struct(ptr, self);
   int row, i;
   switch(TYPE(arg)){
   case T_ARRAY:
@@ -185,13 +212,31 @@ static VALUE r_mpfr_col_vector_initialize (VALUE self, VALUE arg)
     }
     break;
   default:
-    rb_raise(rb_eArgError, "MPF::ColumnVector.new needs Array or Fixnum.");
+    rb_raise(rb_eArgError, "MPFR::ColumnVector.new needs Array or Fixnum.");
     break;
-  }  
+  }
+}
+
+/* Return new MPFR::ColumnVector instance. The same arguments as MPFR::ColumnVector.new is acceptable. */
+static VALUE r_mpfr_col_vector_global_new(VALUE self, VALUE arg)
+{
+  MPFRMatrix *ptr;
+  VALUE val;
+  r_mpfr_make_matrix_struct(val, ptr);
+  r_mpfr_col_vector_set_initial_value(ptr, arg);
+  return val;
+}
+
+/* Initialization function for MPFR::ColumnVector. */
+static VALUE r_mpfr_col_vector_initialize (VALUE self, VALUE arg)
+{
+  MPFRMatrix *ptr;
+  r_mpfr_get_matrix_struct(ptr, self);
+  r_mpfr_col_vector_set_initial_value(ptr, arg);
   return Qtrue;
 }
 
-/* Allocation function for MPF::RowVector. */
+/* Allocation function for MPFR::RowVector. */
 static VALUE r_mpfr_row_vector_alloc (VALUE self)
 {
   MPFRMatrix *ptr;
@@ -199,11 +244,8 @@ static VALUE r_mpfr_row_vector_alloc (VALUE self)
   return self;
 }
 
-/* Initialization function for MPF::RowVector. */
-static VALUE r_mpfr_row_vector_initialize (VALUE self, VALUE arg)
+static void r_mpfr_row_vector_set_initial_value(MPFRMatrix *ptr, VALUE arg)
 {
-  MPFRMatrix *ptr;
-  r_mpfr_get_matrix_struct(ptr, self);
   int column, i;
   switch(TYPE(arg)){
   case T_ARRAY:
@@ -221,9 +263,27 @@ static VALUE r_mpfr_row_vector_initialize (VALUE self, VALUE arg)
     }
     break;
   default:
-    rb_raise(rb_eArgError, "MPF::RowVector.new needs Array or Fixnum.");
+    rb_raise(rb_eArgError, "MPFR::RowVector.new needs Array or Fixnum.");
     break;
   }  
+}
+
+/* Return new MPFR::RowVector instance. The same arguments as MPFR::RowVector.new is acceptable. */
+static VALUE r_mpfr_row_vector_global_new(int argc, VALUE arg)
+{
+  MPFRMatrix *ptr;
+  VALUE val;
+  r_mpfr_make_matrix_struct(val, ptr);
+  r_mpfr_row_vector_set_initial_value(ptr, arg);
+  return val;
+}
+
+/* Initialization function for MPFR::RowVector. */
+static VALUE r_mpfr_row_vector_initialize (VALUE self, VALUE arg)
+{
+  MPFRMatrix *ptr;
+  r_mpfr_get_matrix_struct(ptr, self);
+  r_mpfr_row_vector_set_initial_value(ptr, arg);
   return Qtrue;
 }
 
@@ -281,7 +341,7 @@ static VALUE r_mpfr_matrix_element (VALUE self, VALUE row, VALUE column)
   }
 }
 
-/* Return element at _arg_.*/
+/* Return element at _p1_.*/
 static VALUE r_mpfr_matrix_at (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self;
@@ -343,7 +403,7 @@ static VALUE r_mpfr_matrix_each_element_with_index (VALUE self)
   return ret;
 }
 
-/* Return array which has strings converted elements to. */
+/* Return one dimensinal array including strings which elements of matrix is converted to by MPFR#to_strf. */
 static VALUE r_mpfr_matrix_str_ary(VALUE self, VALUE format_str)
 {
   MPFRMatrix *ptr_self;
@@ -359,6 +419,7 @@ static VALUE r_mpfr_matrix_str_ary(VALUE self, VALUE format_str)
   return rb_ary_new4(ptr_self->size, ret_val);
 }
 
+/* Return two dimensinal array including strings which elements of matrix is converted to by MPFR#to_strf. */
 static VALUE r_mpfr_matrix_str_ary2(VALUE self, VALUE format_str)
 {
   MPFRMatrix *ptr_self;
@@ -379,6 +440,7 @@ static VALUE r_mpfr_matrix_str_ary2(VALUE self, VALUE format_str)
   return rb_ary_new4(ptr_self->row, ary);
 }
 
+/* Retrn two dimensinal array including MPFR elements of matrix. */
 static VALUE r_mpfr_matrix_to_array(VALUE self)
 {
   MPFRMatrix *ptr_self;
@@ -391,6 +453,7 @@ static VALUE r_mpfr_matrix_to_array(VALUE self)
   return rb_ary_new4(ptr_self->size, ret_val);
 }
 
+/* Retrn one dimensinal array including MPFR elements of matrix. */
 static VALUE r_mpfr_matrix_to_array2(VALUE self)
 {
   MPFRMatrix *ptr_self;
@@ -408,6 +471,7 @@ static VALUE r_mpfr_matrix_to_array2(VALUE self)
   return rb_ary_new4(ptr_self->row, ary);
 }
 
+/* Return _p1_-th row vector. */
 static VALUE r_mpfr_matrix_row (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_ret;
@@ -423,6 +487,7 @@ static VALUE r_mpfr_matrix_row (VALUE self, VALUE arg)
   }
 }
 
+/* Return _p1_-th column vector. */
 static VALUE r_mpfr_matrix_column (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_ret;
@@ -449,7 +514,7 @@ static VALUE r_mpfr_matrix_transpose (VALUE self)
   return ret;
 }
 
-/* Transpose self. This method is destroy method. */
+/* Transpose self. This method is destructive method. */
 static VALUE r_mpfr_matrix_transpose2 (VALUE self)
 {
   MPFRMatrix *ptr_self, tmp;
@@ -467,6 +532,7 @@ static VALUE r_mpfr_matrix_transpose2 (VALUE self)
   return self;
 }
 
+/* Multiply all elements by -1. This method is non-destructive. */
 static VALUE r_mpfr_matrix_neg (VALUE self)
 {
   MPFRMatrix *ptr_self, *ptr_ret;
@@ -493,7 +559,7 @@ static VALUE r_mpfr_matrix_add (VALUE self, VALUE other)
   return ret;
 }
 
-/* Return _self_ + _other_ which is MPF::Matrix. */
+/* Return _self_ + _other_ which is MPFR::Matrix. */
 static VALUE r_mpfr_matrix_add2 (VALUE self, VALUE other)
 {
   MPFRMatrix *ptr_self, *ptr_other, *ptr_ret;
@@ -527,7 +593,7 @@ static VALUE r_mpfr_matrix_sub (VALUE self, VALUE other)
   return ret;
 }
 
-/* Return _self_ - _other_ which is MPF::Matrix. */
+/* Return _self_ - _other_ which is MPFR::Matrix. */
 static VALUE r_mpfr_matrix_sub2 (VALUE self, VALUE other)
 {
   MPFRMatrix *ptr_self, *ptr_other, *ptr_ret;
@@ -544,6 +610,7 @@ static VALUE r_mpfr_matrix_sub2 (VALUE self, VALUE other)
   return ret;
 }
 
+/* Regard matrix as vector and return the value of inner product. */
 static VALUE r_mpfr_vector_inner_product (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_arg;
@@ -581,7 +648,7 @@ static VALUE r_mpfr_matrix_mul_matrix (VALUE self, VALUE other)
   return ret;
 }
 
-/* Return _self_ * _other_ which is MPF::Matrix. */
+/* Return _self_ * _other_ which is MPFR::Matrix. */
 static VALUE r_mpfr_matrix_mul_matrix2 (VALUE self, VALUE other)
 {
   MPFRMatrix *ptr_self, *ptr_other, *ptr_ret;
@@ -638,7 +705,7 @@ static VALUE r_mpfr_matrix_div_scalar (VALUE self, VALUE scalar)
   return ret;
 }
 
-/* Take matrix for vector and return length of the vector. */
+/* Regard matrix as vector and return length of the vector. */
 static VALUE r_mpfr_matrix_vector_norm (VALUE self)
 {
   MPFRMatrix *ptr_self;
@@ -670,7 +737,7 @@ static VALUE r_mpfr_square_matrix_dim (VALUE self)
   return INT2FIX(ptr_self->row);
 }
 
-/* Return [matrix_l, matrix_r, indx]. */
+/* Perform LU decomposition and return [matrix_l, matrix_r, indx]. */
 static VALUE r_mpfr_square_matrix_lu_decomp (VALUE self)
 {
   MPFRMatrix *ptr_self, *ptr_ret_l, *ptr_ret_u;
@@ -705,6 +772,7 @@ static VALUE r_mpfr_square_matrix_lu_decomp (VALUE self)
   }
 }
 
+/* Return determinant of matrix. */
 static VALUE r_mpfr_square_matrix_determinant (VALUE self)
 {
   MPFRMatrix *ptr_self;
@@ -716,6 +784,7 @@ static VALUE r_mpfr_square_matrix_determinant (VALUE self)
   return ret;
 }
 
+/* Perform QR decomposition and return [matrix_q, matrix_r]. */
 static VALUE r_mpfr_square_matrix_qr_decomp (VALUE self)
 {
   MPFRMatrix *ptr_self, *ptr_q, *ptr_r;
@@ -727,6 +796,7 @@ static VALUE r_mpfr_square_matrix_qr_decomp (VALUE self)
   return rb_ary_new3(2, q, r);
 }
 
+/* Return identity matrix. */
 static VALUE r_mpfr_square_matrix_identity (VALUE self, VALUE size)
 {
   VALUE ret;
@@ -745,7 +815,7 @@ static VALUE r_mpfr_vector_dim (VALUE self)
   return INT2FIX(ptr_self->size);
 }
 
-/* Take matrix for vector and return length of the vector. */
+/* Regard matrix as vector and return length of the vector. */
 static VALUE r_mpfr_vector_abs (VALUE self)
 {
   MPFRMatrix *ptr_self;
@@ -757,7 +827,7 @@ static VALUE r_mpfr_vector_abs (VALUE self)
   return ret;
 }
 
-/* Return element at _arg_.*/
+/* Return element at _p1_.*/
 static VALUE r_mpfr_vector_element (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self;
@@ -774,7 +844,7 @@ static VALUE r_mpfr_vector_element (VALUE self, VALUE arg)
   }
 }
 
-/* Set _robj_ to _arg_ th element. */
+/* Set _p2_ to _p1_ th element. */
 static VALUE r_mpfr_vector_set_element (VALUE self, VALUE arg, VALUE robj)
 {
   MPFRMatrix *ptr_self;
@@ -818,6 +888,7 @@ static VALUE r_mpfr_vector_each_element_with_index (VALUE self)
   return ret;
 }
 
+/* Return distance from _p1_, i.e. sqrt((x1 - x2)^2 + (y1 - y2)^2). */
 static VALUE r_mpfr_vector_distance_from (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_arg;
@@ -834,6 +905,7 @@ static VALUE r_mpfr_vector_distance_from (VALUE self, VALUE arg)
   return ret;
 }
 
+/* Return midpoint between _self_ and _p1_. */
 static VALUE r_mpfr_vector_midpoint (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_arg, *ptr_ret;
@@ -845,6 +917,7 @@ static VALUE r_mpfr_vector_midpoint (VALUE self, VALUE arg)
   return ret;
 }
 
+/* Return dividing point of _self_ and _p1_ by _p2_. */
 static VALUE r_mpfr_vector_dividing_point (VALUE self, VALUE arg, VALUE div)
 {
   MPFRMatrix *ptr_self, *ptr_arg, *ptr_ret;
@@ -858,6 +931,7 @@ static VALUE r_mpfr_vector_dividing_point (VALUE self, VALUE arg, VALUE div)
   return ret;
 }
 
+/* Return normalized vector of _self_. */
 static VALUE r_mpfr_vector_normalize (VALUE self)
 {
   MPFRMatrix *ptr_self, *ptr_ret;
@@ -871,7 +945,7 @@ static VALUE r_mpfr_vector_normalize (VALUE self)
   }
 }
 
-/* Return normalized vector of _self_. This method is destroy method. */
+/* Return normalized vector of _self_. This method is destructive method. */
 static VALUE r_mpfr_vector_normalize2 (VALUE self)
 {
   MPFRMatrix *ptr_self, tmp;
@@ -887,6 +961,7 @@ static VALUE r_mpfr_vector_normalize2 (VALUE self)
   return ret;
 }
 
+/* Return new vector whose length is _p1_.  */
 static VALUE r_mpfr_vector_set_length (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_ret;
@@ -910,6 +985,7 @@ static VALUE r_mpfr_vector_set_length (VALUE self, VALUE arg)
   return returned_value;
 }
 
+/* Return new vector whose length is _p1_. This method is destructive. */
 static VALUE r_mpfr_vector_set_length2 (VALUE self, VALUE arg)
 {
   MPFRMatrix *ptr_self, *ptr_ret;
@@ -938,29 +1014,32 @@ static VALUE r_mpfr_vector_set_length2 (VALUE self, VALUE arg)
 void Init_matrix()
 {
   
-  VALUE tmp_mpfr_class = rb_define_class("MPFR", rb_cNumeric);
-  
+  VALUE tmp_r_mpfr_class = rb_define_class("MPFR", rb_cNumeric);
+
   /*
     MPFR::Matrix is class in which instances means matrix and
     have MPFR instances as elements.
+    MPFR::SquareMatrix, MPFR::ColumnVector, and MPFR::RowVector are subclass of MPFR::Matrix.
   */
+  r_mpfr_matrix = rb_define_class_under(tmp_r_mpfr_class, "Matrix", rb_cObject);
+  r_mpfr_square_matrix = rb_define_class_under(tmp_r_mpfr_class, "SquareMatrix", r_mpfr_matrix);
+  r_mpfr_col_vector = rb_define_class_under(tmp_r_mpfr_class, "ColumnVector", r_mpfr_matrix);
+  r_mpfr_row_vector = rb_define_class_under(tmp_r_mpfr_class, "RowVector", r_mpfr_matrix);
 
-  /* Initialization of MPFR::Matrix, MPFR::SquareMatrix, MPFR::ColumnVector and MPFR::RowVector */
-  r_mpfr_matrix = rb_define_class_under(tmp_mpfr_class, "Matrix", rb_cObject);
-  r_mpfr_square_matrix = rb_define_class_under(tmp_mpfr_class, "SquareMatrix", r_mpfr_matrix);
-  r_mpfr_col_vector = rb_define_class_under(tmp_mpfr_class, "ColumnVector", r_mpfr_matrix);
-  r_mpfr_row_vector = rb_define_class_under(tmp_mpfr_class, "RowVector", r_mpfr_matrix);
-
+  rb_define_singleton_method(tmp_r_mpfr_class, "Matrix", r_mpfr_matrix_global_new, -1);
   rb_define_alloc_func(r_mpfr_matrix, r_mpfr_matrix_alloc);
   rb_define_private_method(r_mpfr_matrix, "initialize", r_mpfr_matrix_initialize, -1);
   rb_define_private_method(r_mpfr_matrix, "initialize_copy", r_mpfr_matrix_initialize_copy, 1);
 
+  rb_define_singleton_method(tmp_r_mpfr_class, "SquareMatrix", r_mpfr_square_matrix_global_new, 1);
   rb_define_alloc_func(r_mpfr_square_matrix, r_mpfr_square_matrix_alloc);
   rb_define_private_method(r_mpfr_square_matrix, "initialize", r_mpfr_square_matrix_initialize, 1);
 
+  rb_define_singleton_method(tmp_r_mpfr_class, "ColumnVector", r_mpfr_col_vector_global_new, 1);
   rb_define_alloc_func(r_mpfr_col_vector, r_mpfr_col_vector_alloc);
   rb_define_private_method(r_mpfr_col_vector, "initialize", r_mpfr_col_vector_initialize, 1);
 
+  rb_define_singleton_method(tmp_r_mpfr_class, "RowVector", r_mpfr_row_vector_global_new, 1);
   rb_define_alloc_func(r_mpfr_row_vector, r_mpfr_row_vector_alloc);
   rb_define_private_method(r_mpfr_row_vector, "initialize", r_mpfr_row_vector_initialize, 1);
 
@@ -1021,8 +1100,11 @@ void Init_matrix()
 
   rb_define_singleton_method(r_mpfr_square_matrix, "identity", r_mpfr_square_matrix_identity, 1);
 
-  /* Initialization of MPFR::Vector module */
-  r_mpfr_vector_module = rb_define_module_under(tmp_mpfr_class, "Vector");
+  /*
+    This module add the functionality as vector.
+    MPFR::ColumnVector and MPFR::RowVector include MPFR::Vector module.
+  */
+  r_mpfr_vector_module = rb_define_module_under(tmp_r_mpfr_class, "Vector");
 
   rb_define_method(r_mpfr_vector_module, "[]=", r_mpfr_vector_set_element, 2);
   rb_define_method(r_mpfr_vector_module, "[]", r_mpfr_vector_element, 1);

data/lib/mpfr/version.rb

@@ -1,3 +1 @@
-module MPFR
-  VERSION = '0.0.4'
-end
+RUBY_MPFR_VERSION = '0.0.5'

data/ruby-mpfr.gemspec

@@ -2,24 +2,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-mpfr}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]
-  s.date = %q{2009-12-17}
+  s.date = %q{2009-12-19}
   s.description = %q{ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for
-multiple-precision floating-point computations.}
+multiple-precision floating-point computations.
+ruby-mpfr also includes Matrix class of MPFR; MPFR::Matrix, MPFR::SquareMatrix,
+MPFR::ColumnVector, and MPFR::RowVector.}
   s.email = ["d@ytak.info"]
   s.extensions = ["ext/mpfr/extconf.rb", "ext/mpfr_matrix/mpfr/extconf.rb"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
   s.files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "ext/mpfr/extconf.rb", "ext/mpfr/ruby_mpfr.c", "ext/mpfr/ruby_mpfr.h", "ext/mpfr_matrix/mpfr/extconf.rb", "ext/mpfr_matrix/mpfr/func_mpfr_matrix.c", "ext/mpfr_matrix/mpfr/func_mpfr_matrix.h", "ext/mpfr_matrix/mpfr/ruby_mpfr.h", "ext/mpfr_matrix/mpfr/ruby_mpfr_matrix.c", "ext/mpfr_matrix/mpfr/ruby_mpfr_matrix.h", "lib/mpfr/matrix.rb", "lib/mpfr/version.rb", "ruby-mpfr.gemspec", "script/console", "script/destroy", "script/generate", "spec/mpfr/allocate_spec.rb", "spec/mpfr/arithmetic_spec.rb", "spec/mpfr/comparison_spec.rb", "spec/mpfr/constant_spec.rb", "spec/mpfr/conversion_spec.rb", "spec/mpfr/exception_spec.rb", "spec/mpfr/functions_spec.rb", "spec/mpfr/generate_number_modulue.rb", "spec/mpfr/precision_roundmode_spec.rb", "spec/mpfr/rounding_spec.rb", "spec/mpfr/set_value_spec.rb", "spec/mpfr/spec_helper.rb", "spec/mpfr/string_spec.rb", "spec/mpfr_matrix/generate_matrix_arguments.rb", "spec/mpfr_matrix/mpfr_matrix_alloc_spec.rb", "spec/mpfr_matrix/mpfr_matrix_arithmetic_spec.rb", "spec/mpfr_matrix/mpfr_matrix_set_element_spec.rb", "spec/mpfr_matrix/mpfr_matrix_string_spec.rb", "spec/mpfr_matrix/mpfr_square_matrix_spec.rb", "spec/mpfr_matrix/spec_helper.rb", "spec/spec.opts", "tasks/extconf.rake"]
-  s.homepage = %q{http://rubyforge.org/projects/ruby-mpfr/}
+  s.homepage = %q{[URL] http://rubyforge.org/projects/ruby-mpfr/}
   s.post_install_message = %q{PostInstall.txt}
   s.rdoc_options = ["--main", "README.rdoc"]
   s.require_paths = ["lib", "ext"]
   s.rubyforge_project = %q{ruby-mpfr}
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for multiple-precision floating-point computations.}
+  s.summary = %q{ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for multiple-precision floating-point computations}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/spec/mpfr/allocate_spec.rb

@@ -10,6 +10,19 @@ describe MPFR, 'when allocating objects from integer' do
     end
   end
 
+  it "should equal bignum" do
+    MPFR.set_default_prec(120)
+    GenerateNumber.float(100) do |f|
+      MPFR.new(f).should == MPFR(f)
+    end
+
+    GenerateNumber.float(100) do |f|
+      str = f.to_s
+      MPFR.new(str).should == MPFR(str)
+    end
+
+  end
+
   it "should allocate from string" do
     MPFR.set_default_prec(53)
     for i in 0..1000

data/spec/mpfr_matrix/mpfr_matrix_alloc_spec.rb

@@ -7,6 +7,12 @@ describe "initialization of matrix" do
     @matrixes = @sizes.map{ |a| MPFR::Matrix.new(*a) }
   end
 
+  it "should be same as MPFR::Matrix method" do
+    @matrixes.each_with_index do |a, i|
+      MPFR::Matrix(*@sizes[i]).should == a
+    end
+  end
+  
   it "should has size which equals size of array." do
     @matrixes.each_with_index do |a, i|
       a.size.should == (@sizes[i][0] * @sizes[i][1])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mpfr
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 +09:00
+date: 2009-12-19 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +25,8 @@ dependencies:
 description: |-
   ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for
   multiple-precision floating-point computations.
+  ruby-mpfr also includes Matrix class of MPFR; MPFR::Matrix, MPFR::SquareMatrix,
+  MPFR::ColumnVector, and MPFR::RowVector.
 email: 
 - d@ytak.info
 executables: []
@@ -109,6 +111,6 @@ rubyforge_project: ruby-mpfr
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for multiple-precision floating-point computations.
+summary: ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for multiple-precision floating-point computations
 test_files: []