ruby-mpfr 0.0.5 → 0.0.6

data/Example.rdoc

@@ -0,0 +1,63 @@
+= Examples
+
+== Example 1: Initialization
+You must require 'mpfr' to use MPFR.
+And you set the default precision by MPFR.set_default_prec.
+To make an instance of MPFR, you can use MPFR.new or MPFR methods.
+MPFR.new and MPFR have the same arguments.
+First argument is a number which is Fixnum, Bignum, Float, String, or MPFR.
+The following two optional arguments are rounding mode and precision.
+
+ require "mpfr"
+ MPFR.set_default_prec(100)
+ 
+ a = MPFR(3.3)       # or MPFR.new(3.3)
+ b = MPFR('2.2')     # or MPFR.new('2.2')
+ puts (a + b).to_s   # => 5.4999999999999998223643160599724e+00
+ puts (a - b).to_s   # => 1.0999999999999998223643160599743e+00
+ puts (a * b).to_s   # => 7.2599999999999996092014953319487e+00
+ puts (a / b).to_s   # => 1.4999999999999999192565072999879e+00
+ 
+ c = MPFR('4.321', MPFR::RNDU)
+ d = MPFR('4.321', MPFR::RNDD)
+ c > d    # => true
+ 
+ e = MPFR('4.321', MPFR::RNDN, 256)
+ e.prec   # => 256
+ d.prec   # => 100
+
+== Example 2: Convertion to String
+You can use MPFR#to_s and MPFR#to_strf to convert
+an instance of MPFR to String.
+These methods use function mpfr_asprintf.
+MPFR#to_s convert an instance to string by mpfr_asprintf(str, "%.Re", self);
+If you execute MPFR#to_strf(format), you get string converted
+by mpfr_asprintf(str, format, self);
+
+ require "mpfr"
+ MPFR.set_default_prec(128)
+ 
+ a = MPFR('0.3')
+ puts a.to_s              # => 3.000000000000000000000000000000000000006e-01
+ puts a.to_strf("%.20Re") # => 3.00000000000000000000e-01
+ puts a.to_strf("%.20RE") # => 3.00000000000000000000E-01
+ puts a.to_strf("%.20Rf") # => 0.30000000000000000000
+
+== Example 3: Special Functions
+Special functions of MPFR is collected in MPFR::Math.
+MPFR::Math.func corresponds to mpfr_func in C language.
+For example, you can use MPFR::Math.log to use mpfr_log.
+Method of MPFR::Math is two optional arguments; rounding mode and percision.
+
+ require "mpfr"
+ MPFR.set_default_prec(128)
+ 
+ MPFR::Math.log('0.3') # => -1.203972804325935992622746217761838502954e+00
+ MPFR::Math.sin(1.23)  # => 9.424888019316975040865688397571963882576e-01
+ 
+ a = MPFR::Math.sin(1.23, MPFR::RNDU) # => 9.424888019316975040865688397571963882576e-01
+ b = MPFR::Math.sin(1.23, MPFR::RNDD) # => 9.424888019316975040865688397571963882547e-01
+ a > b   # => true
+ 
+ e = MPFR::Math.sin(1.23, MPFR::RNDD, 256)
+ e.get_prec   # => 256

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.0.6 2009-12-26
+* 1 minor enhancement:
+  * Add documents of MPFR.
+* 1 bug fix:
+  * MPFR.get_default_prec returns new default precision.
+
 === 0.0.5 2009-12-18
 * 1 major enhancement:
   * Add methods MPFR, MPFR::Matrix, MPFR::SquareMatrix, MPFR::ColumnVector, and MPFR::RowVector.

data/Manifest.txt

@@ -1,3 +1,4 @@
+Example.rdoc
 History.txt
 Manifest.txt
 PostInstall.txt

data/README.rdoc

@@ -5,26 +5,22 @@
 
 == Description:
 
-ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for
+ruby-mpfr is a 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.
 
+* History[link:History_txt.html]
+* {Examples of Usage}[link:Example_rdoc.html]
+
 == Notice:
 
 * Many methods have not been tested sufficiently.
 * Documentation is not complete.
 
-== Example:
-
- require "mpfr"
- MPFR.get_default_prec(100)
- a = MPFR.new(3)
- b = MPFR.new('2.2')
- puts (a * b).to_strf("%.30Re")
-
 == Requirements:
 
+* Ruby[http://www.ruby-lang.org/] 1.9.1 or later
 * MPFR[http://www.mpfr.org/] 2.4.1 or later
 
 For Ubuntu 9.10, we can install MPFR with the following command.
@@ -37,6 +33,15 @@ in the system satisfying the above requirements.
  
  $ sudo gem install ruby-mpfr
 
+== Related Software:
+These two gem packages uses ruby-mpfr.
+
+* ruby-mpc[http://gemcutter.org/gems/ruby-mpc/]: the arithmetic of complex numbers with multiprecision
+* ruby-mpfi[http://gemcutter.org/gems/ruby-mpfi/]: the interval arithmetic with multiprecision
+
+The following is an another multiple precision library which uses GMP.
+* http://gemcutter.org/gems/gmp
+
 == License:
 
 ruby-mpfr

data/Rakefile

@@ -17,6 +17,7 @@ $hoe = Hoe.spec 'ruby-mpfr' do
   # self.extra_deps         = [['activesupport','>= 2.0.2']]
   self.spec_extras[:extensions] = ["ext/mpfr/extconf.rb", "ext/mpfr_matrix/mpfr/extconf.rb"]
   self.extra_rdoc_files << 'README.rdoc'
+  self.extra_rdoc_files << 'Example.rdoc'
 end
 
 # require 'newgem/tasks'

data/ext/mpfr/ruby_mpfr.c

@@ -82,7 +82,7 @@ static VALUE r_mpfr_set_default_prec(VALUE self, VALUE prec)
     rb_raise(rb_eRangeError, "Argument must be positive.");
   }
   mpfr_set_default_prec(set_prec);
-  return INT2FIX(mpf_get_default_prec());
+  return INT2FIX(mpfr_get_default_prec());
 }
 
 /* Return the default MPFR precision in bits. */

data/lib/mpfr/version.rb

@@ -1 +1 @@
-RUBY_MPFR_VERSION = '0.0.5'
+RUBY_MPFR_VERSION = '0.0.6'

data/ruby-mpfr.gemspec

@@ -2,26 +2,29 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-mpfr}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Takayuki YAMAGUCHI"]
-  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
+  s.date = %q{2009-12-26}
+  s.description = %q{ruby-mpfr is a 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.}
+MPFR::ColumnVector, and MPFR::RowVector.
+
+* History[link:History_txt.html]
+* {Examples of Usage}[link:Example_rdoc.html]}
   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{[URL] http://rubyforge.org/projects/ruby-mpfr/}
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Example.rdoc"]
+  s.files = ["Example.rdoc", "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.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 a 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/precision_roundmode_spec.rb

@@ -34,6 +34,7 @@ describe MPFR, 'when getting rounding mode' do
         check_set_rnd(rnds[i], rnds[j])
       end
     end
+    MPFR.set_default_rounding_mode(MPFR::RNDN)
   end
 end
 

data/spec/mpfr_matrix/mpfr_matrix_arithmetic_spec.rb

@@ -37,9 +37,9 @@ describe MPFR::Matrix, "when arithmetic operator applies to 2x3 matrixies" do
   it "should be subtracted" do
     @args.each_index do |i|
       if i > 0
-        res = @args[i-1] + @args[i]
+        res = @args[i-1] - @args[i]
         (0...@row).each do |j|
-          (0...@column).each { |k| res[j, k].should eql(@args[i-1][j, k] + @args[i][j, k]) }
+          (0...@column).each { |k| res[j, k].should eql(@args[i-1][j, k] - @args[i][j, k]) }
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mpfr
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-19 00:00:00 +09:00
+date: 2009-12-26 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,10 +23,13 @@ dependencies:
         version: 2.4.0
     version: 
 description: |-
-  ruby-mpfr is library to use MPFR[http://www.mpfr.org/] which is a C library for
+  ruby-mpfr is a 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.
+  
+  * History[link:History_txt.html]
+  * {Examples of Usage}[link:Example_rdoc.html]
 email: 
 - d@ytak.info
 executables: []
@@ -39,7 +42,9 @@ extra_rdoc_files:
 - Manifest.txt
 - PostInstall.txt
 - README.rdoc
+- Example.rdoc
 files: 
+- Example.rdoc
 - History.txt
 - Manifest.txt
 - PostInstall.txt
@@ -111,6 +116,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 a library to use MPFR[http://www.mpfr.org/] which is a C library for multiple-precision floating-point computations
 test_files: []