← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tsort.py

  • Committer: Patch Queue Manager
  • Date: 2014-02-12 18:22:22 UTC
  • mfrom: (6589.2.1 trunk)
  • Revision ID: pqm@pqm.ubuntu.com-20140212182222-beouo25gaf1cny76
(vila) The XDG Base Directory Specification uses the XDG_CACHE_HOME,
 not XDG_CACHE_DIR. (Andrew Starr-Bochicchio)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tsort.py
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
18
17
"""Topological sorting routines."""
19
18
 
20
 
 
21
 
from bzrlib import errors
22
 
import bzrlib.revision as _mod_revision
 
19
from __future__ import absolute_import
 
20
 
 
21
 
 
22
from bzrlib import (
 
23
    errors,
 
24
    graph as _mod_graph,
 
25
    revision as _mod_revision,
 
26
    )
23
27
 
24
28
 
25
29
__all__ = ["topo_sort", "TopoSorter", "merge_sort", "MergeSorter"]
30
34
 
31
35
    graph -- sequence of pairs of node->parents_list.
32
36
 
33
 
    The result is a list of node names, such that all parents come before
34
 
    their children.
 
37
    The result is a list of node names, such that all parents come before their
 
38
    children.
35
39
 
36
40
    node identifiers can be any hashable object, and are typically strings.
 
41
 
 
42
    This function has the same purpose as the TopoSorter class, but uses a
 
43
    different algorithm to sort the graph. That means that while both return a
 
44
    list with parents before their child nodes, the exact ordering can be
 
45
    different.
 
46
 
 
47
    topo_sort is faster when the whole list is needed, while when iterating
 
48
    over a part of the list, TopoSorter.iter_topo_order should be used.
37
49
    """
38
 
    return TopoSorter(graph).sorted()
 
50
    kg = _mod_graph.KnownGraph(dict(graph))
 
51
    return kg.topo_sort()
39
52
 
40
53
 
41
54
class TopoSorter(object):
60
73
        iteration or sorting may raise GraphCycleError if a cycle is present
61
74
        in the graph.
62
75
        """
63
 
        # a dict of the graph.
 
76
        # store a dict of the graph.
64
77
        self._graph = dict(graph)
65
 
        self._visitable = set(self._graph)
66
 
        ### if debugging:
67
 
        # self._original_graph = dict(graph)
68
 
 
69
 
        # this is a stack storing the depth first search into the graph.
70
 
        self._node_name_stack = []
71
 
        # at each level of 'recursion' we have to check each parent. This
72
 
        # stack stores the parents we have not yet checked for the node at the
73
 
        # matching depth in _node_name_stack
74
 
        self._pending_parents_stack = []
75
 
        # this is a set of the completed nodes for fast checking whether a
76
 
        # parent in a node we are processing on the stack has already been
77
 
        # emitted and thus can be skipped.
78
 
        self._completed_node_names = set()
79
78
 
80
79
    def sorted(self):
81
80
        """Sort the graph and return as a list.
100
99
        After finishing iteration the sorter is empty and you cannot continue
101
100
        iteration.
102
101
        """
103
 
        while self._graph:
 
102
        graph = self._graph
 
103
        visitable = set(graph)
 
104
 
 
105
        # this is a stack storing the depth first search into the graph.
 
106
        pending_node_stack = []
 
107
        # at each level of 'recursion' we have to check each parent. This
 
108
        # stack stores the parents we have not yet checked for the node at the
 
109
        # matching depth in pending_node_stack
 
110
        pending_parents_stack = []
 
111
 
 
112
        # this is a set of the completed nodes for fast checking whether a
 
113
        # parent in a node we are processing on the stack has already been
 
114
        # emitted and thus can be skipped.
 
115
        completed_node_names = set()
 
116
 
 
117
        while graph:
104
118
            # now pick a random node in the source graph, and transfer it to the
105
 
            # top of the depth first search stack.
106
 
            node_name, parents = self._graph.popitem()
107
 
            self._push_node(node_name, parents)
108
 
            while self._node_name_stack:
109
 
                # loop until this call completes.
110
 
                parents_to_visit = self._pending_parents_stack[-1]
111
 
                # if all parents are done, the revision is done
 
119
            # top of the depth first search stack of pending nodes.
 
120
            node_name, parents = graph.popitem()
 
121
            pending_node_stack.append(node_name)
 
122
            pending_parents_stack.append(list(parents))
 
123
 
 
124
            # loop until pending_node_stack is empty
 
125
            while pending_node_stack:
 
126
                parents_to_visit = pending_parents_stack[-1]
 
127
                # if there are no parents left, the revision is done
112
128
                if not parents_to_visit:
113
129
                    # append the revision to the topo sorted list
114
 
                    # all the nodes parents have been added to the output, now
115
 
                    # we can add it to the output.
116
 
                    yield self._pop_node()
 
130
                    # all the nodes parents have been added to the output,
 
131
                    # now we can add it to the output.
 
132
                    popped_node = pending_node_stack.pop()
 
133
                    pending_parents_stack.pop()
 
134
                    completed_node_names.add(popped_node)
 
135
                    yield popped_node
117
136
                else:
118
 
                    while self._pending_parents_stack[-1]:
119
 
                        # recurse depth first into a single parent
120
 
                        next_node_name = self._pending_parents_stack[-1].pop()
121
 
                        if next_node_name in self._completed_node_names:
122
 
                            # this parent was completed by a child on the
123
 
                            # call stack. skip it.
124
 
                            continue
125
 
                        if next_node_name not in self._visitable:
126
 
                            continue
127
 
                        # otherwise transfer it from the source graph into the
128
 
                        # top of the current depth first search stack.
129
 
                        try:
130
 
                            parents = self._graph.pop(next_node_name)
131
 
                        except KeyError:
132
 
                            # if the next node is not in the source graph it has
133
 
                            # already been popped from it and placed into the
134
 
                            # current search stack (but not completed or we would
135
 
                            # have hit the continue 4 lines up.
136
 
                            # this indicates a cycle.
137
 
                            raise errors.GraphCycleError(self._node_name_stack)
138
 
                        self._push_node(next_node_name, parents)
139
 
                        # and do not continue processing parents until this 'call'
140
 
                        # has recursed.
141
 
                        break
142
 
 
143
 
    def _push_node(self, node_name, parents):
144
 
        """Add node_name to the pending node stack.
145
 
 
146
 
        Names in this stack will get emitted into the output as they are popped
147
 
        off the stack.
148
 
        """
149
 
        self._node_name_stack.append(node_name)
150
 
        self._pending_parents_stack.append(list(parents))
151
 
 
152
 
    def _pop_node(self):
153
 
        """Pop the top node off the stack
154
 
 
155
 
        The node is appended to the sorted output.
156
 
        """
157
 
        # we are returning from the flattened call frame:
158
 
        # pop off the local variables
159
 
        node_name = self._node_name_stack.pop()
160
 
        self._pending_parents_stack.pop()
161
 
 
162
 
        self._completed_node_names.add(node_name)
163
 
        return node_name
 
137
                    # recurse depth first into a single parent
 
138
                    next_node_name = parents_to_visit.pop()
 
139
 
 
140
                    if next_node_name in completed_node_names:
 
141
                        # parent was already completed by a child, skip it.
 
142
                        continue
 
143
                    if next_node_name not in visitable:
 
144
                        # parent is not a node in the original graph, skip it.
 
145
                        continue
 
146
 
 
147
                    # transfer it along with its parents from the source graph
 
148
                    # into the top of the current depth first search stack.
 
149
                    try:
 
150
                        parents = graph.pop(next_node_name)
 
151
                    except KeyError:
 
152
                        # if the next node is not in the source graph it has
 
153
                        # already been popped from it and placed into the
 
154
                        # current search stack (but not completed or we would
 
155
                        # have hit the continue 6 lines up).  this indicates a
 
156
                        # cycle.
 
157
                        raise errors.GraphCycleError(pending_node_stack)
 
158
                    pending_node_stack.append(next_node_name)
 
159
                    pending_parents_stack.append(list(parents))
164
160
 
165
161
 
166
162
def merge_sort(graph, branch_tip, mainline_revisions=None, generate_revno=False):
182
178
        revision number sequences in the output. See the output description of
183
179
        the MergeSorter docstring for details.
184
180
    :result: See the MergeSorter docstring for details.
185
 
    node identifiers can be any hashable object, and are typically strings.
 
181
 
 
182
    Node identifiers can be any hashable object, and are typically strings.
186
183
    """
187
184
    return MergeSorter(graph, branch_tip, mainline_revisions,
188
185
        generate_revno).sorted()
414
411
 
415
412
        # seed the search with the tip of the branch
416
413
        if (branch_tip is not None and
417
 
            branch_tip != _mod_revision.NULL_REVISION):
 
414
            branch_tip != _mod_revision.NULL_REVISION and
 
415
            branch_tip != (_mod_revision.NULL_REVISION,)):
418
416
            parents = self._graph.pop(branch_tip)
419
417
            self._push_node(branch_tip, 0, parents)
420
418
 
463
461
            left_subtree_pushed_stack_append(False)
464
462
            pending_parents_stack_append(list(parents))
465
463
            # as we push it, check if it is the first child
 
464
            parent_info = None
466
465
            if parents:
467
466
                # node has parents, assign from the left most parent.
468
 
                parent_info = revnos[parents[0]]
 
467
                try:
 
468
                    parent_info = revnos[parents[0]]
 
469
                except KeyError:
 
470
                    # Left-hand parent is a ghost, consider it not to exist
 
471
                    pass
 
472
            if parent_info is not None:
469
473
                first_child = parent_info[1]
470
474
                parent_info[1] = False
471
475
            else:
499
503
            pending_parents_stack_pop()
500
504
 
501
505
            parents = original_graph[node_name]
 
506
            parent_revno = None
502
507
            if parents:
503
508
                # node has parents, assign from the left most parent.
504
 
                parent_revno = revnos[parents[0]][0]
 
509
                try:
 
510
                    parent_revno = revnos[parents[0]][0]
 
511
                except KeyError:
 
512
                    # left-hand parent is a ghost, treat it as not existing
 
513
                    pass
 
514
            if parent_revno is not None:
505
515
                if not first_child:
506
516
                    # not the first child, make a new branch
507
517
                    base_revno = parent_revno[0]
545
555
                    if not left_subtree_pushed_stack[-1]:
546
556
                        # recurse depth first into the primary parent
547
557
                        next_node_name = pending_parents_stack[-1].pop(0)
 
558
                        is_left_subtree = True
 
559
                        left_subtree_pushed_stack[-1] = True
548
560
                    else:
549
561
                        # place any merges in right-to-left order for scheduling
550
562
                        # which gives us left-to-right order after we reverse
554
566
                        # display nicely (you get smaller trees at the top
555
567
                        # of the combined merge).
556
568
                        next_node_name = pending_parents_stack[-1].pop()
 
569
                        is_left_subtree = False
557
570
                    if next_node_name in completed_node_names:
558
571
                        # this parent was completed by a child on the
559
572
                        # call stack. skip it.
568
581
                        # current search stack (but not completed or we would
569
582
                        # have hit the continue 4 lines up.
570
583
                        # this indicates a cycle.
571
 
                        raise errors.GraphCycleError(node_name_stack)
 
584
                        if next_node_name in self._original_graph:
 
585
                            raise errors.GraphCycleError(node_name_stack)
 
586
                        else:
 
587
                            # This is just a ghost parent, ignore it
 
588
                            continue
572
589
                    next_merge_depth = 0
573
 
                    if left_subtree_pushed_stack[-1]:
 
590
                    if is_left_subtree:
574
591
                        # a new child branch from name_stack[-1]
 
592
                        next_merge_depth = 0
 
593
                    else:
575
594
                        next_merge_depth = 1
576
 
                    else:
577
 
                        next_merge_depth = 0
578
 
                        left_subtree_pushed_stack[-1] = True
579
595
                    next_merge_depth = (
580
596
                        node_merge_depth_stack[-1] + next_merge_depth)
581
597
                    push_node(
626
642
        self._left_subtree_pushed_stack.append(False)
627
643
        self._pending_parents_stack.append(list(parents))
628
644
        # as we push it, figure out if this is the first child
629
 
        parents = self._original_graph[node_name]
 
645
        parent_info = None
630
646
        if parents:
631
647
            # node has parents, assign from the left most parent.
632
 
            parent_info = self._revnos[parents[0]]
 
648
            try:
 
649
                parent_info = self._revnos[parents[0]]
 
650
            except KeyError:
 
651
                # Left-hand parent is a ghost, consider it not to exist
 
652
                pass
 
653
        if parent_info is not None:
633
654
            first_child = parent_info[1]
634
655
            parent_info[1] = False
635
656
        else:
653
674
        self._pending_parents_stack.pop()
654
675
 
655
676
        parents = self._original_graph[node_name]
 
677
        parent_revno = None
656
678
        if parents:
657
679
            # node has parents, assign from the left most parent.
658
 
            parent_revno = self._revnos[parents[0]][0]
 
680
            try:
 
681
                parent_revno = self._revnos[parents[0]][0]
 
682
            except KeyError:
 
683
                # left-hand parent is a ghost, treat it as not existing
 
684
                pass
 
685
        if parent_revno is not None:
659
686
            if not first_child:
660
687
                # not the first child, make a new branch
661
688
                base_revno = parent_revno[0]
671
698
        else:
672
699
            # no parents, use the root sequence
673
700
            root_count = self._revno_to_branch_count.get(0, 0)
 
701
            root_count = self._revno_to_branch_count.get(0, -1)
 
702
            root_count += 1
674
703
            if root_count:
675
704
                revno = (0, root_count, 1)
676
705
            else:
677
706
                revno = (1,)
678
 
            root_count += 1
679
707
            self._revno_to_branch_count[0] = root_count
680
708
 
681
709
        # store the revno for this node for future reference