dev/graph.lisp

   1 ;;;-*- Mode: Lisp; Package: metabang.graph -*-
   2
   3 #|
   4 $Id: graph.lisp,v 1.30 2005/09/07 16:17:06 gwking Exp $
   5
   6 Author: Gary W. King, et. al.
   7
   8 |#
   9
  10 #| NOTES
  11
  12 something is putting something on the vertexes plist's
  13
  14 |#
  15
  16
  17 (in-package metabang.graph)
  18
  19 ;;; ---------------------------------------------------------------------------
  20 ;;; classes
  21 ;;; ---------------------------------------------------------------------------
  22
  23 (defcondition graph-error (error)
  24   ((graph nil ir))
  25   (:export-p t)
  26   (:export-slots-p t)
  27   (:documentation "This is the root condition for errors that occur while running code in CL-Graph."))
  28
  29 ;;; ---------------------------------------------------------------------------
  30
  31 (defcondition edge-error (graph-error)
  32   ((edge nil ir "The `edge` that is implicated in the condition."))
  33   (:export-p t)
  34   (:export-slots-p t)
  35   (:documentation "This is the root condition for graph errors that have to do with edges."))
  36
  37 ;;; ---------------------------------------------------------------------------
  38
  39 (defcondition graph-vertex-not-found-error (graph-error)
  40   ((vertex nil ir "The vertex or value that could not be found in the graph."))
  41   (:report (lambda (c s)
  42              (format s "Vertex ~S not found in ~A" (vertex c) (graph c))))
  43   (:export-p t)
  44   (:export-slots-p t)
  45   (:documentation "This condition is signaled when a vertex can not be found in a graph."))
  46
  47 ;;; ---------------------------------------------------------------------------
  48
  49 (defcondition graph-vertex-not-found-in-edge-error (edge-error)
  50   ((vertex nil ir))
  51   (:report (lambda (c s)
  52              (format s "Vertex ~S not found in ~A" (vertex c) (edge c))))
  53   (:export-p t)
  54   (:documentation "This condition is signaled when a vertex can not be found in an edge."))
  55
  56 ;;; ---------------------------------------------------------------------------
  57
  58 (defcondition graph-edge-not-found-error (graph-error)
  59   ((vertex-1 nil ir "One of the vertexes for which no connecting edge could be found.")
  60    (vertex-2 nil ir "One of the vertexes for which no connecting edge could be found."))
  61   (:report (lambda (c s)
  62              (format s "Edge between ~S and ~S not found in ~A"
  63                      (vertex-1 c) (vertex-2 c) (graph c))))
  64   (:export-p t)
  65   (:export-slots-p t)
  66   (:documentation "This condition is signaled when an edge cannot be found in a graph."))
  67
  68 ;;; ---------------------------------------------------------------------------
  69
  70 (defclass* basic-vertex (container-node-mixin)
  71   ((depth-level 0 ia :type number "`Depth-level` is used by some algorithms for bookkeeping.  [?? Should be in a mixin]")
  72    (vertex-id 0 ir "`Vertex-id` is used internally to keep track of vertexes.")
  73    (element :unbound ia :accessor value "The `element` is the value that this vertex represents.")
  74    (tag nil ia "The `tag` slot is used by some algorithms to keep track of which vertexes have been visited.")
  75    (graph nil ia "The graph in which this vertex is contained.")
  76    (color nil ia "The `color` slot is used by some algorithms for bookkeeping.")
  77    (rank nil ia "The `rank` is used by some algorithms for bookkeeping.  [?? Should be in a mixin]")
  78    (previous-node nil ia "`Previous-node` is used by some algorithms for bookkeeping. [?? Should be in a mixin]")
  79    (next-node nil ia "`Next-node` is used by some algorithms for bookkeeping.  [?? Should be in a mixin]")
  80    (discovery-time -1 ia "`Discovery-time` is used by some algorithms for bookkeeping.  [?? Should be in a mixin]")
  81    (finish-time -1 ia "`Finish-time` is used by some algorithms for bookkeeping.  [?? Should be in a mixin]"))
  82   (:export-p t)
  83   (:export-slots vertex-id tag rank color previous-node next-node
  84                  discovery-time finish-time)
  85   (:make-load-form-p t)
  86   (:documentation "This is the root class for all vertexes in CL-Graph."))
  87
  88 ;;; ---------------------------------------------------------------------------
  89
  90 (defmethod initialize-instance :after ((object basic-vertex) &key graph vertex-id)
  91   (when (and graph (not vertex-id))
  92     (setf (slot-value object 'vertex-id)
  93           (largest-vertex-id graph))
  94     (incf (slot-value graph 'largest-vertex-id))))
  95
  96 ;;; ---------------------------------------------------------------------------
  97
  98 (defmethod print-object ((vertex basic-vertex) stream)
  99   (print-unreadable-object (vertex stream :identity nil)
 100     (format stream "~A"
 101             (if (and (slot-exists-p vertex 'element) (slot-boundp vertex 'element))
 102               (element vertex) "#unbound#"))))
 103
 104 ;;; ---------------------------------------------------------------------------
 105
 106 (defclass* basic-edge ()
 107   ((edge-id 0 ia "The `edge-id` is used internally by CL-Graph for bookkeeping.")
 108    (element nil ia :accessor value :initarg :value)
 109    (tag nil ia "The `tag` is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]")
 110    (graph nil ir "The `graph` of which this edge is a part.")
 111    (color nil ia "The `color` is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]"))
 112   (:export-p t)
 113   (:export-slots edge-id element tag color)
 114   (:make-load-form-p t)
 115   (:documentation "This is the root class for all edges in CL-Graph."))
 116
 117 ;;; ---------------------------------------------------------------------------
 118
 119 (defmethod initialize-instance :after ((object basic-edge) &key graph edge-id)
 120   (when (and graph (not edge-id))
 121     (setf (slot-value object 'edge-id)
 122           (largest-edge-id graph))
 123     (incf (slot-value graph 'largest-edge-id))))
 124
 125 ;;; ---------------------------------------------------------------------------
 126
 127 (defmethod print-object ((object basic-edge) stream)
 128   (print-unreadable-object (object stream :type t)
 129     (format stream "<~A ~A>" (vertex-1 object) (vertex-2 object))))
 130
 131 ;;; ---------------------------------------------------------------------------
 132
 133 (defclass* directed-edge-mixin () ()
 134   (:export-p t)
 135   (:documentation "This mixin class is used to indicate that an edge is directed."))
 136
 137 ;;; ---------------------------------------------------------------------------
 138
 139 (defclass* weighted-edge-mixin ()
 140   ((weight 1d0 ia "The value of the weight of this edge. Defaults to 1.0d0"))
 141   :export-slots
 142   (:export-p t)
 143   (:documentation "This mixin class adds a `weight` slot to an edge."))
 144
 145 ;;; ---------------------------------------------------------------------------
 146
 147 (defmethod weight ((edge basic-edge)) (values 1.0))
 148
 149 ;;; ---------------------------------------------------------------------------
 150
 151 (defclass* basic-graph ()
 152   ((graph-vertexes :unbound ir)
 153    (graph-edges :unbound ir)
 154    (largest-vertex-id 0 r)
 155    (largest-edge-id 0 r)
 156    (vertex-class 'basic-vertex ir
 157                  "The class of the vertexes in the graph. This must extend the base-class for vertexes of the graph type. E.g., all vertexes of a graph-container must extend graph-container-vertex.")
 158    (directed-edge-class 'basic-directed-edge ir
 159                         "The class used to create directed edges in the graph. This must extend the base-class for edges of the graph type and directed-edge-mixin. E.g., the directed-edge-class of a graph-container must extend graph-container-edge and directed-edge-mixin.")
 160    (undirected-edge-class 'basic-edge ir
 161                           "The class used to create undirected edges in the graph. This must extend the base-class for edges of the graph type. E.g., all edges of a graph-container must extend graph-container-edge")
 162    (contains-directed-edge-p nil ar
 163                              "Returns true if graph contains at least one directed edge. [?? Not sure if this is really keep up-to-date.]")
 164    (contains-undirected-edge-p nil ar
 165                                "Returns true if graph contains at least one undirected edge. [?? Not sure if this is really keep up-to-date.]")
 166    (vertex-test #'eq ir)
 167    (vertex-key #'identity ir)
 168    (edge-test #'eq ir)
 169    (edge-key #'identity ir)
 170    (default-edge-type nil ir
 171      "The default edge type for the graph. This should be one of :undirected or :directed.")
 172    (default-edge-class nil ir
 173      "The default edge class for the graph."))
 174   (:make-load-form-p t)
 175   (:export-slots vertex-class directed-edge-class undirected-edge-class
 176                  default-edge-type default-edge-class)
 177   (:default-initargs
 178     :initial-size 25)
 179   (:documentation "This is the root class for all graphs in CL-Graph."))
 180
 181 ;;; ---------------------------------------------------------------------------
 182
 183 (defmethod initialize-instance :after ((object basic-graph) &key initial-size
 184                                        &allow-other-keys)
 185   (setf (slot-value object 'graph-vertexes)
 186         (make-vertex-container object initial-size))
 187   (setf (slot-value object 'graph-edges)
 188         (make-edge-container object initial-size)))
 189
 190 ;;; ---------------------------------------------------------------------------
 191
 192 (defmethod print-object ((graph basic-graph) stream)
 193   (print-unreadable-object (graph stream :type t :identity t)
 194     (format stream "[~A,~A]" (size graph) (edge-count graph))))
 195
 196
 197 ;;; ---------------------------------------------------------------------------
 198 ;;; internals
 199 ;;; ---------------------------------------------------------------------------
 200
 201 (defmethod add-vertex ((graph basic-graph) (value basic-vertex) &key if-duplicate-do)
 202   (declare (ignore if-duplicate-do))
 203   (values value))
 204
 205 ;;; ---------------------------------------------------------------------------
 206
 207 (defmethod make-vertex-for-graph ((graph basic-graph) &rest args &key
 208                                   (vertex-class (vertex-class graph))
 209                                   &allow-other-keys)
 210   (remf args :vertex-class)
 211   (assert (subtypep vertex-class (vertex-class graph)) nil
 212           "Vertex class '~A' must be a subtype of ~A" vertex-class (vertex-class graph))
 213   (apply #'make-instance vertex-class :graph graph args))
 214
 215 ;;; ---------------------------------------------------------------------------
 216
 217 (defmethod make-edge-for-graph ((graph basic-graph)
 218                                 (vertex-1 basic-vertex) (vertex-2 basic-vertex)
 219                                 &rest args &key
 220                                 (edge-type (default-edge-type graph))
 221                                 (edge-class (default-edge-class graph))
 222                                 &allow-other-keys)
 223   (remf args :edge-class)
 224   (remf args :edge-type)
 225   (assert (or (null edge-type)
 226               (eq edge-type :directed)
 227               (eq edge-type :undirected)) nil
 228           "Edge-type must be nil, :directed or :undirected.")
 229
 230   (assert (or (null edge-class)
 231               (subtypep edge-class (directed-edge-class graph))
 232               (subtypep edge-class (undirected-edge-class graph))) nil
 233           "Edge-class must be nil or a subtype of ~A or ~A"
 234           (undirected-edge-class graph)
 235           (directed-edge-class graph))
 236
 237   (apply #'make-instance
 238          (or edge-class
 239              (ecase edge-type
 240                (:directed (directed-edge-class graph))
 241                (:undirected (undirected-edge-class graph))
 242                ((nil) nil))
 243              (undirected-edge-class graph))
 244          :graph graph
 245          :vertex-1 vertex-1 :vertex-2 vertex-2 args))
 246
 247 ;;; ---------------------------------------------------------------------------
 248
 249 (defmethod make-graph ((graph-type symbol) &rest args &key &allow-other-keys)
 250   (apply #'make-instance graph-type args))
 251
 252 ;;; ---------------------------------------------------------------------------
 253
 254 (defmethod make-graph ((classes list) &rest args)
 255   (let ((name (find-or-create-class 'basic-graph classes)))
 256     (apply #'make-instance name args)))
 257
 258 ;;; ---------------------------------------------------------------------------
 259 ;;; generic implementation
 260 ;;; ---------------------------------------------------------------------------
 261
 262 (defmethod undirected-edge-p ((edge basic-edge))
 263   (not (directed-edge-p edge)))
 264
 265 ;;; ---------------------------------------------------------------------------
 266
 267 (defmethod directed-edge-p ((edge basic-edge))
 268   (typep edge 'directed-edge-mixin))
 269
 270 ;;; ---------------------------------------------------------------------------
 271
 272 (defmethod tagged-edge-p ((edge basic-edge))
 273   (tag edge))
 274
 275 ;;; ---------------------------------------------------------------------------
 276
 277 (defmethod untagged-edge-p ((edge basic-edge))
 278   (null (tag edge)))
 279
 280 ;;; ---------------------------------------------------------------------------
 281
 282 (defmethod tag-all-edges ((graph basic-graph))
 283   (iterate-edges
 284    graph
 285    (lambda (e)
 286      (setf (tag e) t))))
 287
 288 ;;; ---------------------------------------------------------------------------
 289
 290 (defmethod tag-all-edges ((vertex basic-vertex))
 291   (iterate-edges
 292    vertex
 293    (lambda (e)
 294      (setf (tag e) t))))
 295
 296 ;;; ---------------------------------------------------------------------------
 297
 298 (defmethod untag-all-edges ((graph basic-graph))
 299   (iterate-edges
 300    graph
 301    (lambda (e)
 302      (setf (tag e) nil))))
 303
 304 ;;; ---------------------------------------------------------------------------
 305
 306 (defmethod untag-all-edges ((vertex basic-vertex))
 307   (iterate-edges
 308    vertex
 309    (lambda (e)
 310      (setf (tag e) nil))))
 311
 312 ;;; ---------------------------------------------------------------------------
 313
 314 (defmethod untag-edges ((edges list))
 315   (iterate-nodes
 316    edges
 317    (lambda (e)
 318      (setf (tag e) nil))))
 319
 320 ;;; ---------------------------------------------------------------------------
 321
 322 (defmethod tag-edges ((edges list))
 323   (iterate-nodes
 324    edges
 325    (lambda (e)
 326      (setf (tag e) t))))
 327
 328
 329 ;;; ---------------------------------------------------------------------------
 330
 331 (defmethod (setf element) :around ((value t) (vertex basic-vertex))
 332   (with-changing-vertex (vertex)
 333     (call-next-method)))
 334
 335 ;;; ---------------------------------------------------------------------------
 336
 337 ;; :ignore, :force, :replace, <function>
 338
 339 (defmethod add-vertex ((graph basic-graph) (value t) &rest args &key
 340                        (if-duplicate-do :ignore) &allow-other-keys)
 341   (remf args :if-duplicate-do)
 342   (let ((existing-vertex (find-vertex graph value nil)))
 343     (labels ((make-it ()
 344                (apply #'make-vertex-for-graph graph :element value args))
 345              (add-it (why)
 346                (values (add-vertex graph (make-it)) why)))
 347       (if existing-vertex
 348         (cond ((eq if-duplicate-do :ignore)
 349                (values existing-vertex :ignore))
 350
 351               ((eq if-duplicate-do :force)
 352                (add-it :force))
 353
 354               ((eq if-duplicate-do :replace)
 355                (replace-vertex graph existing-vertex (make-it)))
 356
 357               ((eq if-duplicate-do :replace-value)
 358                (setf (element existing-vertex) value)
 359                (values existing-vertex :replace-value))
 360
 361               (t
 362                (values (funcall if-duplicate-do existing-vertex)
 363                        :duplicate)))
 364
 365         ;; not found, add
 366         (add-it :new)))))
 367
 368 ;;; ---------------------------------------------------------------------------
 369
 370 (defmethod replace-vertex ((graph basic-graph) (old basic-vertex) (new basic-vertex))
 371   ;; we need the graph and the new vertex to reference each other
 372   ;; we need every edge of the old vertex to use the new-vertex
 373   ;; we need to remove the old vertex
 374   ;;
 375   ;; since I'm tired today, let's ignore trying to make this elegant
 376
 377   ;; first, we connect the edges to the new vertex so that they don't get deleted
 378   ;; when we delete the old vertex
 379   (iterate-edges
 380    old
 381    (lambda (e)
 382      (if (eq (vertex-1 e) old)
 383        (setf (slot-value e 'vertex-1) new) (setf (slot-value e 'vertex-2) new))
 384      (add-edge-to-vertex e new)))
 385
 386   (delete-vertex graph old)
 387   (add-vertex graph new))
 388
 389 ;;; ---------------------------------------------------------------------------
 390
 391 (defmethod add-edge-between-vertexes ((graph basic-graph) (value-1 t) (value-2 t)
 392                                       &rest args &key (if-duplicate-do :ignore)
 393                                       &allow-other-keys)
 394   (declare (ignore if-duplicate-do)
 395            (dynamic-extent args))
 396   (let ((v1 (or (find-vertex graph value-1 nil)
 397                 (add-vertex graph value-1 :if-duplicate-do :ignore)))
 398         (v2 (or (find-vertex graph value-2 nil)
 399                 (add-vertex graph value-2  :if-duplicate-do :replace))))
 400     (apply #'add-edge-between-vertexes graph v1 v2 args)))
 401
 402 ;;; ---------------------------------------------------------------------------
 403 ;;; to-do - add-edge-between-vertexes needs to be able to grab the weight and
 404 ;;; color from edges that inherit from weight and color mixins
 405 ;;; ---------------------------------------------------------------------------
 406
 407 (defmethod add-edge-between-vertexes ((graph basic-graph)
 408                                       (v-1 basic-vertex) (v-2 basic-vertex)
 409                                       &rest args &key
 410                                       (value nil) (if-duplicate-do :ignore)
 411                                       &allow-other-keys)
 412   (declare (dynamic-extent args))
 413   (remf args :if-duplicate-do)
 414
 415   (let ((edge (find-edge-between-vertexes graph v-1 v-2 :error-if-not-found? nil)))
 416     (flet ((add-it (why)
 417              (values (add-edge
 418                       graph
 419                       (apply #'make-edge-for-graph graph v-1 v-2 args))
 420                      why)))
 421       (if edge
 422         (cond
 423          ((eq if-duplicate-do :ignore)
 424           (values edge :ignore))
 425
 426          ((eq if-duplicate-do :force)
 427           (add-it :force))
 428
 429          ((eq if-duplicate-do :force-if-different-value)
 430           (if (equal (value edge) value)
 431             (values :ignore)
 432             (add-it :force)))
 433
 434
 435          ((eq if-duplicate-do :replace)
 436           (warn "replace edges isn't really implemented, maybe you can use :replace-value")
 437           (delete-edge graph edge)
 438           (add-it :replace))
 439
 440          ((eq if-duplicate-do :replace-value)
 441           (setf (element edge) value)
 442           (values edge :replace-value))
 443
 444          (t
 445           (setf edge (funcall if-duplicate-do edge))
 446           (values edge :duplicate)))
 447
 448         ;; not found, add
 449         (add-it :new)))))
 450
 451
 452 ;;; ---------------------------------------------------------------------------
 453
 454 (defmethod add-edge-to-vertex ((edge basic-edge) (vertex basic-vertex))
 455   (values))
 456
 457 ;;; ---------------------------------------------------------------------------
 458
 459 (defmethod find-edge-between-vertexes ((graph basic-graph) (value-1 t) (value-2 t)
 460                                        &key (error-if-not-found? t))
 461   (let ((v1 (find-vertex graph value-1 error-if-not-found?))
 462         (v2 (find-vertex graph value-2 error-if-not-found?)))
 463     (aif (and v1 v2 (find-edge-between-vertexes graph v1 v2))
 464          it
 465          (when error-if-not-found?
 466            (error 'graph-edge-not-found-error :vertex-1 v1 :vertex-2 v2)))))
 467
 468 ;;; ---------------------------------------------------------------------------
 469
 470 (defmethod delete-edge-between-vertexes ((graph basic-graph)
 471                                          (value-or-vertex-1 t)
 472                                          (value-or-vertex-2 t) &rest args)
 473   (let ((edge (apply #'find-edge-between-vertexes
 474                      graph value-or-vertex-1 value-or-vertex-2 args)))
 475     (when edge
 476       (delete-edge graph edge))))
 477
 478 ;;; ---------------------------------------------------------------------------
 479
 480 (defmethod delete-edge :after ((graph basic-graph) (edge basic-edge))
 481   (delete-item (graph-edges graph) edge)
 482   edge)
 483
 484 ;;; ---------------------------------------------------------------------------
 485
 486 (defmethod delete-vertex ((graph basic-graph) value-or-vertex)
 487   (delete-vertex graph (find-vertex graph value-or-vertex)))
 488
 489 ;;; ---------------------------------------------------------------------------
 490
 491 (defmethod delete-vertex ((graph basic-graph) (vertex basic-vertex))
 492   (unless (eq graph (graph vertex))
 493     (error 'graph-vertex-not-found-error
 494            :graph graph :vertex vertex))
 495
 496   (iterate-edges
 497    vertex
 498    (lambda (edge)
 499      (delete-edge graph edge)))
 500
 501   (empty! (vertex-edges vertex))
 502   (values vertex graph))
 503
 504 ;;; ---------------------------------------------------------------------------
 505
 506 (defmethod delete-vertex :after ((graph basic-graph)
 507                                  (vertex basic-vertex))
 508   (setf (slot-value vertex 'graph) nil)
 509   (delete-item-at (graph-vertexes graph)
 510                   (funcall (vertex-key graph) (element vertex))))
 511
 512 ;;; ---------------------------------------------------------------------------
 513
 514 (defmethod insert-item ((graph basic-graph) value)
 515   (add-vertex graph value))
 516
 517 ;;; ---------------------------------------------------------------------------
 518
 519 (defmethod source-edges ((vertex basic-vertex) &optional filter)
 520   (collect-using #'iterate-source-edges filter vertex))
 521
 522 ;;; ---------------------------------------------------------------------------
 523
 524 (defmethod target-edges ((vertex basic-vertex) &optional filter)
 525   (collect-using #'iterate-target-edges filter vertex))
 526
 527 ;;; ---------------------------------------------------------------------------
 528
 529 (defmethod child-vertexes (vertex &optional filter)
 530   (collect-using #'iterate-children filter vertex))
 531
 532 ;;; ---------------------------------------------------------------------------
 533
 534 (defmethod parent-vertexes (vertex &optional filter)
 535   (collect-using #'iterate-parents filter vertex))
 536
 537 ;;; ---------------------------------------------------------------------------
 538
 539 (defmethod neighbor-vertexes (vertex &optional filter)
 540   (collect-using #'iterate-neighbors filter vertex))
 541
 542 ;;; ---------------------------------------------------------------------------
 543
 544 (defmethod adjacentp ((graph basic-graph) vertex-1 vertex-2)
 545   (adjacentp graph (find-vertex graph vertex-1) (find-vertex graph vertex-2)))
 546
 547 ;;; ---------------------------------------------------------------------------
 548
 549 (defmethod adjacentp ((graph basic-graph) (vertex-1 basic-vertex) (vertex-2 basic-vertex))
 550   (iterate-neighbors
 551    vertex-1
 552    (lambda (vertex)
 553      (when (eq vertex vertex-2)
 554        (return-from adjacentp t))))
 555   (values nil))
 556
 557 ;;; ---------------------------------------------------------------------------
 558
 559 (defmethod number-of-neighbors (vertex)
 560   (count-using #'iterate-neighbors nil vertex))
 561
 562 ;;; ---------------------------------------------------------------------------
 563
 564 (defmethod in-cycle-p ((graph basic-graph) (vertex t))
 565   (in-cycle-p graph (find-vertex graph vertex)))
 566
 567 ;;; ---------------------------------------------------------------------------
 568
 569 (defmethod renumber-vertexes ((graph basic-graph))
 570   (let ((count 0))
 571     (iterate-vertexes graph (lambda (vertex)
 572                               (setf (slot-value vertex 'vertex-id) count)
 573                               (incf count)))
 574     (setf (slot-value graph 'largest-vertex-id) count)))
 575
 576 ;;; ---------------------------------------------------------------------------
 577
 578 (defmethod renumber-edges ((graph basic-graph))
 579   (let ((count 0))
 580     (iterate-edges graph (lambda (vertex)
 581                            (setf (slot-value vertex 'edge-id) count)
 582                            (incf count)))
 583     (setf (slot-value graph 'largest-edge-id) count)))
 584
 585 ;;; ---------------------------------------------------------------------------
 586
 587 (deprecated
 588   (defmethod container->list ((graph basic-graph))
 589     (collect-elements (graph-vertexes graph))))
 590
 591 ;;; ---------------------------------------------------------------------------
 592
 593 (defmethod add-vertex :before ((graph basic-graph) (vertex basic-vertex)
 594                                &key &allow-other-keys)
 595
 596   (assert (typep vertex (vertex-class graph)))
 597   (setf (item-at (graph-vertexes graph)
 598                  (funcall (vertex-key graph) (element vertex))) vertex
 599         (slot-value vertex 'graph) graph))
 600
 601 ;;; ---------------------------------------------------------------------------
 602
 603 (defmethod add-edge :before ((graph basic-graph) (edge basic-edge) &key force-new?)
 604   (declare (ignore force-new?))
 605   (insert-item (graph-edges graph) edge)
 606   (setf (slot-value edge 'graph) graph)
 607   (if (subtypep (class-name (class-of edge)) 'directed-edge-mixin)
 608     (progn (setf (contains-directed-edge-p graph) t))
 609     (progn (setf (contains-undirected-edge-p graph) t))))
 610
 611 ;;; ---------------------------------------------------------------------------
 612
 613 (defmethod find-vertex ((graph basic-graph) (value t)
 614                         &optional (error-if-not-found? t))
 615   (aif (find-item (graph-vertexes graph) (funcall (vertex-key graph) value))
 616        it
 617        (when error-if-not-found?
 618          (error 'graph-vertex-not-found-error :vertex value :graph graph))))
 619
 620 ;;; ---------------------------------------------------------------------------
 621
 622 (defmethod find-vertex ((edge basic-edge) (value t)
 623                         &optional (error-if-not-found? t))
 624   (iterate-vertexes
 625    edge
 626    (lambda (vertex)
 627      (when (funcall (vertex-test (graph edge))
 628                     (funcall (vertex-key (graph edge)) (element vertex)) value)
 629        (return-from find-vertex vertex))))
 630   (when error-if-not-found?
 631     (error 'graph-vertex-not-found-in-edge-error :vertex value :edge edge)))
 632
 633 ;;; ---------------------------------------------------------------------------
 634
 635 (defmethod search-for-vertex ((graph basic-graph) (value t)
 636                               &key (key (vertex-key graph)) (test 'equal)
 637                               (error-if-not-found? t))
 638   (aif (search-for-node graph value :test test :key key)
 639        it
 640        (when error-if-not-found?
 641          (error "~S not found in ~A using key ~S and test ~S" value graph key
 642                 test))))
 643
 644 ;;; ---------------------------------------------------------------------------
 645
 646 (defmethod search-for-vertex ((graph basic-graph) (vertex basic-vertex)
 647                               &key (key (vertex-key graph)) (test 'equal)
 648                               (error-if-not-found? t))
 649   (aif (search-for-node (graph-vertexes graph) vertex :test test :key key)
 650        it
 651        (when error-if-not-found?
 652          (error "~A not found in ~A" vertex graph))))
 653
 654 ;;; ---------------------------------------------------------------------------
 655 ;; TODO !!! dispatch is the same as the second method above
 656 (defmethod search-for-vertex ((graph basic-graph) (vertex t)
 657                               &key (key (vertex-key graph)) (test 'equal)
 658                               (error-if-not-found? t))
 659   (aif (search-for-element (graph-vertexes graph) vertex :test test :key key)
 660        it
 661        (when error-if-not-found?
 662          (error "~A not found in ~A" vertex graph))))
 663
 664 ;;; ---------------------------------------------------------------------------
 665
 666 (defmethod iterate-elements ((graph basic-graph) fn)
 667    (iterate-elements (graph-vertexes graph)
 668                      (lambda (vertex) (funcall fn (element vertex)))))
 669
 670 ;;; ---------------------------------------------------------------------------
 671
 672 (defmethod iterate-nodes ((graph basic-graph) fn)
 673    (iterate-nodes (graph-vertexes graph) fn))
 674
 675 ;;; ---------------------------------------------------------------------------
 676
 677 (defmethod iterate-vertexes ((graph basic-graph) fn)
 678    (iterate-nodes (graph-vertexes graph) fn))
 679
 680 ;;; ---------------------------------------------------------------------------
 681
 682 (defmethod iterate-vertexes ((edge basic-edge) fn)
 683   (funcall fn (vertex-1 edge))
 684   (funcall fn (vertex-2 edge)))
 685
 686 ;;; ---------------------------------------------------------------------------
 687
 688 (defmethod size ((graph basic-graph))
 689   (size (graph-vertexes graph)))
 690
 691 ;;; ---------------------------------------------------------------------------
 692
 693 (defmethod edges ((graph basic-graph))
 694   (collect-using #'iterate-edges nil graph))
 695
 696 ;;; ---------------------------------------------------------------------------
 697
 698 (defmethod edges ((vertex basic-vertex))
 699   (collect-using #'iterate-edges nil vertex))
 700
 701 ;;; ---------------------------------------------------------------------------
 702
 703 (deprecated
 704   "Use size instead"
 705   (defmethod vertex-count ((graph basic-graph))
 706     (size graph)))
 707
 708 ;;; ---------------------------------------------------------------------------
 709
 710 (defmethod vertexes ((graph basic-graph))
 711   (collect-elements (graph-vertexes graph)))
 712
 713 ;;; ---------------------------------------------------------------------------
 714
 715 (defmethod source-edge-count ((vertex basic-vertex))
 716   (count-using 'iterate-source-edges nil vertex))
 717
 718 ;;; ---------------------------------------------------------------------------
 719
 720 (defmethod target-edge-count ((vertex basic-vertex))
 721   (count-using 'iterate-target-edges nil vertex))
 722
 723 ;;; ---------------------------------------------------------------------------
 724
 725 (defmethod graph-roots ((graph basic-graph))
 726   (collect-elements (graph-vertexes graph) :filter #'rootp))
 727
 728 ;;; ---------------------------------------------------------------------------
 729
 730 (defmethod rootp ((vertex basic-vertex))
 731   ;;?? this is inefficient in the same way that (zerop (length <list>)) is...
 732   (zerop (source-edge-count vertex)))
 733
 734 ;;; ---------------------------------------------------------------------------
 735
 736 (defmethod find-vertex-if ((graph basic-graph) fn &key key)
 737   (iterate-vertexes graph
 738                     (lambda (v)
 739                       (when (funcall fn (if key (funcall key v) v))
 740                         (return-from find-vertex-if v))))
 741   (values nil))
 742
 743 ;;; ---------------------------------------------------------------------------
 744
 745 (defmethod find-vertex-if ((edge basic-edge) fn &key key)
 746   (iterate-vertexes edge
 747                     (lambda (v)
 748                       (when (funcall fn (if key (funcall key v) v))
 749                         (return-from find-vertex-if v))))
 750   (values nil))
 751
 752 ;;; ---------------------------------------------------------------------------
 753
 754 (defmethod find-edge-if ((graph basic-graph) fn &key key)
 755   (iterate-edges graph
 756                  (lambda (e)
 757                    (when (funcall fn (if key (funcall key e) e))
 758                      (return-from find-edge-if e))))
 759   (values nil))
 760
 761 ;;; ---------------------------------------------------------------------------
 762
 763 (defmethod find-edges-if ((graph basic-graph) fn)
 764   (collect-using 'iterate-edges fn graph))
 765
 766 ;;; ---------------------------------------------------------------------------
 767
 768 (defmethod find-vertexes-if ((graph basic-graph) fn)
 769   (collect-using 'iterate-vertexes fn graph))
 770
 771 ;;; ---------------------------------------------------------------------------
 772
 773 (defmethod empty! ((graph basic-graph))
 774   (empty! (graph-edges graph))
 775   (empty! (graph-vertexes graph))
 776   (renumber-edges graph)
 777   (renumber-vertexes graph)
 778   (values))
 779
 780 ;;; ---------------------------------------------------------------------------
 781
 782 (defun neighbors-to-children (new-graph root &optional visited-list)
 783   (pushnew root visited-list)
 784   (iterate-neighbors
 785    root
 786    (lambda (c)
 787      (when (not (member c visited-list))
 788        (add-edge-between-vertexes
 789         new-graph (value root) (value c) :edge-type :directed)
 790        (neighbors-to-children new-graph c visited-list)))))
 791
 792 ;;; ---------------------------------------------------------------------------
 793
 794 (defmethod generate-directed-free-tree ((graph basic-graph) root)
 795   (generate-directed-free-tree graph (find-vertex graph root)))
 796
 797 ;;; ---------------------------------------------------------------------------
 798
 799 (defmethod force-undirected ((graph basic-graph))
 800   (iterate-edges
 801    graph
 802    (lambda (edge)
 803      (change-class edge (undirected-edge-class graph)))))
 804
 805
 806
 807 ;;; ---------------------------------------------------------------------------
 808 ;;; traversal
 809 ;;; ---------------------------------------------------------------------------
 810
 811 (defmethod traverse-elements ((thing basic-graph) (style symbol) fn)
 812   (let ((marker (gensym)))
 813     (iterate-vertexes
 814      thing
 815      (lambda (vertex)
 816        (setf (tag vertex) marker)))
 817
 818     (iterate-elements
 819      (graph-roots thing)
 820      (lambda (vertex)
 821        (traverse-elements-helper vertex style marker fn)))))
 822
 823 ;;; ---------------------------------------------------------------------------
 824
 825 (defmethod traverse-elements-helper ((thing basic-vertex) (style (eql :depth)) marker fn)
 826   (when (eq (tag thing) marker)
 827     (nilf (tag thing))
 828     (iterate-children
 829      thing
 830      (lambda (vertex)
 831        (traverse-elements-helper vertex style marker fn)))
 832
 833     (funcall fn thing)))
 834
 835 ;;; ---------------------------------------------------------------------------
 836
 837 (defmethod traverse-elements-helper ((thing basic-vertex) (style (eql :breadth)) marker fn)
 838   (when (eq (tag thing) marker)
 839     (nilf (tag thing))
 840     (funcall fn thing))
 841
 842   (iterate-neighbors
 843    thing
 844    (lambda (vertex)
 845      (when (eq (tag vertex) marker)
 846        (funcall fn vertex))))
 847
 848   (iterate-neighbors
 849    thing
 850    (lambda (vertex)
 851      (when (eq (tag vertex) marker)
 852        (nilf (tag vertex))
 853        (traverse-elements-helper vertex style marker fn)))))
 854
 855 ;;; ---------------------------------------------------------------------------
 856
 857 (defmethod in-cycle-p ((graph basic-graph) (start-vertex basic-vertex))
 858   (let ((first-time? t))
 859     (not (null
 860           (graph-search
 861            (list start-vertex)
 862            (lambda (v)
 863              (if first-time?
 864                (nilf first-time?)
 865                (eq (find-vertex graph v) start-vertex)))
 866            (lambda (v)
 867              (child-vertexes v))
 868            #'append
 869            :new-state-fn
 870            (lambda (states successors state= old-states)
 871              ;; Generate successor states that have not been seen before but
 872              ;; don't remove the start state.
 873              (remove-if
 874               #'(lambda (state)
 875                   (and (not (eq start-vertex state))
 876                        (or (member state states :test state=)
 877                            (member state old-states :test state=))))
 878               (funcall successors (first states)))))))))
 879
 880 ;;; ---------------------------------------------------------------------------
 881
 882 (defmethod in-undirected-cycle-p
 883            ((graph basic-graph) (current basic-vertex)
 884             &optional (marked (make-container 'simple-associative-container))
 885             (previous nil))
 886   (block do-it
 887     (tf (item-at-1 marked current))
 888     (iterate-children current
 889                       (lambda (child)
 890                         (cond
 891                          ((eq child previous) nil)
 892                          ((item-at-1 marked child) (return-from do-it t))
 893                          (t
 894                           (in-undirected-cycle-p graph child marked current)))))))
 895
 896 ;;; ---------------------------------------------------------------------------
 897
 898 (defmethod any-undirected-cycle-p ((graph basic-graph))
 899   (let ((marked (make-container 'simple-associative-container)))
 900     (iterate-vertexes graph (lambda (v)
 901                               (unless (item-at-1 marked v)
 902                                 (when (in-undirected-cycle-p graph v marked)
 903                                   (return-from any-undirected-cycle-p v)))))
 904     (values nil)))
 905
 906 ;;; ---------------------------------------------------------------------------
 907
 908 (defun remove-list (original target)
 909   "Removes all elements in original from target."
 910   (remove-if (lambda (target-element)
 911                (member target-element original))
 912              target))
 913
 914 ;;; ---------------------------------------------------------------------------
 915
 916 (defun get-nodelist-relatives (node-list)
 917   "Collects set of unique relatives of nodes in node-list."
 918   (let ((unique-relatives nil))
 919     (dolist (node node-list)
 920       (setf unique-relatives
 921             (append-unique (neighbor-vertexes node) unique-relatives)))
 922     unique-relatives))
 923
 924 ;;; ---------------------------------------------------------------------------
 925
 926 (defun get-transitive-closure (vertex-list &optional (depth nil))
 927   "Given a list of vertices, returns a combined list of all of the nodes
 928 in the transitive closure(s) of each of the vertices in the list
 929 (without duplicates).  Optional DEPTH limits the depth (in _both_ the
 930 child and parent directions) to which the closure is gathered; default
 931 nil gathers the entire closure(s)."
 932   (labels ((collect-transitive-closure (remaining visited depth)
 933              (if (and remaining
 934                       (typecase depth
 935                         (null t)
 936                         (fixnum (>= (decf depth) 0))))
 937
 938               (let* ((non-visited-relatives     ;; list of relatives not yet visited
 939                        (remove-list visited
 940                                     (get-nodelist-relatives remaining)))
 941                       (visited-nodes            ;; list of nodes visited so far
 942                        (append-unique non-visited-relatives visited)))
 943                  (collect-transitive-closure non-visited-relatives
 944                                              visited-nodes
 945                                              depth))
 946                (values visited))))
 947     (collect-transitive-closure vertex-list vertex-list depth)))
 948
 949 ;;; ---------------------------------------------------------------------------
 950 ;;; make-filtered-graph
 951 ;;; ---------------------------------------------------------------------------
 952
 953 (defmethod complete-links ((new-graph basic-graph)
 954                            (old-graph basic-graph))
 955   ;; Copy links from old-graph ONLY for nodes already in new-graph
 956   (iterate-vertexes
 957    new-graph
 958    (lambda (vertex)
 959      (let ((old-graph-vertex (find-vertex old-graph (value vertex))))
 960        (iterate-edges
 961         old-graph-vertex
 962         (lambda (old-edge)
 963           (let* ((old-other-vertex (other-vertex old-edge old-graph-vertex))
 964                  (new-other-vertex (find-vertex new-graph (value old-other-vertex) nil)))
 965             (when (and new-other-vertex
 966                        (< (vertex-id vertex) (vertex-id new-other-vertex)))
 967               (let* ((new-edge (copy-template old-edge)))
 968                 (if (eq old-graph-vertex (vertex-1 old-edge))
 969                   (setf (slot-value new-edge 'vertex-1) vertex
 970                         (slot-value new-edge 'vertex-2) new-other-vertex)
 971                   (setf (slot-value new-edge 'vertex-2) vertex
 972                         (slot-value new-edge 'vertex-1) new-other-vertex))
 973                 (add-edge new-graph new-edge))))))))))
 974
 975 #+Old
 976 (defmethod complete-links ((new-graph basic-graph)
 977                            (old-graph basic-graph))
 978   ;; Copy links from old-graph ONLY for nodes already in new-graph
 979   (iterate-vertexes
 980    new-graph
 981    (lambda (vertex)
 982      (let ((old-graph-vertex (find-vertex old-graph (value vertex))))
 983        (iterate-edges
 984         old-graph-vertex
 985         (lambda (edge)
 986           (let* ((old-other-vertex (other-vertex edge old-graph-vertex))
 987                  (new-other-vertex (find-vertex new-graph (value old-other-vertex) nil))
 988                  (edge-type (if (directed-edge-p edge)
 989                               :directed :undirected)))
 990             (when new-other-vertex
 991               (if (and (directed-edge-p edge)
 992                        (eq old-graph-vertex (target-vertex edge)))
 993                 (add-edge-between-vertexes new-graph new-other-vertex vertex
 994                                            :value (value edge)
 995                                            :edge-type edge-type)
 996                 (add-edge-between-vertexes new-graph vertex new-other-vertex
 997                                            :value (value edge)
 998                                            :edge-type edge-type))))))))))
 999
1000 ;;; ---------------------------------------------------------------------------
1001
1002 (defmethod make-filtered-graph ((old-graph basic-graph)
1003                                 test-fn
1004                                 &optional
1005                                 (graph-completion-method nil)
1006                                 (depth nil))
1007   (let ((new-graph
1008          (copy-template old-graph)))
1009     (ecase graph-completion-method
1010       ((nil
1011         :complete-links)
1012        (iterate-vertexes old-graph
1013                          (lambda (vertex)
1014                            (when (funcall test-fn vertex)
1015                              (add-vertex new-graph (value vertex))))))
1016       ((:complete-closure-nodes-only
1017         :complete-closure-with-links)
1018        (let* ((old-graph-vertexes  (collect-items old-graph :filter test-fn))
1019               (closure-vertexes
1020                (get-transitive-closure old-graph-vertexes depth)))
1021          (dolist (vertex closure-vertexes)
1022            (add-vertex new-graph (copy-template vertex))))))
1023
1024     (ecase graph-completion-method
1025       ((nil :complete-closure-nodes-only) nil)
1026       ((:complete-links
1027         :complete-closure-with-links)
1028        (complete-links new-graph old-graph)))
1029
1030     new-graph))
1031
1032 ;;; ---------------------------------------------------------------------------
1033
1034 (defmethod subgraph-containing ((graph basic-graph) (vertex basic-vertex)
1035                                 &optional (depth nil))
1036   (make-filtered-graph graph
1037                        #'(lambda (v)
1038                            (equal v vertex))
1039                        :complete-closure-with-links
1040                        depth))
1041
1042 ;;; ---------------------------------------------------------------------------
1043
1044 (defmethod edge-count ((graph basic-graph))
1045   (count-using #'iterate-edges nil graph))
1046
1047 ;;; ---------------------------------------------------------------------------
1048
1049 (defmethod edge-count ((vertex basic-vertex))
1050   (size (vertex-edges vertex)))
1051
1052 ;;; ---------------------------------------------------------------------------
1053
1054 (defmethod topological-sort ((graph basic-graph))
1055   (assign-level graph 0)
1056   (sort (collect-elements (graph-vertexes graph))  #'<
1057         :key (lambda (x) (depth-level x))))
1058
1059 ;;; ---------------------------------------------------------------------------
1060
1061 (defmethod assign-level ((graph basic-graph) (level number))
1062   (loop for node in (graph-roots graph)
1063         do (assign-level node 0)))
1064
1065 ;;; ---------------------------------------------------------------------------
1066
1067 (defmethod assign-level ((node basic-vertex) (level number))
1068   (if (or (not (depth-level node))
1069           (> level (depth-level node)))
1070     (setf (depth-level node) level))
1071   (iterate-children node (lambda (x) (assign-level x (1+ level)))))
1072
1073 ;;; ---------------------------------------------------------------------------
1074
1075 (defmethod depth ((graph basic-graph))
1076   (assign-level graph 0)
1077   (let ((depth 0))
1078     (iterate-vertexes graph (lambda (vertex)
1079                               (maxf depth (depth-level vertex))))
1080     depth))
1081
1082 ;;; ---------------------------------------------------------------------------
1083 ;;; mapping
1084 ;;; ---------------------------------------------------------------------------
1085
1086 (defun map-paths (graph start-vertex length fn &key (filter (constantly t)))
1087   "Apply fn to each path that starts at start-vertex and is of exactly length
1088 length"
1089   ;; a sort of depth first search
1090   (labels ((follow-path (next-vertex current-path length)
1091              (when (zerop length)
1092                (funcall fn (reverse current-path)))
1093              ; (format t "~%~A ~A ~A" current-path next-vertex length)
1094              (when (plusp length)
1095                (iterate-neighbors
1096                 next-vertex
1097                 (lambda (v)
1098                   (when (funcall filter v)
1099                     ;; no repeats
1100                     (unless (find-item current-path v)
1101                       (let ((new-path  (copy-list current-path)))
1102                         (follow-path v (push v new-path) (1- length))))))))))
1103     (iterate-neighbors
1104      start-vertex
1105      (lambda (v)
1106        (when (funcall filter v)
1107          (follow-path v (list v start-vertex) (1- length))))))
1108   (values graph))
1109
1110 ;;; ---------------------------------------------------------------------------
1111
1112 (defun map-shortest-paths (graph start-vertex depth fn &key (filter (constantly t)))
1113   "Apply fn to each shortest path starting at `start-vertex` of depth `depth`. The `filter` predicate is used to remove vertexes from consideration."
1114   (bind ((visited (make-container 'simple-associative-container
1115                                   :test #'equal)))
1116     (labels ((visit (p)
1117                (setf (item-at-1 visited p) t))
1118              (visited-p (p)
1119                (item-at-1 visited p))
1120              )
1121       (loop for n from 1 to (1- depth) do
1122             (map-paths graph start-vertex n
1123                        (lambda (p)
1124                          (visit (first (last p))))
1125                        :filter filter))
1126       ;(break)
1127       (visit start-vertex)
1128       (map-paths graph start-vertex depth
1129                  (lambda (p)
1130                    (unless (visited-p (first (last p)))
1131                      (funcall fn p)))
1132                  :filter filter))))
1133
1134
1135 ;;; ---------------------------------------------------------------------------
1136 ;;; utilities
1137 ;;; ---------------------------------------------------------------------------
1138
1139 (defun append-unique (list1 list2)
1140   (remove-duplicates (append list1 list2)))
1141
1142 ;;; ---------------------------------------------------------------------------
1143 ;;; project-bipartite-graph
1144 ;;; ---------------------------------------------------------------------------
1145
1146 (defmethod project-bipartite-graph
1147            ((new-graph symbol) graph vertex-class vertex-classifier)
1148   (project-bipartite-graph
1149    (make-instance new-graph) graph vertex-class  vertex-classifier))
1150
1151 ;;; ---------------------------------------------------------------------------
1152
1153 (defmethod project-bipartite-graph
1154            ((new-graph basic-graph) graph vertex-class vertex-classifier)
1155   (iterate-vertexes
1156    graph
1157    (lambda (v)
1158      (when (eq (funcall vertex-classifier v) vertex-class)
1159        (add-vertex new-graph (element v)))))
1160
1161   (iterate-vertexes
1162    graph
1163    (lambda (v)
1164      (when (eq (funcall vertex-classifier v) vertex-class)
1165        (iterate-neighbors
1166         v
1167         (lambda (other-class-vertex)
1168           (iterate-neighbors
1169            other-class-vertex
1170            (lambda (this-class-vertex)
1171              (when (< (vertex-id v) (vertex-id this-class-vertex))
1172                (add-edge-between-vertexes
1173                 new-graph (element v) (element this-class-vertex)
1174                 :if-duplicate-do (lambda (e) (incf (weight e))))))))))))
1175
1176   new-graph)
1177
1178 #+Test
1179 (pro:with-profiling
1180   (setf (ds :g-5000-m-projection)
1181         (project-bipartite-graph
1182          'undirected-graph-container
1183          (ds :g-5000)
1184          :m
1185          (lambda (v)
1186            (let ((vertex-class (aref (symbol-name (element v)) 0)))
1187              (cond ((member vertex-class '(#\a #\b) :test #'char-equal)
1188                     :m)
1189                    ((member vertex-class '(#\x #\y #\z) :test #'char-equal)
1190                     :h)))))))
1191
1192 #+Test
1193 (pro:with-profiling
1194   (setf (ds :g-5000-h-projection)
1195         (project-bipartite-graph
1196          'undirected-graph-container
1197          (ds :g-5000)
1198          :h
1199          (lambda (v)
1200            (let ((vertex-class (aref (symbol-name (element v)) 0)))
1201              (cond ((member vertex-class '(#\a #\b) :test #'char-equal)
1202                     :m)
1203                    ((member vertex-class '(#\x #\y #\z) :test #'char-equal)
1204                     :h)))))))
1205
1206 #+Test
1207 (pro:with-profiling
1208   (project-bipartite-graph
1209    'undirected-graph-container
1210    (ds :g-1000)
1211    :m
1212    (lambda (v)
1213      (let ((vertex-class (aref (symbol-name (element v)) 0)))
1214        (cond ((member vertex-class '(#\x #\y) :test #'char-equal)
1215               :m)
1216              ((member vertex-class '(#\a #\b #\c) :test #'char-equal)
1217               :h))))))
1218
1219
1220
1221