Skip to content

Commit

Permalink
Update developing.md (#81)
Browse files Browse the repository at this point in the history
* Update developing.md

* update `AbstractSimpleGraph` API in developing.md

Co-authored-by: Etienne dg <etienne.mace_de_gastines@insa-rouen.fr>
  • Loading branch information
mschauer and etiennedeg committed Dec 23, 2021
1 parent f74f0b1 commit 0e5ba58
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/src/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,6 @@ Note that the output does not necessarily have to be a dense matrix, but it must

#### Note on inheriting from AbstractSimpleGraph

Every subtype of AbstractSimpleGraph must return neighbors in ascending order.
Every subtype of `AbstractSimpleGraph` must have vertices forming a `UnitRange` starting from 1 and return `neighbors` in ascending order.
The extend to which code for graph types other than subtypes of `AbstractSimpleGraph` does not rely on `AbstractSimpleGraph` assumptions
needs to be carefully checked, though in principle the requirement is only part of the `AbstractSimpleGraph` API.

0 comments on commit 0e5ba58

Please sign in to comment.