Commit cea90112 authored by Tiago Peixoto's avatar Tiago Peixoto
Browse files

Small docstring fix

parent b9bbc350
...@@ -486,7 +486,7 @@ def motif_significance(g, k, n_shuffles=100, p=1.0, motif_list=None, ...@@ -486,7 +486,7 @@ def motif_significance(g, k, n_shuffles=100, p=1.0, motif_list=None,
where :math:`N_i` is the number of times motif i found, and :math:`N^s_i` where :math:`N_i` is the number of times motif i found, and :math:`N^s_i`
is the count of the same motif but on a shuffled network. It measures how is the count of the same motif but on a shuffled network. It measures how
many standard deviations is each motif count, in respect to a ensemble of many standard deviations is each motif count, in respect to an ensemble of
randomly shuffled graphs with the same degree sequence. randomly shuffled graphs with the same degree sequence.
The z-scores values are not normalized. The z-scores values are not normalized.
......
...@@ -100,9 +100,8 @@ def random_graph(N, deg_sampler, deg_corr=None, directed=True, ...@@ -100,9 +100,8 @@ def random_graph(N, deg_sampler, deg_corr=None, directed=True,
the :func:`~graph_tool.generation.random_rewire` function. the :func:`~graph_tool.generation.random_rewire` function.
The complexity is :math:`O(V+E)` if parallel edges are allowed, and The complexity is :math:`O(V+E)` if parallel edges are allowed, and
:math:`O(V+E \times \log N_k)` if parallel edges are not allowed, where :math:`O(V+E\log N_k)` if parallel edges are not allowed, where :math:`N_k <
:math:`N_k < V` is the number of different degrees sampled (or in,out-degree V` is the number of different degrees sampled (or in,out-degree pairs).
pairs).
References References
---------- ----------
...@@ -264,11 +263,11 @@ def random_rewire(g, strat= "uncorrelated", parallel_edges = False, ...@@ -264,11 +263,11 @@ def random_rewire(g, strat= "uncorrelated", parallel_edges = False,
g : :class:`~graph_tool.Graph` g : :class:`~graph_tool.Graph`
Graph to be shuffled. The graph will be modified. Graph to be shuffled. The graph will be modified.
strat : string (optional, default: "uncorrelated") strat : string (optional, default: "uncorrelated")
If `strat` == "erdos", the resulting graph will be entirely random. If If `strat` = "erdos", the resulting graph will be entirely random. If
`strat` == "uncorrelated" only the degrees of the vertices will be `strat` = "uncorrelated" only the degrees of the vertices will be
maintained, nothing else. If `strat` == "correlated", additionally the maintained, nothing else. If `strat` = "correlated", additionally the
new source and target of each edge both have the same in and out-degree. new source and target of each edge both have the same in and out-degree.
If `strat` == "probabilistic", than edges are rewired according to the If `strat` = "probabilistic", than edges are rewired according to the
degree correlation given by the parameter `deg_corr`. degree correlation given by the parameter `deg_corr`.
parallel : bool (optional, default: False) parallel : bool (optional, default: False)
If True, parallel edges are allowed. If True, parallel edges are allowed.
......
...@@ -704,7 +704,7 @@ def shortest_path(g, source, target, weights=None, pred_map=None): ...@@ -704,7 +704,7 @@ def shortest_path(g, source, target, weights=None, pred_map=None):
Graph to be used. Graph to be used.
source : :class:`~graph_tool.Vertex` source : :class:`~graph_tool.Vertex`
Source vertex of the search. Source vertex of the search.
source : :class:`~graph_tool.Vertex` target : :class:`~graph_tool.Vertex`
Target vertex of the search. Target vertex of the search.
weights : :class:`~graph_tool.PropertyMap` (optional, default: None) weights : :class:`~graph_tool.PropertyMap` (optional, default: None)
The edge weights. If provided, the minimum spanning tree will minimize The edge weights. If provided, the minimum spanning tree will minimize
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment