Skip to content

Commit

Permalink
doc: also fix the doc of _construct_graph_from_weighted_adjacency()
Browse files Browse the repository at this point in the history
  • Loading branch information
ntamas committed Jan 26, 2024
1 parent b78ed1c commit c6f9f5d
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions src/igraph/io/adjacency.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ def _construct_graph_from_adjacency(cls, matrix, mode="directed", loops="once"):
- a pandas.DataFrame (column/row names must match, and will be used
as vertex names).
@param mode: the mode to be used. Possible values are:
- C{"directed"} - the graph will be directed and a matrix
element gives the number of edges between two vertex.
- C{"undirected"} - alias to C{"max"} for convenience.
- C{"directed"} - the graph will be directed and a matrix element
specifies the number of edges between two vertices.
- C{"undirected"} - the graph will be undirected and a matrix element
specifies the number of edges between two vertices. The matrix must
be symmetric.
- C{"max"} - undirected graph will be created and the number of
edges between vertex M{i} and M{j} is M{max(A(i,j), A(j,i))}
- C{"min"} - like C{"max"}, but with M{min(A(i,j), A(j,i))}
Expand Down Expand Up @@ -82,9 +84,11 @@ def _construct_graph_from_weighted_adjacency(
- a scipy.sparse matrix (will be converted to a COO matrix, but not
to a dense matrix)
@param mode: the mode to be used. Possible values are:
- C{"directed"} - the graph will be directed and a matrix
element gives the number of edges between two vertex.
- C{"undirected"} - alias to C{"max"} for convenience.
- C{"directed"} - the graph will be directed and a matrix element
specifies the number of edges between two vertices.
- C{"undirected"} - the graph will be undirected and a matrix element
specifies the number of edges between two vertices. The matrix must
be symmetric.
- C{"max"} - undirected graph will be created and the number of
edges between vertex M{i} and M{j} is M{max(A(i,j), A(j,i))}
- C{"min"} - like C{"max"}, but with M{min(A(i,j), A(j,i))}
Expand Down

0 comments on commit c6f9f5d

Please sign in to comment.