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 (defmethod delete-all-edges :after ((graph basic-graph))
 486   (empty! (graph-edges graph))
 487   graph)
 488
 489 ;;; ---------------------------------------------------------------------------
 490
 491 (defmethod delete-vertex ((graph basic-graph) value-or-vertex)
 492   (delete-vertex graph (find-vertex graph value-or-vertex)))
 493
 494 ;;; ---------------------------------------------------------------------------
 495
 496 (defmethod delete-vertex ((graph basic-graph) (vertex basic-vertex))
 497   (unless (eq graph (graph vertex))
 498     (error 'graph-vertex-not-found-error
 499            :graph graph :vertex vertex))
 500
 501   (iterate-edges
 502    vertex
 503    (lambda (edge)
 504      (delete-edge graph edge)))
 505
 506   (empty! (vertex-edges vertex))
 507   (values vertex graph))
 508
 509 ;;; ---------------------------------------------------------------------------
 510
 511 (defmethod delete-vertex :after ((graph basic-graph)
 512                                  (vertex basic-vertex))
 513   (setf (slot-value vertex 'graph) nil)
 514   (delete-item-at (graph-vertexes graph)
 515                   (funcall (vertex-key graph) (element vertex))))
 516
 517 ;;; ---------------------------------------------------------------------------
 518
 519 (defmethod insert-item ((graph basic-graph) value)
 520   (add-vertex graph value))
 521
 522 ;;; ---------------------------------------------------------------------------
 523
 524 (defmethod source-edges ((vertex basic-vertex) &optional filter)
 525   (collect-using #'iterate-source-edges filter vertex))
 526
 527 ;;; ---------------------------------------------------------------------------
 528
 529 (defmethod target-edges ((vertex basic-vertex) &optional filter)
 530   (collect-using #'iterate-target-edges filter vertex))
 531
 532 ;;; ---------------------------------------------------------------------------
 533
 534 (defmethod child-vertexes (vertex &optional filter)
 535   (collect-using #'iterate-children filter vertex))
 536
 537 ;;; ---------------------------------------------------------------------------
 538
 539 (defmethod parent-vertexes (vertex &optional filter)
 540   (collect-using #'iterate-parents filter vertex))
 541
 542 ;;; ---------------------------------------------------------------------------
 543
 544 (defmethod neighbor-vertexes (vertex &optional filter)
 545   (collect-using #'iterate-neighbors filter vertex))
 546
 547 ;;; ---------------------------------------------------------------------------
 548
 549 (defmethod adjacentp ((graph basic-graph) vertex-1 vertex-2)
 550   (adjacentp graph (find-vertex graph vertex-1) (find-vertex graph vertex-2)))
 551
 552 ;;; ---------------------------------------------------------------------------
 553
 554 (defmethod adjacentp ((graph basic-graph) (vertex-1 basic-vertex) (vertex-2 basic-vertex))
 555   (iterate-neighbors
 556    vertex-1
 557    (lambda (vertex)
 558      (when (eq vertex vertex-2)
 559        (return-from adjacentp t))))
 560   (values nil))
 561
 562 ;;; ---------------------------------------------------------------------------
 563
 564 (defmethod number-of-neighbors (vertex)
 565   (count-using #'iterate-neighbors nil vertex))
 566
 567 ;;; ---------------------------------------------------------------------------
 568
 569 (defmethod in-cycle-p ((graph basic-graph) (vertex t))
 570   (in-cycle-p graph (find-vertex graph vertex)))
 571
 572 ;;; ---------------------------------------------------------------------------
 573
 574 (defmethod renumber-vertexes ((graph basic-graph))
 575   (let ((count 0))
 576     (iterate-vertexes graph (lambda (vertex)
 577                               (setf (slot-value vertex 'vertex-id) count)
 578                               (incf count)))
 579     (setf (slot-value graph 'largest-vertex-id) count)))
 580
 581 ;;; ---------------------------------------------------------------------------
 582
 583 (defmethod renumber-edges ((graph basic-graph))
 584   (let ((count 0))
 585     (iterate-edges graph (lambda (vertex)
 586                            (setf (slot-value vertex 'edge-id) count)
 587                            (incf count)))
 588     (setf (slot-value graph 'largest-edge-id) count)))
 589
 590 ;;; ---------------------------------------------------------------------------
 591
 592 (deprecated
 593   (defmethod container->list ((graph basic-graph))
 594     (collect-elements (graph-vertexes graph))))
 595
 596 ;;; ---------------------------------------------------------------------------
 597
 598 (defmethod add-vertex :before ((graph basic-graph) (vertex basic-vertex)
 599                                &key &allow-other-keys)
 600
 601   (assert (typep vertex (vertex-class graph)))
 602   (setf (item-at (graph-vertexes graph)
 603                  (funcall (vertex-key graph) (element vertex))) vertex
 604         (slot-value vertex 'graph) graph))
 605
 606 ;;; ---------------------------------------------------------------------------
 607
 608 (defmethod add-edge :before ((graph basic-graph) (edge basic-edge) &key force-new?)
 609   (declare (ignore force-new?))
 610   (insert-item (graph-edges graph) edge)
 611   (setf (slot-value edge 'graph) graph)
 612   (if (subtypep (class-name (class-of edge)) 'directed-edge-mixin)
 613     (progn (setf (contains-directed-edge-p graph) t))
 614     (progn (setf (contains-undirected-edge-p graph) t))))
 615
 616 ;;; ---------------------------------------------------------------------------
 617
 618 (defmethod find-vertex ((graph basic-graph) (value t)
 619                         &optional (error-if-not-found? t))
 620   (aif (find-item (graph-vertexes graph) (funcall (vertex-key graph) value))
 621        it
 622        (when error-if-not-found?
 623          (error 'graph-vertex-not-found-error :vertex value :graph graph))))
 624
 625 ;;; ---------------------------------------------------------------------------
 626
 627 (defmethod find-vertex ((edge basic-edge) (value t)
 628                         &optional (error-if-not-found? t))
 629   (iterate-vertexes
 630    edge
 631    (lambda (vertex)
 632      (when (funcall (vertex-test (graph edge))
 633                     (funcall (vertex-key (graph edge)) (element vertex)) value)
 634        (return-from find-vertex vertex))))
 635   (when error-if-not-found?
 636     (error 'graph-vertex-not-found-in-edge-error :vertex value :edge edge)))
 637
 638
 639 (defmethod search-for-vertex ((graph basic-graph) (vertex basic-vertex)
 640                               &key (key (vertex-key graph)) (test 'equal)
 641                               (error-if-not-found? t))
 642   (aif (search-for-node (graph-vertexes graph) vertex :test test :key key)
 643        it
 644        (when error-if-not-found?
 645          (error "~A not found in ~A" vertex graph))))
 646
 647 (defmethod search-for-vertex ((graph basic-graph) (vertex t)
 648                               &key (key (vertex-key graph)) (test 'equal)
 649                               (error-if-not-found? t))
 650   (aif (search-for-element (graph-vertexes graph) vertex :test test :key key)
 651        it
 652        (when error-if-not-found?
 653          (error "~A not found in ~A" vertex graph))))
 654
 655 (defmethod iterate-elements ((graph basic-graph) fn)
 656    (iterate-elements (graph-vertexes graph)
 657                      (lambda (vertex) (funcall fn (element vertex)))))
 658
 659 ;;; ---------------------------------------------------------------------------
 660
 661 (defmethod iterate-nodes ((graph basic-graph) fn)
 662    (iterate-nodes (graph-vertexes graph) fn))
 663
 664 ;;; ---------------------------------------------------------------------------
 665
 666 (defmethod iterate-vertexes ((graph basic-graph) fn)
 667    (iterate-nodes (graph-vertexes graph) fn))
 668
 669 ;;; ---------------------------------------------------------------------------
 670
 671 (defmethod iterate-vertexes ((edge basic-edge) fn)
 672   (funcall fn (vertex-1 edge))
 673   (funcall fn (vertex-2 edge)))
 674
 675 ;;; ---------------------------------------------------------------------------
 676
 677 (defmethod size ((graph basic-graph))
 678   (size (graph-vertexes graph)))
 679
 680 ;;; ---------------------------------------------------------------------------
 681
 682 (defmethod edges ((graph basic-graph))
 683   (collect-using #'iterate-edges nil graph))
 684
 685 ;;; ---------------------------------------------------------------------------
 686
 687 (defmethod edges ((vertex basic-vertex))
 688   (collect-using #'iterate-edges nil vertex))
 689
 690 ;;; ---------------------------------------------------------------------------
 691
 692 (deprecated
 693   "Use size instead"
 694   (defmethod vertex-count ((graph basic-graph))
 695     (size graph)))
 696
 697 ;;; ---------------------------------------------------------------------------
 698
 699 (defmethod vertexes ((graph basic-graph))
 700   (collect-elements (graph-vertexes graph)))
 701
 702 ;;; ---------------------------------------------------------------------------
 703
 704 (defmethod source-edge-count ((vertex basic-vertex))
 705   (count-using 'iterate-source-edges nil vertex))
 706
 707 ;;; ---------------------------------------------------------------------------
 708
 709 (defmethod target-edge-count ((vertex basic-vertex))
 710   (count-using 'iterate-target-edges nil vertex))
 711
 712 ;;; ---------------------------------------------------------------------------
 713
 714 (defmethod graph-roots ((graph basic-graph))
 715   (collect-elements (graph-vertexes graph) :filter #'rootp))
 716
 717 ;;; ---------------------------------------------------------------------------
 718
 719 (defmethod rootp ((vertex basic-vertex))
 720   ;;?? this is inefficient in the same way that (zerop (length <list>)) is...
 721   (zerop (source-edge-count vertex)))
 722
 723 ;;; ---------------------------------------------------------------------------
 724
 725 (defmethod find-vertex-if ((graph basic-graph) fn &key key)
 726   (iterate-vertexes graph
 727                     (lambda (v)
 728                       (when (funcall fn (if key (funcall key v) v))
 729                         (return-from find-vertex-if v))))
 730   (values nil))
 731
 732 ;;; ---------------------------------------------------------------------------
 733
 734 (defmethod find-vertex-if ((edge basic-edge) fn &key key)
 735   (iterate-vertexes edge
 736                     (lambda (v)
 737                       (when (funcall fn (if key (funcall key v) v))
 738                         (return-from find-vertex-if v))))
 739   (values nil))
 740
 741 ;;; ---------------------------------------------------------------------------
 742
 743 (defmethod find-edge-if ((graph basic-graph) fn &key key)
 744   (iterate-edges graph
 745                  (lambda (e)
 746                    (when (funcall fn (if key (funcall key e) e))
 747                      (return-from find-edge-if e))))
 748   (values nil))
 749
 750 ;;; ---------------------------------------------------------------------------
 751
 752 (defmethod find-edges-if ((graph basic-graph) fn)
 753   (collect-using 'iterate-edges fn graph))
 754
 755 ;;; ---------------------------------------------------------------------------
 756
 757 (defmethod find-vertexes-if ((graph basic-graph) fn)
 758   (collect-using 'iterate-vertexes fn graph))
 759
 760 ;;; ---------------------------------------------------------------------------
 761
 762 (defmethod empty! ((graph basic-graph))
 763   (empty! (graph-edges graph))
 764   (empty! (graph-vertexes graph))
 765   (renumber-edges graph)
 766   (renumber-vertexes graph)
 767   (values))
 768
 769 ;;; ---------------------------------------------------------------------------
 770
 771 (defun neighbors-to-children (new-graph root &optional visited-list)
 772   (pushnew root visited-list)
 773   (iterate-neighbors
 774    root
 775    (lambda (c)
 776      (when (not (member c visited-list))
 777        (add-edge-between-vertexes
 778         new-graph (value root) (value c) :edge-type :directed)
 779        (neighbors-to-children new-graph c visited-list)))))
 780
 781 ;;; ---------------------------------------------------------------------------
 782
 783 (defmethod generate-directed-free-tree ((graph basic-graph) root)
 784   (generate-directed-free-tree graph (find-vertex graph root)))
 785
 786 ;;; ---------------------------------------------------------------------------
 787
 788 (defmethod force-undirected ((graph basic-graph))
 789   (iterate-edges
 790    graph
 791    (lambda (edge)
 792      (change-class edge (undirected-edge-class graph)))))
 793
 794
 795
 796 ;;; ---------------------------------------------------------------------------
 797 ;;; traversal
 798 ;;; ---------------------------------------------------------------------------
 799
 800 (defmethod traverse-elements ((thing basic-graph) (style symbol) fn)
 801   (let ((marker (gensym)))
 802     (iterate-vertexes
 803      thing
 804      (lambda (vertex)
 805        (setf (tag vertex) marker)))
 806
 807     (iterate-elements
 808      (graph-roots thing)
 809      (lambda (vertex)
 810        (traverse-elements-helper vertex style marker fn)))))
 811
 812 ;;; ---------------------------------------------------------------------------
 813
 814 (defmethod traverse-elements-helper ((thing basic-vertex) (style (eql :depth)) marker fn)
 815   (when (eq (tag thing) marker)
 816     (nilf (tag thing))
 817     (iterate-children
 818      thing
 819      (lambda (vertex)
 820        (traverse-elements-helper vertex style marker fn)))
 821
 822     (funcall fn thing)))
 823
 824 ;;; ---------------------------------------------------------------------------
 825
 826 (defmethod traverse-elements-helper ((thing basic-vertex) (style (eql :breadth)) marker fn)
 827   (when (eq (tag thing) marker)
 828     (nilf (tag thing))
 829     (funcall fn thing))
 830
 831   (iterate-neighbors
 832    thing
 833    (lambda (vertex)
 834      (when (eq (tag vertex) marker)
 835        (funcall fn vertex))))
 836
 837   (iterate-neighbors
 838    thing
 839    (lambda (vertex)
 840      (when (eq (tag vertex) marker)
 841        (nilf (tag vertex))
 842        (traverse-elements-helper vertex style marker fn)))))
 843
 844 ;;; ---------------------------------------------------------------------------
 845
 846 (defmethod in-cycle-p ((graph basic-graph) (start-vertex basic-vertex))
 847   (let ((first-time? t))
 848     (not (null
 849           (graph-search
 850            (list start-vertex)
 851            (lambda (v)
 852              (if first-time?
 853                (nilf first-time?)
 854                (eq (find-vertex graph v) start-vertex)))
 855            (lambda (v)
 856              (child-vertexes v))
 857            #'append
 858            :new-state-fn
 859            (lambda (states successors state= old-states)
 860              ;; Generate successor states that have not been seen before but
 861              ;; don't remove the start state.
 862              (remove-if
 863               #'(lambda (state)
 864                   (and (not (eq start-vertex state))
 865                        (or (member state states :test state=)
 866                            (member state old-states :test state=))))
 867               (funcall successors (first states)))))))))
 868
 869 ;;; ---------------------------------------------------------------------------
 870
 871 (defmethod in-undirected-cycle-p
 872            ((graph basic-graph) (current basic-vertex)
 873             &optional (marked (make-container 'simple-associative-container))
 874             (previous nil))
 875   (block do-it
 876     (tf (item-at-1 marked current))
 877     (iterate-children current
 878                       (lambda (child)
 879                         (cond
 880                          ((eq child previous) nil)
 881                          ((item-at-1 marked child) (return-from do-it t))
 882                          (t
 883                           (in-undirected-cycle-p graph child marked current)))))))
 884
 885 ;;; ---------------------------------------------------------------------------
 886
 887 (defmethod any-undirected-cycle-p ((graph basic-graph))
 888   (let ((marked (make-container 'simple-associative-container)))
 889     (iterate-vertexes graph (lambda (v)
 890                               (unless (item-at-1 marked v)
 891                                 (when (in-undirected-cycle-p graph v marked)
 892                                   (return-from any-undirected-cycle-p v)))))
 893     (values nil)))
 894
 895 ;;; ---------------------------------------------------------------------------
 896
 897 (defun remove-list (original target)
 898   "Removes all elements in original from target."
 899   (remove-if (lambda (target-element)
 900                (member target-element original))
 901              target))
 902
 903 ;;; ---------------------------------------------------------------------------
 904
 905 (defun get-nodelist-relatives (node-list)
 906   "Collects set of unique relatives of nodes in node-list."
 907   (let ((unique-relatives nil))
 908     (dolist (node node-list)
 909       (setf unique-relatives
 910             (append-unique (neighbor-vertexes node) unique-relatives)))
 911     unique-relatives))
 912
 913 ;;; ---------------------------------------------------------------------------
 914
 915 (defun get-transitive-closure (vertex-list &optional (depth nil))
 916   "Given a list of vertices, returns a combined list of all of the nodes
 917 in the transitive closure(s) of each of the vertices in the list
 918 (without duplicates).  Optional DEPTH limits the depth (in _both_ the
 919 child and parent directions) to which the closure is gathered; default
 920 nil gathers the entire closure(s)."
 921   (labels ((collect-transitive-closure (remaining visited depth)
 922              (if (and remaining
 923                       (typecase depth
 924                         (null t)
 925                         (fixnum (>= (decf depth) 0))))
 926
 927               (let* ((non-visited-relatives     ;; list of relatives not yet visited
 928                        (remove-list visited
 929                                     (get-nodelist-relatives remaining)))
 930                       (visited-nodes            ;; list of nodes visited so far
 931                        (append-unique non-visited-relatives visited)))
 932                  (collect-transitive-closure non-visited-relatives
 933                                              visited-nodes
 934                                              depth))
 935                (values visited))))
 936     (collect-transitive-closure vertex-list vertex-list depth)))
 937
 938 ;;; ---------------------------------------------------------------------------
 939 ;;; make-filtered-graph
 940 ;;; ---------------------------------------------------------------------------
 941
 942 (defmethod complete-links ((new-graph basic-graph)
 943                            (old-graph basic-graph))
 944   ;; Copy links from old-graph ONLY for nodes already in new-graph
 945   (iterate-vertexes
 946    new-graph
 947    (lambda (vertex)
 948      (let ((old-graph-vertex (find-vertex old-graph (value vertex))))
 949        (iterate-edges
 950         old-graph-vertex
 951         (lambda (old-edge)
 952           (let* ((old-other-vertex (other-vertex old-edge old-graph-vertex))
 953                  (new-other-vertex (find-vertex new-graph (value old-other-vertex) nil)))
 954             (when (and new-other-vertex
 955                        (< (vertex-id vertex) (vertex-id new-other-vertex)))
 956               (let* ((new-edge (copy-template old-edge)))
 957                 (if (eq old-graph-vertex (vertex-1 old-edge))
 958                   (setf (slot-value new-edge 'vertex-1) vertex
 959                         (slot-value new-edge 'vertex-2) new-other-vertex)
 960                   (setf (slot-value new-edge 'vertex-2) vertex
 961                         (slot-value new-edge 'vertex-1) new-other-vertex))
 962                 (add-edge new-graph new-edge))))))))))
 963
 964 #+Old
 965 (defmethod complete-links ((new-graph basic-graph)
 966                            (old-graph basic-graph))
 967   ;; Copy links from old-graph ONLY for nodes already in new-graph
 968   (iterate-vertexes
 969    new-graph
 970    (lambda (vertex)
 971      (let ((old-graph-vertex (find-vertex old-graph (value vertex))))
 972        (iterate-edges
 973         old-graph-vertex
 974         (lambda (edge)
 975           (let* ((old-other-vertex (other-vertex edge old-graph-vertex))
 976                  (new-other-vertex (find-vertex new-graph (value old-other-vertex) nil))
 977                  (edge-type (if (directed-edge-p edge)
 978                               :directed :undirected)))
 979             (when new-other-vertex
 980               (if (and (directed-edge-p edge)
 981                        (eq old-graph-vertex (target-vertex edge)))
 982                 (add-edge-between-vertexes new-graph new-other-vertex vertex
 983                                            :value (value edge)
 984                                            :edge-type edge-type)
 985                 (add-edge-between-vertexes new-graph vertex new-other-vertex
 986                                            :value (value edge)
 987                                            :edge-type edge-type))))))))))
 988
 989 ;;; ---------------------------------------------------------------------------
 990
 991 (defmethod make-filtered-graph ((old-graph basic-graph)
 992                                 test-fn
 993                                 &key
 994                                 (graph-completion-method nil)
 995                                 (depth nil)
 996                                 (new-graph
 997                                  (copy-template old-graph)))
 998   (ecase graph-completion-method
 999     ((nil
1000       :complete-links)
1001      (iterate-vertexes old-graph
1002                        (lambda (vertex)
1003                          (when (funcall test-fn vertex)
1004                            (add-vertex new-graph (value vertex))))))
1005     ((:complete-closure-nodes-only
1006       :complete-closure-with-links)
1007      (let* ((old-graph-vertexes  (collect-items old-graph :filter test-fn))
1008             (closure-vertexes
1009              (get-transitive-closure old-graph-vertexes depth)))
1010        (dolist (vertex closure-vertexes)
1011          (add-vertex new-graph (copy-template vertex))))))
1012   (ecase graph-completion-method
1013       ((nil :complete-closure-nodes-only) nil)
1014       ((:complete-links
1015         :complete-closure-with-links)
1016        (complete-links new-graph old-graph)))
1017   new-graph)
1018
1019 ;;; ---------------------------------------------------------------------------
1020
1021 (defmethod subgraph-containing ((graph basic-graph) (vertex basic-vertex)
1022                                 &rest args &key (depth nil) (new-graph nil))
1023   (declare (ignore depth new-graph))
1024   (apply #'make-filtered-graph
1025          graph
1026          #'(lambda (v)
1027              (equal v vertex))
1028          :graph-completion-method :complete-closure-with-links
1029          args))
1030
1031 ;;; ---------------------------------------------------------------------------
1032
1033 (defmethod edge-count ((graph basic-graph))
1034   (count-using #'iterate-edges nil graph))
1035
1036 ;;; ---------------------------------------------------------------------------
1037
1038 (defmethod edge-count ((vertex basic-vertex))
1039   (size (vertex-edges vertex)))
1040
1041 ;;; ---------------------------------------------------------------------------
1042
1043 (defmethod topological-sort ((graph basic-graph))
1044   (assign-level graph 0)
1045   (sort (collect-elements (graph-vertexes graph))  #'<
1046         :key (lambda (x) (depth-level x))))
1047
1048 ;;; ---------------------------------------------------------------------------
1049
1050 (defmethod assign-level ((graph basic-graph) (level number))
1051   (loop for node in (graph-roots graph)
1052         do (assign-level node 0)))
1053
1054 ;;; ---------------------------------------------------------------------------
1055
1056 (defmethod assign-level ((node basic-vertex) (level number))
1057   (if (or (not (depth-level node))
1058           (> level (depth-level node)))
1059     (setf (depth-level node) level))
1060   (iterate-children node (lambda (x) (assign-level x (1+ level)))))
1061
1062 ;;; ---------------------------------------------------------------------------
1063
1064 (defmethod depth ((graph basic-graph))
1065   (assign-level graph 0)
1066   (let ((depth 0))
1067     (iterate-vertexes graph (lambda (vertex)
1068                               (maxf depth (depth-level vertex))))
1069     depth))
1070
1071 ;;; ---------------------------------------------------------------------------
1072 ;;; mapping
1073 ;;; ---------------------------------------------------------------------------
1074
1075 (defun map-paths (graph start-vertex length fn &key (filter (constantly t)))
1076   "Apply fn to each path that starts at start-vertex and is of exactly length
1077 length"
1078   ;; a sort of depth first search
1079   (labels ((follow-path (next-vertex current-path length)
1080              (when (zerop length)
1081                (funcall fn (reverse current-path)))
1082              ; (format t "~%~A ~A ~A" current-path next-vertex length)
1083              (when (plusp length)
1084                (iterate-neighbors
1085                 next-vertex
1086                 (lambda (v)
1087                   (when (funcall filter v)
1088                     ;; no repeats
1089                     (unless (find-item current-path v)
1090                       (let ((new-path  (copy-list current-path)))
1091                         (follow-path v (push v new-path) (1- length))))))))))
1092     (iterate-neighbors
1093      start-vertex
1094      (lambda (v)
1095        (when (funcall filter v)
1096          (follow-path v (list v start-vertex) (1- length))))))
1097   (values graph))
1098
1099 ;;; ---------------------------------------------------------------------------
1100
1101 (defun map-shortest-paths (graph start-vertex depth fn &key (filter (constantly t)))
1102   "Apply fn to each shortest path starting at `start-vertex` of depth `depth`. The `filter` predicate is used to remove vertexes from consideration."
1103   (bind ((visited (make-container 'simple-associative-container
1104                                   :test #'equal)))
1105     (labels ((visit (p)
1106                (setf (item-at-1 visited p) t))
1107              (visited-p (p)
1108                (item-at-1 visited p))
1109              )
1110       (loop for n from 1 to (1- depth) do
1111             (map-paths graph start-vertex n
1112                        (lambda (p)
1113                          (visit (first (last p))))
1114                        :filter filter))
1115       ;(break)
1116       (visit start-vertex)
1117       (map-paths graph start-vertex depth
1118                  (lambda (p)
1119                    (unless (visited-p (first (last p)))
1120                      (funcall fn p)))
1121                  :filter filter))))
1122
1123
1124 ;;; ---------------------------------------------------------------------------
1125 ;;; utilities
1126 ;;; ---------------------------------------------------------------------------
1127
1128 (defun append-unique (list1 list2)
1129   (remove-duplicates (append list1 list2)))
1130
1131 ;;; ---------------------------------------------------------------------------
1132 ;;; project-bipartite-graph
1133 ;;; ---------------------------------------------------------------------------
1134
1135 (defmethod project-bipartite-graph
1136            ((new-graph symbol) graph vertex-class vertex-classifier)
1137   (project-bipartite-graph
1138    (make-instance new-graph) graph vertex-class  vertex-classifier))
1139
1140 ;;; ---------------------------------------------------------------------------
1141
1142 (defmethod project-bipartite-graph
1143            ((new-graph basic-graph) graph vertex-class vertex-classifier)
1144   (iterate-vertexes
1145    graph
1146    (lambda (v)
1147      (when (eq (funcall vertex-classifier v) vertex-class)
1148        (add-vertex new-graph (element v)))))
1149
1150   (iterate-vertexes
1151    graph
1152    (lambda (v)
1153      (when (eq (funcall vertex-classifier v) vertex-class)
1154        (iterate-neighbors
1155         v
1156         (lambda (other-class-vertex)
1157           (iterate-neighbors
1158            other-class-vertex
1159            (lambda (this-class-vertex)
1160              (when (< (vertex-id v) (vertex-id this-class-vertex))
1161                (add-edge-between-vertexes
1162                 new-graph (element v) (element this-class-vertex)
1163                 :if-duplicate-do (lambda (e) (incf (weight e))))))))))))
1164
1165   new-graph)
1166
1167 #+Test
1168 (pro:with-profiling
1169   (setf (ds :g-5000-m-projection)
1170         (project-bipartite-graph
1171          'undirected-graph-container
1172          (ds :g-5000)
1173          :m
1174          (lambda (v)
1175            (let ((vertex-class (aref (symbol-name (element v)) 0)))
1176              (cond ((member vertex-class '(#\a #\b) :test #'char-equal)
1177                     :m)
1178                    ((member vertex-class '(#\x #\y #\z) :test #'char-equal)
1179                     :h)))))))
1180
1181 #+Test
1182 (pro:with-profiling
1183   (setf (ds :g-5000-h-projection)
1184         (project-bipartite-graph
1185          'undirected-graph-container
1186          (ds :g-5000)
1187          :h
1188          (lambda (v)
1189            (let ((vertex-class (aref (symbol-name (element v)) 0)))
1190              (cond ((member vertex-class '(#\a #\b) :test #'char-equal)
1191                     :m)
1192                    ((member vertex-class '(#\x #\y #\z) :test #'char-equal)
1193                     :h)))))))
1194
1195 #+Test
1196 (pro:with-profiling
1197   (project-bipartite-graph
1198    'undirected-graph-container
1199    (ds :g-1000)
1200    :m
1201    (lambda (v)
1202      (let ((vertex-class (aref (symbol-name (element v)) 0)))
1203        (cond ((member vertex-class '(#\x #\y) :test #'char-equal)
1204               :m)
1205              ((member vertex-class '(#\a #\b #\c) :test #'char-equal)
1206               :h))))))
1207
1208
1209
1210