module TSort (Ruby 3.0 リファレンスマニュアル)

要約

TSort は強連結成分に関する Tarjan のアルゴリズムを用いたトポロジカルソートの実装です。

TSort は任意のオブジェクトを有向グラフとして解釈できるように設計されています。 TSort がオブジェクトをグラフとして解釈するには2つのメソッドを要求します。すなわち、tsort_each_node と tsort_each_child です。

tsort_each_node はグラフ上のすべての頂点を巡回するのに用いられます。
tsort_each_child は与えられた頂点の子を巡回するのに用いられます。

頂点同士の等価性は eql? と hash によって定義されます。これは TSort が内部でハッシュを用いているからです。

特異メソッド

each_strongly_connected_component(each_node, each_child) {|nodes| ...} -> nil[permalink][rdoc][edit]

each_strongly_connected_component(each_node, each_child) -> Enumerator

TSort.strongly_connected_components メソッドのイテレータ版です。

引数 each_node と each_child でグラフを表します。

[PARAM] each_node:: グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。
[PARAM] each_child:: 引数で与えられた頂点の子をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。

使用例

require 'tsort'

g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
TSort.each_strongly_connected_component(each_node, each_child) {|scc| p scc }

# => [4]
#    [2]
#    [3]
#    [1]

g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
TSort.each_strongly_connected_component(each_node, each_child) {|scc| p scc }

# => [4]
#    [2, 3]
#    [1]

[SEE_ALSO] TSort#each_strongly_connected_component

each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) {|nodes| ...} -> ()[permalink][rdoc][edit]

each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) -> Enumerator

node から到達可能な強連結成分についてのイテレータです。

引数 node と each_child でグラフを表します。

返す値は規定されていません。

TSort.each_strongly_connected_component_fromはTSortをincludeしてグラフを表現する必要のないクラスメソッドです。

[PARAM] node:: ノードを指定します。
[PARAM] each_child:: 引数で与えられた頂点の子をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。

使用例

require 'tsort'

graph = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
each_child = lambda {|n, &b| graph[n].each(&b) }
TSort.each_strongly_connected_component_from(1, each_child) {|scc|
  p scc
}
# => [4]
#    [2, 3]
#    [1]

[SEE_ALSO] TSort#each_strongly_connected_component_from

strongly_connected_components(each_node, each_child) -> Array[permalink][rdoc][edit]

強連結成分の集まりを配列の配列として返します。この配列は子から親に向かってソートされています。各要素は強連結成分を表す配列です。

引数 each_node と each_child でグラフを表します。

[PARAM] each_node:: グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。
[PARAM] each_child:: 引数で与えられた頂点の子をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。

使用例

require 'tsort'

g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
p TSort.strongly_connected_components(each_node, each_child)
# => [[4], [2], [3], [1]]

g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
p TSort.strongly_connected_components(each_node, each_child)
# => [[4], [2, 3], [1]]

[SEE_ALSO] TSort#strongly_connected_components

tsort(each_node, each_child) -> Array[permalink][rdoc][edit]

頂点をトポロジカルソートして得られる配列を返します。この配列は子から親に向かってソートされています。すなわち、最初の要素は子を持たず、最後の要素は親を持ちません。

引数 each_node と each_child でグラフを表します。

[PARAM] each_node:: グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。
[PARAM] each_child:: 引数で与えられた頂点の子をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。
[EXCEPTION] TSort::Cyclic:: 閉路が存在するとき、発生します。

使用例

require 'tsort'

g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
p TSort.tsort(each_node, each_child) # => [4, 2, 3, 1]

g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
p TSort.tsort(each_node, each_child) # raises TSort::Cyclic

[SEE_ALSO] TSort#tsort

tsort_each(each_node, each_child) {|node| ...} -> nil[permalink][rdoc][edit]

tsort_each(each_node, each_child) -> Enumerator

TSort.tsort メソッドのイテレータ版です。

引数 each_node と each_child でグラフを表します。

[PARAM] each_node:: グラフ上の頂点をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。
[PARAM] each_child:: 引数で与えられた頂点の子をそれぞれ評価するcallメソッドを持つオブジェクトを指定します。
[EXCEPTION] TSort::Cyclic:: 閉路が存在するとき、発生します.

使用例

require 'tsort'

g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
each_node = lambda {|&b| g.each_key(&b) }
each_child = lambda {|n, &b| g[n].each(&b) }
TSort.tsort_each(each_node, each_child) {|n| p n }
# => 4
#    2
#    3
#    1

[SEE_ALSO] TSort#tsort_each

インスタンスメソッド

each_strongly_connected_component {|nodes| ...} -> nil[permalink][rdoc][edit]

each_strongly_connected_component -> Enumerator

TSort#strongly_connected_components メソッドのイテレータ版です。 obj.each_strongly_connected_component は obj.strongly_connected_components.each に似ていますが、ブロックの評価中に obj が変更された場合は予期しない結果になることがあります。

each_strongly_connected_component は nil を返します。

使用例

require 'tsort'

class Hash
  include TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

non_sort = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}

non_sort.each_strongly_connected_component{|nodes|
  p nodes
}

#出力
#=> [4]
#=> [2, 3]
#=> [1]

[SEE_ALSO] TSort.each_strongly_connected_component

each_strongly_connected_component_from(node, id_map={}, stack=[]) {|nodes| ...} -> ()[permalink][rdoc][edit]

each_strongly_connected_component_from(node, id_map={}, stack=[]) -> Enumerator

node から到達可能な強連結成分についてのイテレータです。

返す値は規定されていません。

each_strongly_connected_component_from は tsort_each_node を呼びません。

[PARAM] node:: ノードを指定します。

例 到達可能なノードを表示する

require 'tsort'

class Hash
  include TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

non_sort = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}

non_sort.each_strongly_connected_component{|nodes|
  p nodes
  nodes.each {|node|
    non_sort.each_strongly_connected_component_from(node){|ns|
      printf("%s -> %s\n", node, ns.join(","))
    }
  }
}

#出力
#=> [4]
#=> 4 -> 4
#=> [2, 3]
#=> 2 -> 4
#=> 2 -> 2,3
#=> 3 -> 4
#=> 3 -> 3,2
#=> [1]
#=> 1 -> 4
#=> 1 -> 2,3
#=> 1 -> 1

[SEE_ALSO] TSort.each_strongly_connected_component_from

strongly_connected_components -> Array[permalink][rdoc][edit]

強連結成分の集まりを配列の配列として返します。この配列は子から親に向かってソートされています。各要素は強連結成分を表す配列です。

使用例

require 'tsort'

class Hash
  include TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

non_sort = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}

p non_sort.strongly_connected_components
#=> [[4], [2, 3], [1]]

[SEE_ALSO] TSort.strongly_connected_components

tsort -> Array[permalink][rdoc][edit]

[EXCEPTION] TSort::Cyclic:: 閉路が存在するとき、発生します。

使用例

require 'tsort'

class Hash
  include TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

sorted = {1=>[2, 3], 2=>[3], 3=>[], 4=>[]}.tsort
p sorted #=> [3, 2, 1, 4]

[SEE_ALSO] TSort.tsort

tsort_each {|node| ...} -> nil[permalink][rdoc][edit]

tsort_each -> Enumerator

TSort#tsort メソッドのイテレータ版です。 obj.tsort_each は obj.tsort.each と似ていますが、ブロックの評価中に obj が変更された場合は予期しない結果になることがあります。

tsort_each は nil を返します。閉路が存在するとき、例外 TSort::Cyclic を起こします。

[EXCEPTION] TSort::Cyclic:: 閉路が存在するとき、発生します.

使用例

require 'tsort'

class Hash
  include TSort
  alias tsort_each_node each_key
  def tsort_each_child(node, &block)
    fetch(node).each(&block)
  end
end

non_sort = {1=>[2, 3], 2=>[3], 3=>[], 4=>[]}

non_sort.tsort_each {|node|
  non_sort.tsort_each_child(node){|child|
    printf("%d -> %d\n", node, child)
  }
}

# 出力
#=> 2 -> 3
#=> 1 -> 2
#=> 1 -> 3

[SEE_ALSO] TSort.tsort_each

tsort_each_child(node) {|child| ...} -> ()[permalink][rdoc][edit]

TSort で拡張されるクラスで定義されていなければならないメソッドです。

tsort_each_child is used to iterate for child nodes of node.

[PARAM] node:: ノードを指定します。
[EXCEPTION] NotImplementedError:: TSort で拡張されるクラスで定義されていない場合発生します。

tsort_each_node {|node| ...} -> ()[permalink][rdoc][edit]

TSort で拡張されるクラスで定義されていなければならないメソッドです。

tsort_each_node is used to iterate for all nodes over a graph.

[EXCEPTION] NotImplementedError:: TSort で拡張されるクラスで定義されていない場合発生します。

要約

目次

特異メソッド

インスタンスメソッド