5cf6d08009777e7426210fe74508f9653f1b6904
[cl-graph.git] / dev / package.lisp
1 ;;;-*- Mode: Lisp; Package: COMMON-LISP-USER -*-
2
3 #| simple-header
4
5 Author: Gary King, et. al.
6
7 DISCUSSION
8
9 |#
10 (in-package common-lisp-user)
11
12 (defpackage "CL-GRAPH"
13   (:use "COMMON-LISP" "METATILITIES" "CL-CONTAINERS" 
14         "METABANG.BIND" "METABANG.MATH")
15   (:nicknames "METABANG.GRAPH")
16   (:documentation "CL-Graph is a Common Lisp library for manipulating graphs and running graph algorithms.")
17   
18   (:export 
19    #:with-changing-vertex
20    
21    #:make-graph
22    #:basic-graph
23    
24    #:add-edge-between-vertexes     ; graph { value | vertex } { value | vertex }
25    #:delete-edge-between-vertexes  ; graph { value | vertex } { value | vertex }
26    #:add-vertex                    ; graph { value | vertex }
27    #:find-vertex                   ; graph { value | vertex }
28    #:find-edge                     ; graph edge
29    #:find-edge-between-vertexes    ; graph { vertex | value } { vertex | value }
30    #:find-vertex-if
31    #:find-vertexes-if
32    #:search-for-vertex
33    
34    #:iterate-container             ; graph fn
35    #:iterate-vertexes
36    #:vertexes
37    #:source-edges
38    #:target-edges
39    #:child-vertexes
40    #:parent-vertexes
41    #:neighbor-vertexes
42    #:other-vertex
43    
44    #:edge-count                    ; graph
45    #:vertex-count                  ; graph
46    #:source-edge-count             ; vertex
47    #:target-edge-count             ; vertex
48    
49    #:rootp                         ; vertex
50    #:graph-roots                   ; graph
51    
52    #:topological-sort              ; graph
53    #:depth                         ; graph | vertex
54    #:depth-level
55    
56    #:get-transitive-closure        ;; CTM
57    #:make-filtered-graph           ;; CTM
58    
59    #:adjacentp
60    #:in-cycle-p                    ; graph vertex
61    #:force-undirected
62    
63    #:renumber-vertexes
64    #:renumber-edges
65    
66    #:generate-directed-free-tree
67    
68    #:contains-undirected-edge-p
69    #:contains-directed-edge-p
70    
71    #:undirected-edge-p
72    #:directed-edge-p
73    #:tagged-edge-p
74    #:untagged-edge-p
75    #:tag-all-edges
76    #:untag-all-edges
77    #:graph->dot
78    #:vertex->dot
79    #:edge->dot
80    #:graph->dot-properties
81    #:subgraph-containing
82    #:graph->dot-external
83    #:dot-graph
84    #:dot-vertex
85    #:dot-edge
86    #:dot-attributes
87    
88    #:connected-graph-p
89    #:find-connected-components
90    #:connected-component-count
91    
92    #:target-vertex
93    #:source-vertex
94    
95    #:layout-graph-with-graphviz
96    #:dot-attribute-value
97    #:dot-attribute
98
99    #:add-edge                      ; graph edge
100    #:delete-edge                   ; graph edge
101    
102    #:add-vertex                    ; graph { value | vertex }
103    #:delete-vertex                 ; graph { value | vertex }
104    #:find-vertex                   ; graph { value | vertex }
105    #:find-edge                     ; graph edge
106    #:find-edge-between-vertexes    ; graph { vertex | value } { vertex | value }
107    #:find-edge-between-vertexes-if ; graph { vertex | value } { vertex | value } fn
108    #:find-edge-if                  ; graph
109    #:find-edges-if                 ; graph
110    
111    #:edges                         ; graph | vertex
112    #:iterate-edges                 ; graph fn
113    #:iterate-source-edges          ; vertex fn
114    #:iterate-target-edges          ; vertex fn
115    #:iterate-children              ; vertex (nodes) fn
116    #:iterate-parents               ; vertex (nodes) fn
117    #:iterate-neighbors             ; vertex (all neighbors) fn
118    #:has-children-p
119    #:has-parent-p
120    #:number-of-neighbors
121    
122    #:edge-count                    ; graph
123    #:vertex-count                  ; graph
124    
125    #:topological-sort              ; graph
126    #:depth                         ; graph | vertex
127    #:depth-level
128    
129    #:get-transitive-closure        ;; CTM
130    #:make-filtered-graph           ;; CTM
131    
132    #:adjacentp
133    #:in-cycle-p                    ; graph vertex
134    #:in-undirected-cycle-p         ; graph vertex
135    #:any-undirected-cycle-p        ; graph
136    #:force-undirected
137    #:vertices-share-edge-p
138    
139    #:map-paths
140    #:map-shortest-paths
141    
142    ;;; depth first search 
143    #:dfs-edge-type
144    #:dfs-back-edge-p 
145    #:dfs-tree-edge-p
146    #:edge-lessp-by-direction
147    #:out-edge-for-vertex-p
148    #:dfs
149    
150    ;;; minimum-spanning-tree
151    #+Ignore #:add-edges-to-graph
152    
153    #:make-graph-from-vertexes
154    #:edge-lessp-by-weight
155    #:minimum-spanning-tree
156    
157    ;;; mapping
158    #+Ignore #:map-over-all-combinations-of-k-vertexes
159    #+Ignore #:map-over-all-combinations-of-k-edges
160    
161    #:project-bipartite-graph
162    
163    #:make-vertex-edges-container 
164    
165    #:vertex-degree-counts
166    #:vertex-degree
167    #:average-vertex-degree
168    #:vertex-clustering-coefficient
169    #:average-vertex-clustering-coefficient
170    
171    #:graph-mixing-matrix
172    #:graph-edge-mixture-matrix
173    #:assortativity-coefficient
174    #:vertex-degree-summary))