website/source/user-guide.md

   1 {include resources/ug-header.md}
   2 {set-property title "CL-Graph User's Guide"}
   3 {set-property style-sheet user-guide}
   4 {set-property docs-package cl-graph}
   5
   6 # CL-Graph User's Guide
   7
   8 # Table of Contents
   9
  10 {table-of-contents :start 2 :depth 3}
  11
  12 ## Introduction
  13
  14 In Mathematics and Computer Science, a _graph_ is a
  15 collection of _vertexes_ connected by _edges_. Edges may be
  16 _directed_ or _undirected_ (i.e., sometimes you really can't
  17 get there from here). Both edges and vertexes may have
  18 additional data associated with them. Graphs are useful
  19 because you can use them to represent most anything: food
  20 webs, hypertext, the world wide web, protein/protein
  21 interactions, language, who publishes with whom, etc.
  22
  23 CL-Graph is a general graph library built on
  24 [cl-containers][]. It provides an open-ended API for
  25 building, examining and manipulating graphs as well as
  26 implementations of many of the usual suspects of graph
  27 algorithms and measures.
  28
  29 ## Using a graph
  30
  31 ### Creation and manipulation
  32
  33 {include "user-guide-details/manipulation.mmd"}
  34
  35 ### Tell me about yourself - introspection
  36
  37 {include "user-guide-details/introspection.mmd"}
  38
  39 ### Search
  40
  41 {include "user-guide-details/search.mmd"}
  42
  43 ### Algorithms
  44
  45 {include "user-guide-details/algorithms.mmd"}
  46
  47 ### Iteration
  48
  49 {include "user-guide-details/iteration.mmd"}
  50
  51 ### CL-Graph and dotty
  52
  53 {include "user-guide-details/dotty.mmd"}
  54
  55 ### Random Graphs
  56
  57 {include user-guide-details/random-graphs.mmd}
  58
  59 ### Miscellaneous
  60
  61 {include user-guide-details/miscellaneous.mmd}
  62
  63 ### Deprecated - to be removed soon
  64
  65 {include user-guide-details/deprecated.mmd}
  66
  67 ## Index of Functions
  68
  69 {docs-index (function macro) function}
  70
  71 <hr>
  72
  73 {comment
  74
  75 #### Glossary
  76
  77 {glossary}
  78
  79
  80 #### Footnotes
  81
  82 {footnotes}
  83 }
  84
  85 {include resources/ug-footer.md}