модуль 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's 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. Tarjan, «Поиск в глубину и линейные алгоритмы для графов»,

SIAM Journal on Computing, Том 1, № 2, стр. 146-160, Июнь 1972.

Методы публичного класса

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

# File lib/tsort.rb, line 342
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 408
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 280
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 175
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 223
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 313
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 383
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 254
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 149
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 202
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 449
def tsort_each_child(node) # :yields: child
  raise NotImplementedError.new
end

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

tsort_each_child используется для итерации по дочерним узлам node.

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

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

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

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

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