moving to git; cleanup; wip
[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 #:metabang-bind)
14   (:nicknames #:metabang.graph)
15   (:documentation "CL-Graph is a Common Lisp library for manipulating graphs and running graph algorithms.")
16   
17   (:export 
18    #:with-changing-vertex
19    
20    #:make-graph
21    #:basic-graph
22    
23    #:add-edge-between-vertexes     ; graph { value | vertex } { value | vertex }
24    #:delete-edge-between-vertexes  ; graph { value | vertex } { value | vertex }
25    #:add-vertex                    ; graph { value | vertex }
26    #:find-vertex                   ; graph { value | vertex }
27    #:find-edge                     ; graph edge
28    #:find-edge-between-vertexes    ; graph { vertex | value } { vertex | value }
29    #:find-vertex-if
30    #:find-vertexes-if
31    #:search-for-vertex
32    
33    #:iterate-container             ; graph fn
34    #:iterate-vertexes
35    #:vertexes
36    #:source-edges
37    #:target-edges
38    #:child-vertexes
39    #:parent-vertexes
40    #:neighbor-vertexes
41    #:other-vertex
42    
43    #:edge-count                    ; graph
44    #:vertex-count                  ; graph
45    #:source-edge-count             ; vertex
46    #:target-edge-count             ; vertex
47    
48    #:rootp                         ; vertex
49    #:graph-roots                   ; graph
50    
51    #:topological-sort              ; graph
52    #:depth                         ; graph | vertex
53    #:depth-level
54    
55    #:get-transitive-closure        ;; CTM
56    #:make-filtered-graph           ;; CTM
57    
58    #:adjacentp
59    #:in-cycle-p                    ; graph vertex
60    #:force-undirected
61    
62    #:renumber-vertexes
63    #:renumber-edges
64    
65    #:generate-directed-free-tree
66    
67    #:contains-undirected-edge-p
68    #:contains-directed-edge-p
69    
70    #:undirected-edge-p
71    #:directed-edge-p
72    #:tagged-edge-p
73    #:untagged-edge-p
74    #:tag-all-edges
75    #:untag-all-edges
76    #:graph->dot
77    #:vertex->dot
78    #:edge->dot
79    #:graph->dot-properties
80    #:subgraph-containing
81    #:graph->dot-external
82    #:dot-graph
83    #:dot-vertex
84    #:dot-edge
85    #:dot-attributes
86    #:layout-graph-with-graphviz
87    #:dot-attribute-value
88    
89    #:connected-graph-p
90    #:find-connected-components
91    #:connected-component-count
92    
93    #:target-vertex
94    #:source-vertex
95    
96    #:add-edge                      ; graph edge
97    #:delete-edge                   ; graph edge
98    #:delete-all-edges
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    #:graph-vertexes
120    #:replace-vertex
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    #:make-vertex-for-graph
165
166    #:vertex-degree-counts
167    #:vertex-degree
168    #:average-vertex-degree
169    #:vertex-clustering-coefficient
170    #:average-vertex-clustering-coefficient
171    
172    #:graph-mixing-matrix
173    #:graph-edge-mixture-matrix
174    #:assortativity-coefficient
175    #:vertex-degree-summary
176    #:connected-components
177    #:average-local-clustering-coefficient
178    #:vertex-triangle-count
179    #:graph-edges
180    #:graph-vertexes)
181
182   (:export
183    #:print-dot-key-value
184    #:dot-attribute-value
185    #:dot-attributes-mixin
186    #:*dot-graph-attributes*
187    ))