Permalink
Browse files

DOC: fix error in csgraph.laplacian docstring.

Thanks to Vlad Niculae for pointing out this issue.
  • Loading branch information...
1 parent e1c61f1 commit feabb0a91d1777551dfd88ec447fdd9aa4bd136e @rgommers rgommers committed Sep 23, 2012
Showing with 3 additions and 5 deletions.
  1. +3 −5 scipy/sparse/csgraph/_laplacian.py
@@ -14,15 +14,14 @@
###############################################################################
# Graph laplacian
def laplacian(csgraph, normed=False, return_diag=False):
- """ Return the Laplacian matrix of a directed graph. For non-symmetric
- graphs the out-degree is used in the computation.
+ """ Return the Laplacian matrix of a directed graph.
+
+ For non-symmetric graphs the out-degree is used in the computation.
Parameters
----------
csgraph: array_like or sparse matrix, 2 dimensions
compressed-sparse graph, with shape (N, N).
- directed: bool, optional
- If True (default), then csgraph represents a directed graph.
normed: bool, optional
If True, then compute normalized Laplacian.
return_diag: bool, optional
@@ -32,7 +31,6 @@ def laplacian(csgraph, normed=False, return_diag=False):
-------
lap: ndarray
The N x N laplacian matrix of graph.
-
diag: ndarray
The length-N diagonal of the laplacian matrix.
diag is returned only if return_diag is True.

0 comments on commit feabb0a

Please sign in to comment.