BigDecimal(可変長浮動少数点演算用拡張ライブラリ)

• http://www.ruby-lang.org/ja/：Ruby公式ページ
• http://ruby.freak.ne.jp/：Rubyに関する情報ページ
• http://kahori.com/ruby/ring/：Rubyに関するページを辿れます

目次

• はじめに
• 使用方法とメソッドの一覧
• 無限、非数、ゼロの扱い
• 内部構造
• 2進と10進
• 計算精度について

インストールについて

require 'bigdecimal'
a=BigDecimal::new("0.123456789123456789")
b=BigDecimal::new("123456.78912345678",40)
c=a+b

• new

新しい BigDecimal オブジェクトを生成します。
a=BigDecimal::new(s[,n])
s は初期値を文字列で指定します． n は必要な有効桁数（a の最大有効桁数）を整数で指定します。 n が 0 または省略されたときは、n の値は s の有効桁数とみなされます。 s の有効桁数より n が小さいときも n=0 のときと同じです。 a の最大有効桁数は n より若干大い値が採用されます。
• +

加算（c = a + b）
c の精度については「計算精度について」を参照してください。
• -

減算（c = a - b）、または符号反転（c = -a）
c の精度については「計算精度について」を参照してください。
• *

乗算(c = a * b)
cの精度は(aの精度)+(bの精度)程度です。
詳しくは「計算精度について」を参照してください。
• /

除算(c = a / b)
c の精度については「計算精度について」を参照してください。
• assign

以下のように使用します。
c = a.assign(n,f)
f > 0 なら、a を c に、そのまま代入します。 f < 0 なら、-a を c に代入します。 f の絶対値（|f|）は１か２を指定してください。 |f|=2 のときは、c の最大精度が a の実精度より小さいときには 丸められます。|f|=1 のときは切り捨てられます。 n は c の有効桁数です（n 桁以上の精度を持つ c が生成されます）。
• add

以下のように使用します。
c = a.add(b,n)
c = a + b を最大で n 桁まで計算します。 a + b の精度が n より大きいときは丸められます。
• sub

以下のように使用します。
c = a.sub(b,n)
c = a - b を最大で n 桁まで計算します。 a - b の精度が n より大きいときは丸められます。
• mult

以下のように使用します。
c = a.mult(b,n)
c = a * b を最大で n 桁まで計算します。 a * b の精度が n より大きいときは丸められます。
• div

以下のように使用します。
c,r = a.div(b,n)
c=a/b の計算をします。 r には剰余が代入されます。a/bは 必要ならn 桁まで計算されます。divmod メソッド と異なり、c は整数とは限りません。 また、 c は丸められることはありません。 a = c*b + r の関係は成立します。
• %

r = a%b
a/b の余りを計算します。以下の計算と同じものです。
r = a-((a/b).floor)*b

• fix

a の小数点以下の切り捨て。
c = a.fix
• frac

a の整数部分の切り捨て。
c = a.frac
• floor

a 以下の最大整数を表す値（BigDecimal 値）を返します。
c = a.floor
以下のように引数を与えて、小数点以下 n+1 位の数字を操作することもできます (少数点以下を、最大 n 桁にします)。
c = BigDecimal("1.23456")
d = c.floor(4) # d = 1.2345 になります。
n が負のときは小数点以上 n 桁目を操作します。
c = BigDecimal("15.23456")
d = c.floor(-1) # d = 10.0 になります。

• ceil

a 以上の整数のうち、最も小さい整数を計算し、その値（BigDecimal 値）を返します。
c = a.ceil
以下のように引数を与えて、小数点以下 n+1 位の数字を操作することもできます (少数点以下を、最大 n 桁にします)。
c = BigDecimal::new("1.23456")
d = c.ceil(4) # d = 1.2346 になります。
n が負のときは小数点以上 n 桁目をを操作します。
c = BigDecimal::new("15.23456")
d = c.ceil(-1) # d = 20.0 になります。

• round

小数点以下第一位の数を四捨五入して整数（BigDecimal 値）にします。
c = a.round
以下のように引数を与えて、小数点以下 n+1 位の数字を操作することもできます (少数点以下を、最大 n 桁にします)。
n が正の時は、小数点以下 n+1 位の数字を四捨五入します。 c = BigDecimal::new("1.23456")
d = c.round(4) # d = 1.235 になります。
n が負のときは小数点以上 n 桁目をを操作します。
c = BigDecimal::new("15.23456")
d = c.round(-1) # d = 20.0 になります。

• truncate

小数点以下の数を切り捨てて整数（BigDecimal 値）にします。
c = a.truncate
以下のように引数を与えて、小数点以下 n+1 位の数字を操作することもできます (少数点以下を、最大 n 桁にします)。
n が正の時は、小数点以下 n+1 位の数字を切り捨てます。 c = BigDecimal::new("1.23456")
d = c.truncate(4) # d = 1.2345 になります。
n が負のときは小数点以上 n 桁目をを操作します。
c = BigDecimal::new("15.23456")
d = c.truncate(-1) # d = 10.0 になります。

• divmod

商と剰余の配列を返します。
c,r = a.divmod(b) # a = c*b + r
divmodメソッドは a = c * b + r となる a / b の浮動小数点型の商 c と剰余 r を 計算します。ここで c は整数（少数部分のない実数）になります。
c = (a/b).floor
r = a - c*b
で計算されます。
• remainder

r=a.remainder(b)
a/b の剰余 r を計算します。
c = (a/b).fix
r = a - c*b
で計算されます。
• abs

ａの絶対値
c = a.abs

• to_i

少数点以下を切り捨てて整数に変換します。
i = a.to_i
i は値に応じて Fixnum か Bignum になります。 a が Infinity や NaN のとき、i は nil になります。
• to_f

dup と全く同じです。 同じ値の BigDecimal オブジェクトを生成します。
• to_s

文字列に変換します("0.xxxxxEn"の形になります）。
s = a.to_s
• to_s2

文字列に変換します。仮数部分を n 桁毎に空白で区切ります。
s = a.to_s2(n)
• exponent

指数部を整数値で返します。 n = a.exponent
は a の値が 0.xxxxxxx*10**n を意味します。
• E

自然対数の底e(=2.718281828....)を計算します（正直にテイラー展開で）。
e = BigDecimal::E(n)
nは必要な有効桁数を整数で指定します。
• PI

円周率(=3.14159265358979....)を計算します（J．Machinの公式を用います）。
e = BigDecimal::PI(n)
n は必要な有効桁数を整数で指定します。
• BASE

内部で使用される基数の値です。整数が 32 ビットの処理系では10000です。
b = BigDecimal::BASE

• mode

BigDecimalの実行結果を制御します。以下の使用方法が定義されています。
f = BigDecimal::mode(BigDecimal::EXCEPTION_NaN,flag)
f = BigDecimal::mode(BigDecimal::EXCEPTION_INFINITY,flag)
f = BigDecimal::mode(BigDecimal::EXCEPTION_UNDERFLOW,flag)
f = BigDecimal::mode(BigDecimal::EXCEPTION_OVERFLOW,flag)
f = BigDecimal::mode(BigDecimal::EXCEPTION_ZERODIVIDE,flag)
f = BigDecimal::mode(BigDecimal::EXCEPTION_ALL,flag)
EXCEPTION_NaN は結果が NaN になったときの指定です。 EXCEPTION_INFINITY は結果が無限大(±Infinity) になったときの指定です。 EXCEPTION_UNDERFLOW は指数部がアンダーフローするときの指定です。 EXCEPTION_OVERFLOW は指数部がオーバーフローするときの指定です。 EXCEPTION_ZERODIVIDE はゼロによる割り算を実行したときの指定です。 EXCEPTION_ALL は、可能な全てに対して一括して設定するときに 使用します。 flag が true のときは、指定した状態になったときに例外を発行 するようになります。 flag が false（デフォルト）なら、例外は発行されません。計算結果は 以下のようになります。
EXCEPTION_NaN のとき、非数(NaN)
EXCEPTION_INFINITY のとき、無限(+ or -Infinity)
EXCEPTION_UNDERFLOW のとき、ゼロ
EXCEPTION_OVERFLOW のとき、+Infinity か -Infinity
EXCEPTION_ZERODIVIDE のとき、+Infinity か -Infinity
EXCEPTION_INFINITY、EXCEPTION_OVERFLOW、EXCEPTION_ZERODIVIDE は今のところ同じです。
戻り値は、設定後の値です。「値」の意味は、例えば BigDecimal::EXCEPTION_NaNと「値」の & が ゼロ以外ならば EXCEPTION_NaNが設定されているという意味です。 flag が nil、または、true と false 以外なら現在の設定値が返ります。
• limit([n])

生成されるBigDecimalオブジェクトの最大桁数をn桁に制限します。戻り値は 設定する前の値です。設定値のデフォルト値は０で、桁数無制限という意味です。 nを指定しない場合は、現状の最大桁数が返ります。
mf = BigDecimal::limit(n)

• sign

値の属性を返します。 n = a.sign
としたとき n の値は a が以下のときを意味します。
() の中の数字は、実際の値です(「内部構造」を参照)。
n = BigDecimal::SIGN_NaN(0) : a は NaN
n = BigDecimal::SIGN_POSITIVE_ZERO(1) : a は +0
n = BigDecimal::SIGN_NEGATIVE_ZERO(-1) : a は -0
n = BigDecimal::SIGN_POSITIVE_FINITE(2) : a は正の値
n = BigDecimal::SIGN_NEGATIVE_FINITE(-2) : a は負の値
n = BigDecimal::SIGN_POSITIVE_INFINITE(3) : a は+Infinity
n = BigDecimal::SIGN_NEGATIVE_INFINITE(-3) : a は-Infinity

• nan?

a.nan? は a がNaNのとき真を返します。
• infinite?

a.infinite? は a が+∞または-∞のとき真を返します。
• finite?

a.finite? は a が∞または NaN でないとき真を返します。
• to_parts

BigDecimal 値を 0.xxxxxxx*10**n と表現したときに、符号（NaNのときは 0、それ以外は+1か-1になります）、 仮数部分の文字列（"xxxxxxx"）と、基数（10）、更に指数 n を配列で 返します。
a=BigDecimal::new("3.14159265",10)
f,x,y,z = a.to_parts
とすると、f=+1、x="314159265"、y=10、z=1になります。
従って、
s = "0."+x
b = f*(s.to_f)*(y**z)
で Float に変換することができます。
• inspect

デバッグ出力に使用されます。
p a=BigDecimal::new("3.14",10)
とすると、[0x112344:'0.314E1',4(12)]のように出力されます。 最初の16進数はオブジェクトのアドレス、次の '0.314E1' は値、 次の4は現在の有効桁数(表示より若干大きいことがあります)、 最後はオブジェクトが取り得る最大桁数になります。
• dup

同じ値の BigDecimal オブジェクトを生成します。
• sqrt

aの有効桁 n 桁の平方根（n の平方根ではありません）。 これまた、正直にニュートン法で計算します。
c = a.sqrt(n)

• sincos

a の有効桁 n 桁の sin と cos を同時に（テイラー展開で）計算して、 sin と cos の配列を返します。 n は必要な有効桁数です（ n の sin や cos を計算するわけではありません）。
sin,cos = a.sincos(n)
|a|<2*3.1415....でないと正しい答えを計算できないこともあります。
• exp

自然対数の底e(=2.718281828....)の a 乗を計算します。
c = a.exp(n)
n は必要な有効桁数です。
• power

a の n 乗を計算します。ｎは整数。
c = a.power(n)
結果として c の有効桁は a の n 倍以上になるので注意。
• zero?

a が 0 なら true になります。
c = a.zero?

• nonzero?

a が 0 なら false、0 以外なら a そのものが返ります。
c = a.nonzero?

• <=>

a==b なら 0、a > b なら 1、a < b なら -1 になります。
c = a <=> b

• ==
• ===
「==」と同じですが case 文で使用されます。
• !=
• <
• <=
• >
• >=

coerceについて

   a = BigDecimal.E(20)
   c = a * "0.123456789123456789123456789" # 文字を BigDecimal に変換してから計算

  a = BigDecimal.E(20)
  c = "0.123456789123456789123456789" * a # エラー

require "bigdecimal"

aa  = %w(1 -1 +0.0 -0.0 +Infinity -Infinity NaN)
ba  = %w(1 -1 +0.0 -0.0 +Infinity -Infinity NaN)
opa = %w(+ - * / <=> > >=  < == != <=)

for a in aa
  for b in ba
    for op in opa
      x = BigDecimal::new(a)
      y = BigDecimal::new(b)
      eval("ans= x #{op} y;print a,' ',op,' ',b,' ==> ',ans.to_s,\"\n\"")
    end
  end
end

  typedef struct {
     unsigned long MaxPrec; // 最大精度(frac[]の配列サイズ)
     unsigned long Prec;    // 精度(frac[]の使用サイズ)
     short    sign;         // 以下のように符号等の状態を定義します。
                            //  ==0 : NaN
                            //    1 : +0
                            //   -1 : -0
                            //    2 : 正の値
                            //   -2 : 負の値
                            //    3 : +Infinity
                            //   -3 : -Infinity
     unsigned short flag;   // 各種の制御フラッグ
     int      exponent;     // 指数部の値(仮数部*BASE**exponent)
     unsigned long frac[1]; // 仮数部の配列(可変)
  } Real;

    0.1234 5678 4321*(10000)**1

#!/usr/local/bin/ruby

#
# pai.rb
#  USAGE: ruby pai.rb n
#   where n is the number of digits required.
#  EX.: ruby pai.rb 1000
#

require "bigdecimal"
#
# Calculates 3.1415.... using J. Machin's formula.
#
def pai(sig) # sig: Number of significant figures
  exp    = -sig
  pi     = BigDecimal::new("0")
  two    = BigDecimal::new("2")
  m25    = BigDecimal::new("-0.04")
  m57121 = BigDecimal::new("-57121")

  u = BigDecimal::new("1")
  k = BigDecimal::new("1")
  w = BigDecimal::new("1")
  t = BigDecimal::new("-80")
  while (u.exponent >= exp) 
    t   = t*m25
    u,r = t.div(k,sig)
    pi  = pi + u
    k   = k+two
  end

  u = BigDecimal::new("1")
  k = BigDecimal::new("1")
  w = BigDecimal::new("1")
  t = BigDecimal::new("956")
  while (u.exponent >= exp )
    t,r = t.div(m57121,sig)
    u,r = t.div(k,sig)
    pi  = pi + u
    k   = k+two
  end
  pi
end

if $0 == __FILE__
  print "PAI("+ARGV[0]+"):\n"
  p pai(ARGV[0].to_i)
end