るりまプロジェクト

#@since 1.9.1

prime

#@end

#@until 1.9.1

#@# see prime.rd

#@end

#@until 1.9.1

#@since 1.9.1

素数や素因数分解を扱うライブラリです。

=== 例

  Prime.each(100) do |prime|

    p prime #=> 2, 3, 5, 7, 11, ..., 97

  end

= class Prime < Object

include Enumerable

全ての素数を表すクラスです。

=== インスタンスを取得する方法

[[m:Prime.new]] は非推奨です。[[m:Prime.instance]] を使用してください。

利便性のために [[c:Prime]] クラスのインスタンスメソッドはクラスメソッドとしても

アクセスすることができます。

例:

  Prime.instance.prime?(2)  #=> true

  Prime.prime?(2)           #=> true

=== 生成器

ジェネレータは擬似素数の列挙方法の実装を提供します。

またそれは、列挙状態や上限値を記憶します。

[[c:Enumerator]] と互換性のある外部イテレータでもあります。

[[c:Prime+::+PseudoPrimeGenerator]] はジェネレータのベースとなるクラスです。

ジェネレータの実装はいくつかあります。

: [[c:Prime+::EratosthenesGenerator]]

  エラトステネスの篩いを使用します。

: [[c:Prime+::TrialDivisionGenerator]]

  試行除算法を使用します。

: [[c:Prime+::Generator23]]

  2 と 3 で割り切れない全ての正の整数を生成します。

  この数列は素数の数列としては使い物になりません。しかし、他のジェネレータより速く、

  メモリの使用量も少ないという特徴があります。そのため、それほど大きくなくて、

  素数の要素を多く持つ整数の因数分解に向いています。

== Class Methods

--- each(upper_bound = nil, generator = EratosthenesGenerator.new){|prime| ... } -> object

--- each(upper_bound = nil, generator = EratosthenesGenerator.new)               -> object

全ての素数を順番に与えられたブロックに渡して評価します。

[[m:Prime.new]] は Ruby 1.8 への互換性のために [[c:Prime::OldCompatibility]] を

[[Kernel.#extend]] したオブジェクトを返します。

このオブジェクトでは [[m:Prime#each]] は [[m:Prime::OldCompatibility#each]] によって再定義されています。

[[m:Prime.new]] は非推奨です。代わりに Prime.instance.each または単純に Prime.each を使用してください。

@param upper_bound 任意の正の整数を指定します。列挙の上限値です。

                   nil が与えられた場合は無限に列挙し続けます。

@param generator 素数ジェネレータのインスタンスを指定します。

@return ブロックの最後に評価された値を返します。

        ブロックが与えられなかった場合は、[[c:Enumerator]] と互換性のある外部イテレータを返します。

例:

  Prime.each(6).each{|prime| prime }  # => 5

  Prime.each(7).each{|prime| prime }  # => 7

  Prime.each(10).each{|prime| prime } # => 7

  Prime.each(11).each{|prime| prime } # => 11

@see [[c:Prime::EratosthenesGenerator]], [[c:Prime::TrialDivisionGenerator]], [[c:Prime::Generator23]]

--- instance -> Prime

[[c:Prime]] のデフォルトのインスタンスを返します。

--- int_from_prime_division(pd) -> Integer

素因数分解された結果を元に戻します。

例えば、引数が [[p_1, e_1], [p_2, e_2], ...., [p_n, e_n]] のように表せるとき、

結果は  p_1**e_1 * p_2**e_2 * .... * p_n**e_n のようになります。

@param pd 整数のペアの配列を指定します。含まれているペアの第一要素は素数で、

          第二要素はその素数の個数をあらわします。

例:

  Prime.int_from_prime_division([[2,2], [3,1]])  #=> 12

  Prime.int_from_prime_division([[2,2], [3,2]])  #=> 36

--- prime?(value, generator = Prime::Generator23.new) -> bool

与えられた整数が素数である場合は、真を返します。

そうでない場合は偽を返します。

@param value 素数かどうかチェックする任意の整数を指定します。

@param generator 素数ジェネレータのインスタンスを指定します。

@see [[c:Prime::EratosthenesGenerator]], [[c:Prime::TrialDivisionGenerator]], [[c:Prime::Generator23]]

--- prime_division(value, generator= Prime::Generator23.new) -> Array

与えられた整数を素因数分解した結果を返します。

@param value 素因数分解する任意の整数を指定します。

@param generator 素数ジェネレータのインスタンスを指定します。

@raise ZeroDivisionError 与えられた数値がゼロである場合に発生します。

例:

    Prime.prime_division(12) #=> [[2,2], [3,1]]

    Prime.prime_division(10) #=> [[2,1], [5,1]]

@see [[c:Prime::EratosthenesGenerator]], [[c:Prime::TrialDivisionGenerator]], [[c:Prime::Generator23]]

== Instance Methods

--- each(upper_bound = nil, generator = EratosthenesGenerator.new){|prime| ... } -> object

--- each(upper_bound = nil, generator = EratosthenesGenerator.new)               -> object

全ての素数を順番に与えられたブロックに渡して評価します。

[[m:Prime.new]] は Ruby 1.8 への互換性のために [[c:Prime::OldCompatibility]] を

[[Kernel.#extend]] したオブジェクトを返します。

このオブジェクトでは [[m:Prime#each]] は [[m:Prime::OldCompatibility#each]] によって再定義されています。

[[m:Prime.new]] は非推奨です。代わりに Prime.instance.each または単純に Prime.each を使用してください。

@param upper_bound 任意の正の整数を指定します。列挙の上限値です。

                   nil が与えられた場合は無限に列挙し続けます。

@param generator 素数ジェネレータのインスタンスを指定します。

@return ブロックの最後に評価された値を返します。

        ブロックが与えられなかった場合は、[[c:Enumerator]] と互換性のある外部イテレータを返します。

例:

  Prime.instance.each(6).each{|prime| prime }  # => 5

  Prime.instance.each(7).each{|prime| prime }  # => 7

  Prime.instance.each(10).each{|prime| prime } # => 7

  Prime.instance.each(11).each{|prime| prime } # => 11

@see [[c:Prime::EratosthenesGenerator]], [[c:Prime::TrialDivisionGenerator]], [[c:Prime::Generator23]]

--- int_from_prime_division -> Integer

素因数分解された結果を元に戻します。

例えば、引数が [[p_1, e_1], [p_2, e_2], ...., [p_n, e_n]] のように表せるとき、

結果は  p_1**e_1 * p_2**e_2 * .... * p_n**e_n のようになります。

@param pd 整数のペアの配列を指定します。含まれているペアの第一要素は素数で、

          第二要素はその素数の個数をあらわします。

例:

  Prime.instance.int_from_prime_division([[2,2], [3,1]])  #=> 12

  Prime.instance.int_from_prime_division([[2,2], [3,2]])  #=> 36

--- prime? -> bool

与えられた整数が素数である場合は、真を返します。

そうでない場合は偽を返します。

@param value 素数かどうかチェックする任意の整数を指定します。

@param generator 素数ジェネレータのインスタンスを指定します。

@see [[c:Prime::EratosthenesGenerator]], [[c:Prime::TrialDivisionGenerator]], [[c:Prime::Generator23]]

--- prime_division -> Array

与えられた整数を素因数分解した結果を返します。

@param value 素因数分解する任意の整数を指定します。

@param generator 素数ジェネレータのインスタンスを指定します。

@raise ZeroDivisionError 与えられた数値がゼロである場合に発生します。

例:

    Prime.instance.prime_division(12) #=> [[2,2], [3,1]]

    Prime.instance.prime_division(10) #=> [[2,1], [5,1]]

@see [[c:Prime::EratosthenesGenerator]], [[c:Prime::TrialDivisionGenerator]], [[c:Prime::Generator23]]

= class Prime::PseudoPrimeGenerator < Object

include Enumerable

擬似素数を列挙するための抽象クラスです。

このクラスを継承する具象クラスは succ, next, rewind を定義しなければなりません。

== Class Methods

--- new(upper_bound = nil)

自身を初期化します。

@param upper_bound 上限を指定します。

== Instance Methods

--- each {|prime| ... } -> object

--- each -> self

素数を与えられたブロックに渡して評価します。

--- next -> ()

--- succ -> ()

次の擬似素数を返します。

また内部的な位置を進めます。

サブクラスで実装してください。

@raise NotImplementedError 必ず発生します。

--- rewind -> ()

列挙状態を巻き戻します。

サブクラスで実装してください。

@raise NotImplementedError 必ず発生します。

@see [[m:Enumerator#rewind]]

--- upper_bound -> Integer

現在の上限を返します。

--- upper_bound=(upper_bound)

新しい上限をセットします。

@param upper_bound 新しい上限を指定します。

--- with_index{|prime, index| ... }      -> self

--- each_with_index{|prime, index| ... } -> self

--- with_index      -> Enumerator

--- each_with_index -> Enumerator

素数とそのインデックスを与えられたブロックに渡して評価します。

例:

  Prime::EratosthenesGenerator.new(10).each_with_index do |prime, index|

    p [prime, index]

  end

  # [2, 0]

  # [3, 1]

  # [5, 2]

  # [7, 3]

@see [[m:Enumerator#with_index]]

--- with_object(obj){|prime, obj| ... } -> object

#@todo

与えられた任意のオブジェクトと要素をブロックに渡して評価します。

最初に与えられたオブジェクトを返します。

@param obj 任意のオブジェクトを指定します。

@see [[m:Enumerator#with_object]]

= class Prime::EratosthenesGenerator < PseudoPrimeGenerator

[[c:PseudoPrimeGenerator]] の具象クラスです。

素数の生成にエラトステネスのふるいを使用しています。

== Instance Methods

--- next -> Integer

--- succ -> Integer

次の素数を返します。

また内部的な位置を進めます。

--- rewind -> nil

列挙状態を巻き戻します。

= class Prime::TrialDivisionGenerator < PseudoPrimeGenerator

[[c:PseudoPrimeGenerator]] の具象クラスです。

素数の生成に試行除算法を使用しています。

== Instance Methods

--- next -> Integer

--- succ -> Integer

次の素数を返します。

また内部的な位置を進めます。

--- rewind -> nil

列挙状態を巻き戻します。

= class Prime::Generator23 < PseudoPrimeGenerator

2 より大きくて 2 と 3 で割り切れない全ての整数を生成します。

これはある整数の素数性を総当たりでチェックするのに適した擬似素数のジェネレータです。

== Instance Methods

--- next -> Integer

--- succ -> Integer

次の素数を返します。

また内部的な位置を進めます。

--- rewind -> nil

列挙状態を巻き戻します。

#@# = class Prime::EratosthenesSieve < Object

#@# internal use

#@# = class Prime::TrialDivision < Object

#@# internal use

= module Prime::OldCompatibility

Ruby1.8 との互換性のためのモジュールです。

[[m:Prime.new]] が呼び出されたときに有効になります。

== Instance Methods

--- next -> Integer

--- succ -> Integer

次の素数を返します。

--- each{|prime| ... } -> object

--- each               -> object

[[m:Prime#each]] を再定義します。

全ての素数を列挙し、それぞれの素数をブロックに渡して評価します。

無限ループになるので必ず break を入れてください。

呼び出される度に列挙状態が巻き戻されることはありません。

@return ブロック付きで呼び出された場合は break の引数が返り値になります。

        ブロック無しで呼び出された場合は [[c:Prime::EratosthenesGenerator]] のインスタンスを返します。

= reopen Integer

== Class Methods

--- from_prime_division(pd) -> Integer

素因数分解された結果を元の数値に戻します。

@param pd 整数のペアの配列を指定します。

@see [[m:Prime#from_prime_division]]

--- each_prime(upper_bound){|prime| ... } -> object

--- each_prime(upper_bound) -> object

全ての素数を列挙し、それぞれの素数をブロックに渡して評価します。

@param upper_bound 上限値を指定します。nil を指定すると全ての素数を列挙します。

@see [[m:Prime#each]]

== Instance Methods

--- prime_division(generator = Prime::Generator23.new) -> Array

自身を素因数分解した結果を返します。

@param generator 素数ジェネレータのインスタンスを指定します。

@see [[m:Prime#prime_division]]

--- prime? -> bool

自身が素数である場合、真を返します。

そうでない場合は偽を返します。

例:

  1.prime? # => false

  2.prime? # => true

@see [[m:Prime#prime?]]

#@end