package topological_sort

  1. Overview
  2. Docs

Module Topological_sortSource

Sourcemodule type Node = sig ... end
Sourcemodule Edge : sig ... end
Sourcemodule Traversal_order : sig ... end

Controls the order in which we begin traversing nodes as entry points into the graph. The earliest nodes with finished traversals are returned last.

Sourcemodule What : sig ... end
Sourceval sort : ?traversal_order:Traversal_order.t -> ?verbose:Base.Bool.t -> ?verify:Base.Bool.t -> (module Node with type t = 'node) -> what:What.t -> nodes:'node Base.List.t -> edges:'node Edge.t Base.List.t -> 'node Base.List.t Base.Or_error.t

sort (module Nodes) ~what ~nodes ~edges returns a list of nodes output satisfying:

  • output contains one occurrence of every node in nodes when what = Nodes, or one occurrence of every node in nodes and edges when what = Nodes_and_edge_endpoints.
  • if { from; to_ } is in edges, then from occurs before to_ in output.

sort returns Error if there is a cycle.

traversal_order determines the order in which we processing nodes as entry points into the graph.

verify checks that the sorted output or generated cycle is indeed correct.

Sourceval sort_or_cycle : ?traversal_order:Traversal_order.t -> ?verbose:Base.Bool.t -> ?verify:Base.Bool.t -> (module Node with type t = 'node) -> what:What.t -> nodes:'node Base.List.t -> edges:'node Edge.t Base.List.t -> ('node Base.List.t, [ `Cycle of 'node Base.List.t ]) Base.Result.t

Same as sort, but returns the cycle if there is one.