модуль TSort

TSort реализует топологическую сортировку с использованием алгоритма Тарьяна для поиска компонент сильной связности.

TSort разработан для использования с любым объектом, который можно интерпретировать как ориентированный граф.

TSort требует наличия двух методов для интерпретации объекта как графа: tsort_each_node и tsort_each_child.

tsort_each_node используется для перебора всех узлов графа.
tsort_each_child используется для перебора дочерних узлов заданного узла.

Равенство узлов определяется методами eql? и hash, поскольку TSort использует внутри себя Hash.

Простой пример

В следующем примере показано, как подключить модуль TSort к существующему классу (в данном случае — к Hash). Здесь мы рассматриваем каждый ключ хеша как узел графа, поэтому просто создаём псевдоним обязательного метода tsort_each_node, указывающий на метод Hash each_key. Для каждого ключа хеша соответствующее значение представляет собой массив дочерних узлов этого узла. В свою очередь, этот подход определяет реализацию обязательного метода tsort_each_child: он получает массив дочерних узлов, а затем перебирает его, используя переданный пользователем блок.

require 'tsort'

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

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

{1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}.strongly_connected_components
#=> [[4], [2, 3], [1]]

Более реалистичный пример

Очень простой инструмент, подобный make, можно реализовать следующим образом:

require 'tsort'

class Make
  def initialize
    @dep = {}
    @dep.default = []
  end

  def rule(outputs, inputs=[], &block)
    triple = [outputs, inputs, block]
    outputs.each {|f| @dep[f] = [triple]}
    @dep[triple] = inputs
  end

  def build(target)
    each_strongly_connected_component_from(target) {|ns|
      if ns.length != 1
        fs = ns.delete_if {|n| Array === n}
        raise TSort::Cyclic.new("cyclic dependencies: #{fs.join ', '}")
      end
      n = ns.first
      if Array === n
        outputs, inputs, block = n
        inputs_time = inputs.map {|f| File.mtime f}.max
        begin
          outputs_time = outputs.map {|f| File.mtime f}.min
        rescue Errno::ENOENT
          outputs_time = nil
        end
        if outputs_time == nil ||
           inputs_time != nil && outputs_time <= inputs_time
          sleep 1 if inputs_time != nil && inputs_time.to_i == Time.now.to_i
          block.call
        end
      end
    }
  end

  def tsort_each_child(node, &block)
    @dep[node].each(&block)
  end
  include TSort
end

def command(arg)
  print arg, "\n"
  system arg
end

m = Make.new
m.rule(%w[t1]) { command 'date > t1' }
m.rule(%w[t2]) { command 'date > t2' }
m.rule(%w[t3]) { command 'date > t3' }
m.rule(%w[t4], %w[t1 t3]) { command 'cat t1 t3 > t4' }
m.rule(%w[t5], %w[t4 t2]) { command 'cat t4 t2 > t5' }
m.build('t5')

Ошибки

Имя «tsort.rb» выбрано неверно, поскольку эта библиотека использует алгоритм Тарьяна для поиска компонент сильной связности. Хотя «strongly_connected_components.rb» — подходящее имя, оно слишком длинное.

Ссылки

1. Тарьян, «Поиск в глубину и линейные алгоритмы для графов»,

SIAM Journal on Computing, том 1, № 2, с. 146–160, июнь 1972 г.

Константы

VERSION

Общедоступные методы класса

each_strongly_connected_component (each_node, each_child) { |nodes| ... } Показать исходный код

# File lib/tsort.rb, line 345
def self.each_strongly_connected_component(each_node, each_child) # :yields: nodes
  return to_enum(__method__, each_node, each_child) unless block_given?

  id_map = {}
  stack = []
  each_node.call {|node|
    unless id_map.include? node
      each_strongly_connected_component_from(node, each_child, id_map, stack) {|c|
        yield c
      }
    end
  }
  nil
end

Итераторная версия метода TSort.strongly_connected_components.

Граф задаётся с помощью each_node и each_child. У each_node должен быть метод call, который выдаёт каждый узел графа. У each_child должен быть метод call, который принимает аргумент-узел и выдаёт каждый дочерний узел.

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]

each_strongly_connected_component_from (node, each_child, id_map={}, stack=[]) { |nodes| ... } Показать исходный код

# File lib/tsort.rb, line 411
def self.each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) # :yields: nodes
  return to_enum(__method__, node, each_child, id_map, stack) unless block_given?

  minimum_id = node_id = id_map[node] = id_map.size
  stack_length = stack.length
  stack << node

  each_child.call(node) {|child|
    if id_map.include? child
      child_id = id_map[child]
      minimum_id = child_id if child_id && child_id < minimum_id
    else
      sub_minimum_id =
        each_strongly_connected_component_from(child, each_child, id_map, stack) {|c|
          yield c
        }
      minimum_id = sub_minimum_id if sub_minimum_id < minimum_id
    end
  }

  if node_id == minimum_id
    component = stack.slice!(stack_length .. -1)
    component.each {|n| id_map[n] = nil}
    yield component
  end

  minimum_id
end

Перебирает компоненты сильной связности графа. Граф задаётся с помощью node и each_child.

node — первый узел. У each_child должен быть метод call, который принимает аргумент-узел и выдаёт каждый дочерний узел.

Возвращаемое значение не определено.

TSort.each_strongly_connected_component_from — это метод класса, которому не требуется класс для представления графа, включающий 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]

strongly_connected_components (each_node, each_child) Показать исходный код

# File lib/tsort.rb, line 283
def self.strongly_connected_components(each_node, each_child)
  each_strongly_connected_component(each_node, each_child).to_a
end

Возвращает компоненты сильной связности в виде массива массивов узлов. Массив отсортирован от дочерних узлов к родительским. Каждый элемент массива представляет собой компоненту сильной связности.

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]]

tsort (each_node, each_child) Показать исходный код

# File lib/tsort.rb, line 178
def self.tsort(each_node, each_child)
  tsort_each(each_node, each_child).to_a
end

Возвращает массив узлов, отсортированных топологически. Массив отсортирован от дочерних узлов к родительским: у первого элемента нет дочерних узлов, а у последнего узла нет родительских.

Если в графе есть цикл, генерируется исключение TSort::Cyclic.

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

tsort_each (each_node, each_child) { |node| ... } Показать исходный код

# File lib/tsort.rb, line 226
def self.tsort_each(each_node, each_child) # :yields: node
  return to_enum(__method__, each_node, each_child) unless block_given?

  each_strongly_connected_component(each_node, each_child) {|component|
    if component.size == 1
      yield component.first
    else
      raise Cyclic.new("topological sort failed: #{component.inspect}")
    end
  }
end

Итераторная версия метода TSort.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

Общедоступные методы экземпляра

each_strongly_connected_component () { |nodes| ... } Показать исходный код

# File lib/tsort.rb, line 316
def each_strongly_connected_component(&block) # :yields: nodes
  each_node = method(:tsort_each_node)
  each_child = method(:tsort_each_child)
  TSort.each_strongly_connected_component(each_node, each_child, &block)
end

Итераторная версия метода strongly_connected_components. obj.each_strongly_connected_component похож на obj.strongly_connected_components.each, но изменение obj во время итерации может привести к неожиданным результатам.

each_strongly_connected_component возвращает nil.

class G
  include TSort
  def initialize(g)
    @g = g
  end
  def tsort_each_child(n, &b) @g[n].each(&b) end
  def tsort_each_node(&b) @g.each_key(&b) end
end

graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
graph.each_strongly_connected_component {|scc| p scc }
#=> [4]
#   [2]
#   [3]
#   [1]

graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
graph.each_strongly_connected_component {|scc| p scc }
#=> [4]
#   [2, 3]
#   [1]

each_strongly_connected_component_from (node, id_map={}, stack=[]) { |nodes| ... } Показать исходный код

# File lib/tsort.rb, line 386
def each_strongly_connected_component_from(node, id_map={}, stack=[], &block) # :yields: nodes
  TSort.each_strongly_connected_component_from(node, method(:tsort_each_child), id_map, stack, &block)
end

Перебирает компоненты сильной связности в подграфе, достижимом из node.

Возвращаемое значение не определено.

each_strongly_connected_component_from не вызывает tsort_each_node.

class G
  include TSort
  def initialize(g)
    @g = g
  end
  def tsort_each_child(n, &b) @g[n].each(&b) end
  def tsort_each_node(&b) @g.each_key(&b) end
end

graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
graph.each_strongly_connected_component_from(2) {|scc| p scc }
#=> [4]
#   [2]

graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
graph.each_strongly_connected_component_from(2) {|scc| p scc }
#=> [4]
#   [2, 3]

strongly_connected_components () Показать исходный код

# File lib/tsort.rb, line 257
def strongly_connected_components
  each_node = method(:tsort_each_node)
  each_child = method(:tsort_each_child)
  TSort.strongly_connected_components(each_node, each_child)
end

class G
  include TSort
  def initialize(g)
    @g = g
  end
  def tsort_each_child(n, &b) @g[n].each(&b) end
  def tsort_each_node(&b) @g.each_key(&b) end
end

graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
p graph.strongly_connected_components #=> [[4], [2], [3], [1]]

graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
p graph.strongly_connected_components #=> [[4], [2, 3], [1]]

tsort () Показать исходный код

# File lib/tsort.rb, line 152
def tsort
  each_node = method(:tsort_each_node)
  each_child = method(:tsort_each_child)
  TSort.tsort(each_node, each_child)
end

Если в графе есть цикл, генерируется исключение TSort::Cyclic.

class G
  include TSort
  def initialize(g)
    @g = g
  end
  def tsort_each_child(n, &b) @g[n].each(&b) end
  def tsort_each_node(&b) @g.each_key(&b) end
end

graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
p graph.tsort #=> [4, 2, 3, 1]

graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
p graph.tsort # raises TSort::Cyclic

tsort_each () { |node| ... } Показать исходный код

# File lib/tsort.rb, line 205
def tsort_each(&block) # :yields: node
  each_node = method(:tsort_each_node)
  each_child = method(:tsort_each_child)
  TSort.tsort_each(each_node, each_child, &block)
end

Итераторная версия метода tsort. obj.tsort_each похож на obj.tsort.each, но изменение obj во время итерации может привести к неожиданным результатам.

tsort_each возвращает nil. Если в графе есть цикл, генерируется исключение TSort::Cyclic.

class G
  include TSort
  def initialize(g)
    @g = g
  end
  def tsort_each_child(n, &b) @g[n].each(&b) end
  def tsort_each_node(&b) @g.each_key(&b) end
end

graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
graph.tsort_each {|n| p n }
#=> 4
#   2
#   3
#   1

tsort_each_child (node) { |child| ... } Показать исходный код

# File lib/tsort.rb, line 452
def tsort_each_child(node) # :yields: child
  raise NotImplementedError.new
end

Должен быть реализован производным классом.

tsort_each_child используется для перебора дочерних узлов node.

tsort_each_node () { |node| ... } Показать исходный код

# File lib/tsort.rb, line 444
def tsort_each_node # :yields: node
  raise NotImplementedError.new
end

Должен быть реализован производным классом.

tsort_each_node используется для перебора всех узлов графа.

Ruby Core © 1993–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.