1 {include resources/ug-header.md}
2 {set-property title "CL-Graph User's Guide"}
3 {set-property docs-package cl-graph}
5 # CL-Graph User's Guide
9 {table-of-contents :start 2 :depth 3}
13 In Mathematics and Computer Science, a _graph_ is a
14 collection of _vertexes_ connected by _edges_. Edges may be
15 _directed_ or _undirected_ (i.e., sometimes you really can't
16 get there from here). Both edges and vertexes may have
17 additional data associated with them. Graphs are useful
18 because you can use them to represent most anything: food
19 webs, hypertext, the world wide web, protein/protein
20 interactions, language, who publishes with whom, etc.
22 CL-Graph is a general graph library built on
23 [cl-containers][]. It provides an open-ended API for
24 building, examining and manipulating graphs as well as
25 implementations of many of the usual suspects of graph
26 algorithms and measures.
30 ### Creation and manipulation
32 {include "user-guide-details/manipulation.mmd"}
34 ### Tell me about yourself - introspection
36 {include "user-guide-details/introspection.mmd"}
40 {include "user-guide-details/search.mmd"}
44 {include "user-guide-details/algorithms.mmd"}
48 {include "user-guide-details/iteration.mmd"}
50 ### CL-Graph and dotty
52 {include "user-guide-details/dotty.mmd"}
56 {include user-guide-details/random-graphs.mmd}
60 {include user-guide-details/miscellaneous.mmd}
62 ### Deprecated - to be removed soon
64 {include user-guide-details/deprecated.mmd}
68 {docs-index (function macro) function}
84 {include resources/ug-footer.md}