Skip to content

Commit e4b1576

Browse files
committed
update docstrings
1 parent 149ffb6 commit e4b1576

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

src/incidence_matrix.jl

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,15 @@ import Graphs
3030
import JuMPIn: get_bipartite_incidence_graph, IncidenceGraphInterface
3131

3232
"""
33-
incidence_matrix
33+
incidence_matrix(constraints, variables)::SparseMatrixCSC
3434
3535
Return a `SparseMatrixCSC` with entries corresponding to incidence
3636
between the provided constraints and variables.
3737
38-
Rows correspond to constraints and columns correspond to varibales.
38+
Rows correspond to constraints, columns correspond to variables, and
39+
matrix entries correspond to edges in the incidence graph. All matrix
40+
entries have values of `1.0`.
41+
3942
"""
4043
function incidence_matrix(
4144
constraints::Vector{<:JuMP.ConstraintRef},
@@ -57,6 +60,13 @@ function incidence_matrix(
5760
return SparseArrays.sparse(row, col, val)
5861
end
5962

63+
"""
64+
incidence_matrix(igraph::IncidenceGraphInterface)::SparseMatrixCSC
65+
66+
Return the incidence matrix associated with the provided
67+
`IncidenceGraphInterface`.
68+
69+
"""
6070
function incidence_matrix(
6171
igraph::IncidenceGraphInterface
6272
)::SparseArrays.SparseMatrixCSC

0 commit comments

Comments
 (0)