website/source/user-guide.mmd

   1 {include resources/ug-header.md}
   2 {set-property title "CL-Graph User's Guide"}
   3 {set-property docs-package cl-graph}
   4
   5 # CL-Graph User's Guide
   6
   7 # Table of Contents
   8
   9 {table-of-contents :start 2 :depth 3}
  10
  11 ## Introduction
  12
  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.
  21
  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.
  27
  28 ## Using a graph
  29
  30 ### Creation and manipulation
  31
  32 {include "user-guide-details/manipulation.mmd"}
  33
  34 ### Tell me about yourself - introspection
  35
  36 {include "user-guide-details/introspection.mmd"}
  37
  38 ### Search
  39
  40 {include "user-guide-details/search.mmd"}
  41
  42 ### Algorithms
  43
  44 {include "user-guide-details/algorithms.mmd"}
  45
  46 ### Iteration
  47
  48 {include "user-guide-details/iteration.mmd"}
  49
  50 ### CL-Graph and dotty
  51
  52 {include "user-guide-details/dotty.mmd"}
  53
  54 ### Random Graphs
  55
  56 {include user-guide-details/random-graphs.mmd}
  57
  58 ### Miscellaneous
  59
  60 {include user-guide-details/miscellaneous.mmd}
  61
  62 ### Deprecated - to be removed soon
  63
  64 {include user-guide-details/deprecated.mmd}
  65
  66 ## Index of Functions
  67
  68 {docs-index (function macro) function}
  69
  70 <hr>
  71
  72 {comment
  73
  74 #### Glossary
  75
  76 {glossary}
  77
  78
  79 #### Footnotes
  80
  81 {footnotes}
  82 }
  83
  84 {include resources/ug-footer.md}