perllib/Graph/Traversal/BFS.pm

   1 package Graph::Traversal::BFS;
   2
   3 use strict;
   4
   5 use Graph::Traversal;
   6 use base 'Graph::Traversal';
   7
   8 sub current {
   9     my $self = shift;
  10     $self->{ order }->[ 0 ];
  11 }
  12
  13 sub see {
  14     my $self = shift;
  15     shift @{ $self->{ order } };
  16 }
  17
  18 *bfs = \&Graph::Traversal::postorder;
  19
  20 1;
  21 __END__
  22 =pod
  23
  24 =head1 NAME
  25
  26 Graph::Traversal::BFS - breadth-first traversal of graphs
  27
  28 =head1 SYNOPSIS
  29
  30     use Graph;
  31     my $g = Graph->new;
  32     $g->add_edge(...);
  33     use Graph::Traversal::BFS;
  34     my $b = Graph::Traversal::BFS->new(%opt);
  35     $b->bfs; # Do the traversal.
  36
  37 =head1 DESCRIPTION
  38
  39 With this class one can traverse a Graph in breadth-first order.
  40
  41 The callback parameters %opt are explained in L<Graph::Traversal>.
  42
  43 =head2 Methods
  44
  45 The following methods are available:
  46
  47 =over 4
  48
  49 =item dfs
  50
  51 Traverse the graph in depth-first order.
  52
  53 =back
  54
  55 =head1 SEE ALSO
  56
  57 L<Graph::Traversal>, L<Graph::Traversal::DFS>, L<Graph>.
  58
  59 =cut