search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``igraph`.`CohesiveBlocks``

class documentation

`class CohesiveBlocks(VertexCover): (source)`

Constructor: `CohesiveBlocks(graph, blocks, cohesion, parent)`

View In Hierarchy

The cohesive block structure of a graph.

Instances of this type are created by `Graph.cohesive_blocks()`. See the documentation of `Graph.cohesive_blocks()` for an explanation of what cohesive blocks are.

This class provides a few more methods that make handling of cohesive block structures easier.

Method | `__init__` | Constructs a new cohesive block structure for the given graph.
Method | `__plot__` | Plots the cohesive block structure to the given Cairo context or matplotlib Axes.
Method | `cohesion` | Returns the cohesion of the group with the given index.
Method | `cohesions` | Returns the list of cohesion values for each group.
Method | `hierarchy` | Returns a new graph that describes the hierarchical relationships between the groups.
Method | `max_cohesion` | Finds the maximum cohesion score among all the groups that contain the given vertex.
Method | `max_cohesions` | For each vertex in the graph, returns the maximum cohesion score among all the groups that contain the vertex.
Method | `parent` | Returns the parent group index of the group with the given index or `None` if the given group is the root.
Method | `parents` | Returns the list of parent group indices for each group or `None` if the given group is the root.
Instance Variable | `_cohesion` | Undocumented
Instance Variable | `_parent` | Undocumented

Inherited from `VertexCover`:

Method | `crossing` | Returns a boolean vector where element i is `True` iff edge i lies between clusters, `False` otherwise.
Method | `subgraph` | Get the subgraph belonging to a given cluster.
Method | `subgraphs` | Gets all the subgraphs belonging to each of the clusters.
Property | `graph` | Returns the graph belonging to this object
Static Method | `_resolve_names_in_clusters` | Undocumented
Method | `_formatted_cluster_iterator` | Iterates over the clusters and formats them into a string to be presented in the summary.
Instance Variable | `_graph` | Undocumented

Inherited from `Cover` (via `VertexCover`):

Method | `__getitem__` | Returns the cluster with the given index.
Method | `__iter__` | Iterates over the clusters in this cover.
Method | `__len__` | Returns the number of clusters in this cover.
Method | `__str__` | Returns a string representation of the cover.
Method | `size` | Returns the size of a given cluster.
Method | `size_histogram` | Returns the histogram of cluster sizes.
Method | `sizes` | Returns the size of given clusters.
Method | `summary` | Returns the summary of the cover.
Property | `membership` | Returns the membership vector of this cover.
Property | `n` | Returns the number of elements in the set covered by this cover.
Instance Variable | `_clusters` | Undocumented
Instance Variable | `_n` | Undocumented

def __init__(self, graph, blocks=None, cohesion=None, parent=None): (source)
overrides `igraph.VertexCover.__init__`

Constructs a new cohesive block structure for the given graph.

If any of blocks, cohesion or parent is `None`, all the arguments will be ignored and `Graph.cohesive_blocks()` will be called to calculate the cohesive blocks. Otherwise, these three variables should describe the *result* of a cohesive block structure calculation. Chances are that you never have to construct `CohesiveBlocks` instances directly, just use `Graph.cohesive_blocks()`.

Parameters
graph | the graph itself
blocks | a list containing the blocks; each block is described as a list containing vertex IDs.
cohesion | the cohesion of each block. The length of this list must be equal to the length of blocks.
parent | the parent block of each block. Negative values or `None` mean that there is no parent block for that block. There should be only one parent block, which covers the entire graph.
See Also
Graph.cohesive_blocks()

def __plot__(self, backend, context, *args, **kwds): (source)
overrides `igraph.VertexCover.__plot__`

Plots the cohesive block structure to the given Cairo context or matplotlib Axes.

Since a `CohesiveBlocks` instance is also a `VertexCover`, keyword arguments accepted by `VertexCover.__plot__()` are also accepted here. The only difference is that the vertices are colored according to their maximal cohesions by default, and groups are marked by colored blobs except the last group which encapsulates the whole graph.

See the documentation of `VertexCover.__plot__()` for more details.

def cohesion(self, idx): (source)

Returns the cohesion of the group with the given index.

def cohesions(self): (source)

Returns the list of cohesion values for each group.

def hierarchy(self): (source)

Returns a new graph that describes the hierarchical relationships between the groups.

The new graph will be a directed tree; an edge will point from vertex i to vertex j if group i is a superset of group j. In other words, the edges point downwards.

def max_cohesion(self, idx): (source)

Finds the maximum cohesion score among all the groups that contain the given vertex.

def max_cohesions(self): (source)

For each vertex in the graph, returns the maximum cohesion score among all the groups that contain the vertex.

def parent(self, idx): (source)

Returns the parent group index of the group with the given index or `None` if the given group is the root.

def parents(self): (source)

Returns the list of parent group indices for each group or `None` if the given group is the root.

_cohesion = (source)

Undocumented

_parent = (source)

Undocumented