4a001883a1b2aa1f8724306c773df2c163fee9db
[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    #:layout-graph-with-graphviz
88    #:dot-attribute-value
89    
90    #:connected-graph-p
91    #:find-connected-components
92    #:connected-component-count
93    
94    #:target-vertex
95    #:source-vertex
96    
97    #:add-edge                      ; graph edge
98    #:delete-edge                   ; graph edge
99    
100    #:add-vertex                    ; graph { value | vertex }
101    #:delete-vertex                 ; graph { value | vertex }
102    #:find-vertex                   ; graph { value | vertex }
103    #:find-edge                     ; graph edge
104    #:find-edge-between-vertexes    ; graph { vertex | value } { vertex | value }
105    #:find-edge-between-vertexes-if ; graph { vertex | value } { vertex | value } fn
106    #:find-edge-if                  ; graph
107    #:find-edges-if                 ; graph
108    
109    #:edges                         ; graph | vertex
110    #:iterate-edges                 ; graph fn
111    #:iterate-source-edges          ; vertex fn
112    #:iterate-target-edges          ; vertex fn
113    #:iterate-children              ; vertex (nodes) fn
114    #:iterate-parents               ; vertex (nodes) fn
115    #:iterate-neighbors             ; vertex (all neighbors) fn
116    #:has-children-p
117    #:has-parent-p
118    #:number-of-neighbors
119    
120    #:edge-count                    ; graph
121    #:vertex-count                  ; graph
122    
123    #:topological-sort              ; graph
124    #:depth                         ; graph | vertex
125    #:depth-level
126    
127    #:get-transitive-closure        ;; CTM
128    #:make-filtered-graph           ;; CTM
129    
130    #:adjacentp
131    #:in-cycle-p                    ; graph vertex
132    #:in-undirected-cycle-p         ; graph vertex
133    #:any-undirected-cycle-p        ; graph
134    #:force-undirected
135    #:vertices-share-edge-p
136    
137    #:map-paths
138    #:map-shortest-paths
139    
140    ;;; depth first search 
141    #:dfs-edge-type
142    #:dfs-back-edge-p 
143    #:dfs-tree-edge-p
144    #:edge-lessp-by-direction
145    #:out-edge-for-vertex-p
146    #:dfs
147    
148    ;;; minimum-spanning-tree
149    #+Ignore #:add-edges-to-graph
150    
151    #:make-graph-from-vertexes
152    #:edge-lessp-by-weight
153    #:minimum-spanning-tree
154    
155    ;;; mapping
156    #+Ignore #:map-over-all-combinations-of-k-vertexes
157    #+Ignore #:map-over-all-combinations-of-k-edges
158    
159    #:project-bipartite-graph
160    
161    #:make-vertex-edges-container 
162    
163    #:vertex-degree-counts
164    #:vertex-degree
165    #:average-vertex-degree
166    #:vertex-clustering-coefficient
167    #:average-vertex-clustering-coefficient
168    
169    #:graph-mixing-matrix
170    #:graph-edge-mixture-matrix
171    #:assortativity-coefficient
172    #:vertex-degree-summary))