From 1fa2898a92bc551282f619d1818dd1dab4f85358 Mon Sep 17 00:00:00 2001 From: blepabyte <74576829+blepabyte@users.noreply.github.com> Date: Fri, 1 Oct 2021 00:07:59 +1300 Subject: [PATCH] Add cycle_basis to docs --- docs/src/pathing.md | 1 + src/cycles/basis.jl | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/pathing.md b/docs/src/pathing.md index 5c0d2734c..b9948f42f 100644 --- a/docs/src/pathing.md +++ b/docs/src/pathing.md @@ -85,6 +85,7 @@ In graph theory, a cycle is defined to be a path that starts from some vertex ```@docs is_cyclic +cycle_basis maxsimplecycles simplecycles simplecycles_iter diff --git a/src/cycles/basis.jl b/src/cycles/basis.jl index f1fffed7b..40e4e1df2 100644 --- a/src/cycles/basis.jl +++ b/src/cycles/basis.jl @@ -3,7 +3,7 @@ """ cycle_basis(g, root=nothing) -Return a list of cycles which form a basis for cycles of graph `g`, optionally starting at node `root`. +Return a list of cycles which form a basis for cycles of the undirected graph `g`, optionally starting at node `root`. A basis for cycles of a network is a minimal collection of cycles such that any cycle in the network can be written