Skip to content

Commit db4bb75

Browse files
committed
docs for isequal
1 parent 3402f78 commit db4bb75

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

docs/src/systems/DependencyGraphs.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
BipartiteGraph
66
```
77

8+
# Utility functions for `BiPartiteGraph`s
9+
```@docs
10+
Base.isequal
11+
```
12+
813
# Functions for calculating dependency graphs
914
```@docs
1015
equation_dependencies

src/systems/dependency_graphs.jl

+7
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,13 @@ mutable struct BipartiteGraph{T <: Integer}
9191
badjlist::Vector{Vector{T}} # badjlist[dst] = [src1,src2,...]
9292
end
9393

94+
"""
95+
```julia
96+
Base.isequal(bg1::BipartiteGraph{T}, bg2::BipartiteGraph{T}) where {T<:Integer}
97+
```
98+
99+
Test whether two [`BipartiteGraph`](@ref)s are equal.
100+
"""
94101
function Base.isequal(bg1::BipartiteGraph{T}, bg2::BipartiteGraph{T}) where {T<:Integer}
95102
iseq = (bg1.ne == bg2.ne)
96103
iseq &= (bg1.fadjlist == bg2.fadjlist)

0 commit comments

Comments
 (0)