tools/telemetry/third_party/altgraph/doc/graphstat.rst

   1 :mod:`altgraph.GraphStat` --- Functions providing various graph statistics
   2 ==========================================================================
   3
   4 .. module:: altgraph.GraphStat
   5    :synopsis: Functions providing various graph statistics
   6
   7 The module :mod:`altgraph.GraphStat` provides function that calculate
   8 graph statistics. Currently there is only one such function, more may
   9 be added later.
  10
  11 .. function:: degree_dist(graph[, limits[, bin_num[, mode]]])
  12
  13    Groups the number of edges per node into *bin_num* bins
  14    and returns the list of those bins. Every item in the result
  15    is a tuple with the center of the bin and the number of items
  16    in that bin.
  17
  18    When the *limits* argument is present it must be a tuple with
  19    the mininum and maximum number of edges that get binned (that
  20    is, when *limits* is ``(4, 10)`` only nodes with between 4
  21    and 10 edges get counted.
  22
  23    The *mode* argument is used to count incoming (``'inc'``) or
  24    outgoing (``'out'``) edges. The default is to count the outgoing
  25    edges.