braintools.analysis.graph.PathLengthResult

braintools.analysis.graph.PathLengthResult#

class braintools.analysis.graph.PathLengthResult(path_length, efficiency, n_reachable, n_sources)[source]#

Result of characteristic_path_length().

Variables:
  • path_length (float) – Mean shortest-path length (in hops) over the ordered pairs (source, target), source != target, where target is reachable from source. nan when no pair is reachable.

  • efficiency (float) – Global efficiency: the mean of 1 / d(source, target) over all ordered pairs with source != target, unreachable pairs counting as 0. 0 for a graph with fewer than two nodes.

  • n_reachable (int) – Number of reachable ordered pairs the mean path_length is over.

  • n_sources (int) – Number of source nodes used (all nodes unless sampled).

__init__()#

Methods

__init__()

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

Attributes

efficiency

Alias for field number 1

n_reachable

Alias for field number 2

n_sources

Alias for field number 3

path_length

Alias for field number 0