3.1.1 cl-graph/cl-graph.asd

Source

cl-graph.asd.

Parent Component

cl-graph (system).

ASDF Systems

cl-graph.

---

3.1.2 cl-graph/dev/package.lisp

Source

cl-graph.asd.

Parent Component

dev (module).

Packages

cl-graph.

---

3.1.3 cl-graph/dev/api.lisp

Dependency

package.lisp (file).

Source

cl-graph.asd.

Parent Component

dev (module).

Public Interface

• add-edge (generic function).
• add-edge-between-vertexes (generic function).
• add-vertex (generic function).
• adjacentp (generic function).
• any-undirected-cycle-p (generic function).
• assortativity-coefficient (generic function).
• child-vertexes (generic function).
• connected-component-count (generic function).
• connected-components (generic function).
• connected-graph-p (generic function).
• delete-all-edges (generic function).
• delete-edge (generic function).
• delete-edge-between-vertexes (generic function).
• delete-vertex (generic function).
• depth (generic function).
• dfs (generic function).
• dfs-back-edge-p (generic function).
• dfs-edge-type (generic function).
• dfs-tree-edge-p (generic function).
• directed-edge-p (generic function).
• dot-attribute-value (generic function).
• (setf dot-attribute-value) (generic function).
• edge->dot (generic function).
• edge-count (generic function).
• edge-lessp-by-direction (generic function).
• edge-lessp-by-weight (generic function).
• edges (generic function).
• find-connected-components (generic function).
• find-edge (generic function).
• find-edge-between-vertexes (generic function).
• find-edge-between-vertexes-if (generic function).
• find-edge-if (generic function).
• find-edges-if (generic function).
• find-vertex (generic function).
• find-vertex-if (generic function).
• find-vertexes-if (generic function).
• force-undirected (generic function).
• generate-directed-free-tree (generic function).
• graph->dot (generic function).
• graph->dot-external (generic function).
• graph->dot-properties (generic function).
• graph-edge-mixture-matrix (generic function).
• graph-mixing-matrix (generic function).
• graph-roots (generic function).
• has-children-p (generic function).
• has-parent-p (generic function).
• in-cycle-p (generic function).
• in-undirected-cycle-p (generic function).
• iterate-edges (generic function).
• iterate-neighbors (generic function).
• iterate-parents (generic function).
• iterate-source-edges (generic function).
• iterate-target-edges (generic function).
• iterate-vertexes (generic function).
• make-filtered-graph (generic function).
• make-graph (generic function).
• make-graph-from-vertexes (generic function).
• make-vertex-edges-container (generic function).
• make-vertex-for-graph (generic function).
• minimum-spanning-tree (generic function).
• neighbor-vertexes (generic function).
• number-of-neighbors (generic function).
• other-vertex (generic function).
• out-edge-for-vertex-p (generic function).
• parent-vertexes (generic function).
• project-bipartite-graph (generic function).
• renumber-edges (generic function).
• renumber-vertexes (generic function).
• replace-vertex (generic function).
• rootp (generic function).
• search-for-vertex (generic function).
• source-edge-count (generic function).
• source-edges (generic function).
• source-vertex (generic function).
• subgraph-containing (generic function).
• tag-all-edges (generic function).
• tagged-edge-p (generic function).
• target-edge-count (generic function).
• target-edges (generic function).
• target-vertex (generic function).
• topological-sort (generic function).
• undirected-edge-p (generic function).
• untag-all-edges (generic function).
• untagged-edge-p (generic function).
• vertex->dot (generic function).
• vertex-count (generic function).
• vertexes (generic function).
• vertices-share-edge-p (generic function).

Internals

• add-edge-to-vertex (generic function).
• add-edges-to-graph (generic function).
• assign-level (generic function).
• breadth-first-search-graph (generic function).
• breadth-first-visitor (generic function).
• complete-links (generic function).
• dfs-cross-edge-p (generic function).
• dfs-forward-edge-p (generic function).
• dfs-visit (generic function).
• ensure-valid-dot-attribute (generic function).
• generate-assortative-graph-with-degree-distributions (generic function).
• generate-gnm (generic function).
• generate-gnp (generic function).
• generate-preferential-attachment-graph (generic function).
• generate-scale-free-graph (generic function).
• generate-simple-preferential-attachment-graph (generic function).
• generate-undirected-graph-via-assortativity-matrix (generic function).
• generate-undirected-graph-via-vertex-probabilities (generic function).
• initialize-vertex-data (generic function).
• make-edge-container (generic function).
• make-edge-for-graph (generic function).
• make-vertex-container (generic function).
• map-over-all-combinations-of-k-edges (generic function).
• map-over-all-combinations-of-k-vertexes (generic function).
• mst-find-set (generic function).
• mst-link (generic function).
• mst-make-set (generic function).
• mst-tree-union (generic function).
• tag-edges (generic function).
• traverse-elements (generic function).
• traverse-elements-helper (generic function).
• untag-edges (generic function).
• write-name-for-dot (generic function).

---

3.1.4 cl-graph/dev/macros.lisp

Dependency

package.lisp (file).

Source

cl-graph.asd.

Parent Component

dev (module).

Public Interface

with-changing-vertex (macro).

---

3.1.5 cl-graph/dev/graph.lisp

Dependencies

• api.lisp (file).
• macros.lisp (file).

Source

cl-graph.asd.

Parent Component

dev (module).

Public Interface

• add-edge (method).
• add-edge-between-vertexes (method).
• add-edge-between-vertexes (method).
• add-vertex (method).
• add-vertex (method).
• add-vertex (method).
• adjacentp (method).
• adjacentp (method).
• any-undirected-cycle-p (method).
• basic-edge (class).
• basic-graph (class).
• basic-vertex (class).
• child-vertexes (method).
• color (reader method).
• color (reader method).
• (setf color) (writer method).
• (setf color) (writer method).
• container->list (method).
• contains-directed-edge-p (reader method).
• (setf contains-directed-edge-p) (writer method).
• contains-undirected-edge-p (reader method).
• (setf contains-undirected-edge-p) (writer method).
• default-edge-class (reader method).
• default-edge-type (reader method).
• delete-all-edges (method).
• delete-edge (method).
• delete-edge-between-vertexes (method).
• delete-vertex (method).
• delete-vertex (method).
• delete-vertex (method).
• depth (method).
• depth-level (reader method).
• (setf depth-level) (writer method).
• directed-edge-class (reader method).
• directed-edge-mixin (class).
• directed-edge-p (method).
• discovery-time (reader method).
• (setf discovery-time) (writer method).
• edge (reader method).
• edge-count (method).
• edge-count (method).
• edge-error (condition).
• edge-id (reader method).
• (setf edge-id) (writer method).
• edges (method).
• edges (method).
• (setf element) (writer method).
• element (reader method).
• (setf element) (writer method).
• (setf element) (method).
• element (reader method).
• empty! (method).
• find-edge-between-vertexes (method).
• find-edge-if (method).
• find-edges-if (method).
• find-vertex (method).
• find-vertex (method).
• find-vertex (method).
• find-vertex-if (method).
• find-vertex-if (method).
• find-vertexes-if (method).
• finish-time (reader method).
• (setf finish-time) (writer method).
• force-undirected (method).
• generate-directed-free-tree (method).
• get-transitive-closure (function).
• graph (reader method).
• graph (reader method).
• graph (reader method).
• (setf graph) (writer method).
• graph-edge-not-found-error (condition).
• graph-edges (reader method).
• graph-error (condition).
• graph-roots (method).
• graph-vertex-not-found-error (condition).
• graph-vertex-not-found-in-edge-error (condition).
• graph-vertexes (reader method).
• in-cycle-p (method).
• in-cycle-p (method).
• in-undirected-cycle-p (method).
• initialize-instance (method).
• initialize-instance (method).
• initialize-instance (method).
• insert-item (method).
• iterate-elements (method).
• iterate-nodes (method).
• iterate-vertexes (method).
• iterate-vertexes (method).
• make-graph (method).
• make-load-form (method).
• make-load-form (method).
• make-load-form (method).
• make-vertex-for-graph (method).
• map-paths (function).
• map-shortest-paths (function).
• neighbor-vertexes (method).
• next-node (reader method).
• (setf next-node) (writer method).
• number-of-neighbors (method).
• parent-vertexes (method).
• previous-node (reader method).
• (setf previous-node) (writer method).
• print-object (method).
• print-object (method).
• print-object (method).
• project-bipartite-graph (method).
• project-bipartite-graph (method).
• rank (reader method).
• (setf rank) (writer method).
• renumber-edges (method).
• renumber-vertexes (method).
• replace-vertex (method).
• rootp (method).
• search-for-vertex (method).
• search-for-vertex (method).
• size (method).
• source-edge-count (method).
• source-edges (method).
• (setf tag) (writer method).
• tag (reader method).
• (setf tag) (writer method).
• tag (reader method).
• tag-all-edges (method).
• tag-all-edges (method).
• tagged-edge-p (method).
• target-edge-count (method).
• target-edges (method).
• topological-sort (method).
• undirected-edge-class (reader method).
• undirected-edge-mixin (class).
• undirected-edge-p (method).
• untag-all-edges (method).
• untag-all-edges (method).
• untagged-edge-p (method).
• vertex (reader method).
• vertex (reader method).
• vertex-1 (reader method).
• vertex-2 (reader method).
• vertex-class (reader method).
• vertex-count (compiler macro).
• vertex-count (method).
• vertex-id (reader method).
• vertexes (method).
• (setf weight) (writer method).
• weight (reader method).
• weight (method).
• weighted-edge-mixin (class).

Internals

• add-edge-to-vertex (method).
• append-unique (function).
• assign-level (method).
• assign-level (method).
• edge-key (reader method).
• edge-test (reader method).
• get-nodelist-relatives (function).
• graph-search-for-cl-graph (function).
• largest-edge-id (reader method).
• largest-vertex-id (reader method).
• make-edge-for-graph (method).
• neighbors-to-children (function).
• remove-list (function).
• tag-edges (method).
• traverse-elements (method).
• traverse-elements-helper (method).
• traverse-elements-helper (method).
• untag-edges (method).
• value (reader method).
• value (reader method).
• (setf value) (writer method).
• (setf value) (writer method).
• vertex-key (reader method).
• vertex-test (reader method).

---

3.1.6 cl-graph/dev/graph-container.lisp

Dependency

graph.lisp (file).

Source

cl-graph.asd.

Parent Component

dev (module).

Public Interface

• add-edge (method).
• delete-all-edges (method).
• delete-edge (method).
• edge-count (method).
• empty! (method).
• find-edge (method).
• find-edge-between-vertexes (method).
• find-edge-between-vertexes-if (method).
• find-edge-between-vertexes-if (method).
• graph-container (class).
• graph-container-directed-edge (class).
• graph-container-edge (class).
• graph-container-undirected-edge (class).
• graph-container-vertex (class).
• has-children-p (method).
• has-parent-p (method).
• initialize-instance (method).
• initialize-instance (method).
• iterate-children (method).
• iterate-edges (method).
• iterate-edges (method).
• iterate-neighbors (method).
• iterate-parents (method).
• iterate-source-edges (method).
• iterate-target-edges (method).
• make-node-for-container (method).
• make-vertex-edges-container (method).
• other-vertex (method).
• other-vertex (method).
• print-object (method).
• replace-vertex (method).
• replace-vertex (method).
• source-vertex (method).
• target-vertex (method).
• vertex-1 (reader method).
• vertex-2 (reader method).
• vertexes (method).
• vertices-share-edge-p (method).
• weighted-directed-edge (class).
• weighted-edge (class).
• weighted-undirected-edge (class).

Internals

• add-edge-to-vertex (method).
• associate-edge-with-pair (method).
• associate-edge-with-pair (method).
• dissoc-val-from-key-or-delete (function).
• dissociate-edge-from-pair (method).
• dissociate-edge-from-pair (method).
• make-edge-container (method).
• make-vertex-container (method).
• vertex-edges (reader method).
• vertex-pair->edge (reader method).

---

3.1.7 cl-graph/dev/graph-matrix.lisp

Dependency

graph.lisp (file).

Source

cl-graph.asd.

Parent Component

dev (module).

Public Interface

• graph-matrix (class).
• graph-matrix-edge (class).
• graph-matrix-vertex (class).
• initialize-instance (method).

Internals

• adjencency-matrix (reader method).
• make-edge-container (method).
• make-vertex-container (method).

---

3.1.8 cl-graph/dev/graph-algorithms.lisp

Dependency

graph.lisp (file).

Source

cl-graph.asd.

Parent Component

dev (module).

Public Interface

• connected-component-count (method).
• connected-components (method).
• connected-graph-p (method).
• dfs (method).
• dfs (method).
• dfs-back-edge-p (method).
• dfs-edge-type (method).
• dfs-tree-edge-p (method).
• edge-lessp-by-direction (method).
• edge-lessp-by-weight (method).
• find-connected-components (method).
• minimum-spanning-tree (method).
• out-edge-for-vertex-p (method).
• rooted-dfs (generic function).

Internals

• *depth-first-search-timer* (special variable).
• add-edges-to-graph (method).
• breadth-first-search-graph (method).
• breadth-first-search-graph (method).
• breadth-first-visitor (method).
• breadth-first-visitor (method).
• dfs-cross-edge-p (method).
• dfs-forward-edge-p (method).
• dfs-visit (method).
• initialize-vertex-data (method).
• make-vertex-datum (function).
• map-over-all-combinations-of-k-edges (method).
• map-over-all-combinations-of-k-edges (method).
• map-over-all-combinations-of-k-vertexes (method).
• mst-find-set (method).
• mst-link (method).
• mst-make-set (method).
• mst-tree-union (method).
• node-color (function).
• (setf node-color) (function).
• node-depth (function).
• (setf node-depth) (function).
• node-parent (function).
• (setf node-parent) (function).

---

3.1.9 cl-graph/dev/graphviz/graphviz-support.lisp

Source

cl-graph.asd.

Parent Component

graphviz (module).

Public Interface

• *dot-graph-attributes* (special variable).
• dot-attribute-value (method).
• (setf dot-attribute-value) (method).
• (setf dot-attribute-value) (method).
• dot-attributes (reader method).
• (setf dot-attributes) (writer method).
• dot-attributes-mixin (class).
• dot-directed-edge (class).
• dot-edge (class).
• dot-edge-mixin (class).
• dot-graph (class).
• dot-graph-mixin (class).
• dot-vertex (class).
• dot-vertex-mixin (class).
• edge->dot (method).
• edge->dot (method).
• graph->dot (method).
• graph->dot (method).
• graph->dot (method).
• graph->dot (method).
• graph->dot (method).
• graph->dot-external (method).
• graph->dot-properties (method).
• graph->dot-properties (method).
• height-in-pixels (method).
• (setf height-in-pixels) (method).
• print-dot-key-value (function).
• vertex->dot (method).
• vertex->dot (method).
• width-in-pixels (method).
• (setf width-in-pixels) (method).

Internals

• *dot-edge-attributes* (special variable).
• *dot-path* (special variable).
• *dot-vertex-attributes* (special variable).
• defpixel-inch-accessors (macro).
• ensure-valid-dot-attribute (method).
• ensure-valid-dot-attribute (method).
• ensure-valid-dot-attribute (method).
• format-dot-attributes (function).
• textify (function).
• write-name-for-dot (method).
• write-name-for-dot (method).

---

3.2.1 cl-graph/COPYING

Source

cl-graph.asd.

Parent Component

cl-graph (system).

---

3.2.2 cl-graph/dev/notes.text

Source

cl-graph.asd.

Parent Component

dev (module).

---

3.2.3 cl-graph/website/source/index.mmd

Source

cl-graph.asd.

Parent Component

source (module).

---

5.1.1 Special variables

Special Variable: *dot-graph-attributes* ¶

Package

cl-graph.

Source

graphviz-support.lisp.

---

5.1.2 Macros

Macro: with-changing-vertex ((vertex) &body body) ¶

This is used to maintain consistency when changing the value of vertex elements while iterating over the vertexes...

Package

cl-graph.

Source

macros.lisp.

---

5.1.3 Compiler macros

Compiler Macro: vertex-count (&rest args) ¶

Package

cl-graph.

Source

graph.lisp.

---

5.1.4 Ordinary functions

Function: get-transitive-closure (vertex-list &optional depth) ¶

Given a list of vertices, returns a combined list of all of the nodes in the transitive closure(s) of each of the vertices in the list (without duplicates). Optional DEPTH limits the depth (in _both_ the child and parent directions) to which the closure is gathered; default nil gathers the entire closure(s).

Package

cl-graph.

Source

graph.lisp.

Function: map-paths (graph start-vertex length fn &key filter) ¶

Apply fn to each path that starts at start-vertex and is of exactly length length

Package

cl-graph.

Source

graph.lisp.

Function: map-shortest-paths (graph start-vertex depth fn &key filter) ¶

Apply fn to each shortest path starting at ‘start-vertex‘ of depth ‘depth‘. The ‘filter‘ predicate is used to remove vertexes from consideration.

Package

cl-graph.

Source

graph.lisp.

Function: print-dot-key-value (key value dot-attributes stream) ¶

Package

cl-graph.

Source

graphviz-support.lisp.

---

5.1.5 Generic functions

Generic Function: add-edge (graph edge &rest args &key force-new?) ¶

Add-edge adds an existing edge to a graph. As add-edge-between-vertexes is generally more natural to use, this method is rarely called.

Package

cl-graph.

Source

api.lisp.

Methods

Method: add-edge ((graph graph-container) (edge graph-container-edge) &key force-new?) ¶

Source

graph-container.lisp.

Method: add-edge :before ((graph basic-graph) (edge basic-edge) &key force-new?) ¶

Source

graph.lisp.

Generic Function: add-edge-between-vertexes (graph value-or-vertex-1 value-or-vertex-2 &rest args &key if-duplicate-do edge-type value edge-class &allow-other-keys) ¶

Adds an edge between two vertexes and returns it.
If force-new? is true, the edge is added even if one already exists. If the vertexes are not found in the graph, they will be added (unless :error-if-not-found? is true). The class of the edge can be specified using :edge-class or :edge-type. If :edge-type is used, it can be either :directed or :undirected; the actual class of the edge will be determined by using the edge-types of the graph. If neither :edge-type nor :edge-class is specified, then a directed edge will be created.

If-duplicate-do is used when the ’same’ edge is added more than once. It can be either a function on one variable or :ignore
or :force. If it is :ignore, then the previously added edge is returned; if it is :force, then another edge is added between the two vertexes; if it is a function, then this function will be called with the previous edge.

Package

cl-graph.

Source

api.lisp.

Methods

Method: add-edge-between-vertexes ((graph basic-graph) (v-1 basic-vertex) (v-2 basic-vertex) &rest args &key value if-duplicate-do edge-type edge-class &allow-other-keys) ¶

Source

graph.lisp.

Method: add-edge-between-vertexes ((graph basic-graph) value-1 value-2 &rest args &key if-duplicate-do &allow-other-keys) ¶

Source

graph.lisp.

Generic Function: add-vertex (graph value-or-vertex &key if-duplicate-do &allow-other-keys) ¶

Adds a vertex to a graph. If called with a vertex,
then this vertex is added. If called with a value, then a new vertex is created to hold the value. If-duplicate-do can be one
of :ignore, :force, :replace, :replace-value, :error, or a function. The default is :ignore.

Package

cl-graph.

Source

api.lisp.

Methods

Method: add-vertex :before ((graph basic-graph) (vertex basic-vertex) &key &allow-other-keys) ¶

Source

graph.lisp.

Method: add-vertex ((graph basic-graph) value &rest args &key if-duplicate-do &allow-other-keys) ¶

Source

graph.lisp.

Method: add-vertex ((graph basic-graph) (value basic-vertex) &key if-duplicate-do) ¶

Source

graph.lisp.

Generic Function: adjacentp (graph vertex-1 vertex-2) ¶

Return true if vertex-1 and vertex-2 are connected
by an edge. [?? compare with vertices-share-edge-p and remove one or maybe call one directed-adjacentp]

Package

cl-graph.

Source

api.lisp.

Methods

Method: adjacentp ((graph basic-graph) (vertex-1 basic-vertex) (vertex-2 basic-vertex)) ¶

Source

graph.lisp.

Method: adjacentp ((graph basic-graph) vertex-1 vertex-2) ¶

Source

graph.lisp.

Generic Function: any-undirected-cycle-p (graph) ¶

Returns true if there are any undirected cycles in ‘graph‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: any-undirected-cycle-p ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: assortativity-coefficient (mixing-matrix) ¶

An assortative graph is one where vertexes of the
same type are more likely to have edges between them. The (discrete) assortativity-coefficient measures how assortative a graph is based on its mixing matrix. The definition we use is from Mixing Patterns in Networks by Mark Newman. See the citation ’newman200-mixing’ in moab or the URL ’http://arxiv.org/abs/cond-mat/0209450’.

Package

cl-graph.

Source

api.lisp.

Generic Function: child-vertexes (vertex &optional filter) ¶

Returns a list of the vertexes to which ‘vertex‘ is
connected by an edge and for which ‘vertex‘ is the source vertex. If the connecting edge is undirected, then the vertex is always counted as a source. [?? Could be a defun].

Package

cl-graph.

Source

api.lisp.

Methods

Method: child-vertexes (vertex &optional filter) ¶

Source

graph.lisp.

Generic Reader: color (object) ¶

Generic Writer: (setf color) (object) ¶

Package

cl-graph.

Methods

Reader Method: color ((basic-edge basic-edge)) ¶

Writer Method: (setf color) ((basic-edge basic-edge)) ¶

The ‘color‘ is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]

Source

graph.lisp.

Target Slot

color.

Reader Method: color ((basic-vertex basic-vertex)) ¶

Writer Method: (setf color) ((basic-vertex basic-vertex)) ¶

The ‘color‘ slot is used by some algorithms for bookkeeping.

Source

graph.lisp.

Target Slot

color.

Generic Function: connected-component-count (graph) ¶

Returns the number of connected-components of graph.

Package

cl-graph.

Source

api.lisp.

Methods

Method: connected-component-count ((graph basic-graph)) ¶

Source

graph-algorithms.lisp.

Generic Function: connected-components (graph) ¶

Returns a union-find-container representing the connected-components of ‘graph‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: connected-components ((graph basic-graph)) ¶

Source

graph-algorithms.lisp.

Generic Function: connected-graph-p (graph &key edge-sorter) ¶

Returns true if graph is a connected graph and nil otherwise.

Package

cl-graph.

Source

api.lisp.

Methods

Method: connected-graph-p ((graph basic-graph) &key edge-sorter) ¶

Source

graph-algorithms.lisp.

Generic Reader: contains-directed-edge-p (object) ¶

Generic Writer: (setf contains-directed-edge-p) (object) ¶

Package

cl-graph.

Methods

Reader Method: contains-directed-edge-p ((basic-graph basic-graph)) ¶

Writer Method: (setf contains-directed-edge-p) ((basic-graph basic-graph)) ¶

Returns true if graph contains at least one directed edge. [?? Not sure if this is really kept up-to-date.]

Source

graph.lisp.

Target Slot

contains-directed-edge-p.

Generic Reader: contains-undirected-edge-p (object) ¶

Generic Writer: (setf contains-undirected-edge-p) (object) ¶

Package

cl-graph.

Methods

Reader Method: contains-undirected-edge-p ((basic-graph basic-graph)) ¶

Writer Method: (setf contains-undirected-edge-p) ((basic-graph basic-graph)) ¶

Returns true if graph contains at least one undirected edge. [?? Not sure if this is really kept up-to-date.]

Source

graph.lisp.

Target Slot

contains-undirected-edge-p.

Generic Reader: default-edge-class (object) ¶

Package

cl-graph.

Methods

Reader Method: default-edge-class ((basic-graph basic-graph)) ¶

The default edge class for the graph.

Source

graph.lisp.

Target Slot

default-edge-class.

Generic Reader: default-edge-type (object) ¶

Package

cl-graph.

Methods

Reader Method: default-edge-type ((basic-graph basic-graph)) ¶

The default edge type for the graph. This should be one of :undirected or :directed.

Source

graph.lisp.

Target Slot

default-edge-type.

Generic Function: delete-all-edges (graph) ¶

Delete all edges from ‘graph’. Returns the graph..

Package

cl-graph.

Source

api.lisp.

Methods

Method: delete-all-edges ((graph graph-container)) ¶

Source

graph-container.lisp.

Method: delete-all-edges :after ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: delete-edge (graph edge) ¶

Delete the ‘edge’ from the ‘graph’ and returns it.

Package

cl-graph.

Source

api.lisp.

Methods

Method: delete-edge ((graph graph-container) (edge graph-container-edge)) ¶

Source

graph-container.lisp.

Method: delete-edge :after ((graph basic-graph) (edge basic-edge)) ¶

Source

graph.lisp.

Generic Function: delete-edge-between-vertexes (graph value-or-vertex-1 value-or-vertex-2 &rest args) ¶

Finds an edge in the graph between the two
specified vertexes. If values (i.e., non-vertexes) are passed in, then the graph will be searched for matching vertexes.

Package

cl-graph.

Source

api.lisp.

Methods

Method: delete-edge-between-vertexes ((graph basic-graph) value-or-vertex-1 value-or-vertex-2 &rest args) ¶

Source

graph.lisp.

Generic Function: delete-vertex (graph value-or-vertex) ¶

Remove a vertex from a graph. The ’vertex-or-value’
argument can be a vertex of the graph or a ’value’ that will find a vertex via a call to find-vertex. A graph-vertex-not-found-error will be raised if the vertex is not found or is not part of the graph.

Package

cl-graph.

Source

api.lisp.

Methods

Method: delete-vertex :after ((graph basic-graph) (vertex basic-vertex)) ¶

Source

graph.lisp.

Method: delete-vertex ((graph basic-graph) (vertex basic-vertex)) ¶

Source

graph.lisp.

Method: delete-vertex ((graph basic-graph) value-or-vertex) ¶

Source

graph.lisp.

Generic Function: depth (graph) ¶

Returns the maximum depth of the vertexes in graph
assuming that the roots are of depth 0 and that each edge distance from the roots increments the depth by one.

Package

cl-graph.

Source

api.lisp.

Methods

Method: depth ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Reader: depth-level (object) ¶

Generic Writer: (setf depth-level) (object) ¶

Package

cl-graph.

Methods

Reader Method: depth-level ((basic-vertex basic-vertex)) ¶

Writer Method: (setf depth-level) ((basic-vertex basic-vertex)) ¶

‘Depth-level‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]

Source

graph.lisp.

Target Slot

depth-level.

Generic Function: dfs (graph root fn &key out-edge-sorter) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: dfs ((graph basic-graph) (root basic-vertex) fn &key out-edge-sorter) ¶

Source

graph-algorithms.lisp.

Method: dfs ((graph basic-graph) root fn &key out-edge-sorter) ¶

Source

graph-algorithms.lisp.

Generic Function: dfs-back-edge-p (edge) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: dfs-back-edge-p ((edge graph-container-edge)) ¶

Source

graph-algorithms.lisp.

Generic Function: dfs-edge-type (edge) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: dfs-edge-type ((edge graph-container-edge)) ¶

Source

graph-algorithms.lisp.

Generic Function: dfs-tree-edge-p (edge) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: dfs-tree-edge-p ((edge graph-container-edge)) ¶

Source

graph-algorithms.lisp.

Generic Reader: directed-edge-class (object) ¶

Package

cl-graph.

Methods

Reader Method: directed-edge-class ((basic-graph basic-graph)) ¶

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.

Source

graph.lisp.

Target Slot

directed-edge-class.

Generic Function: directed-edge-p (edge) ¶

Returns true if-and-only-if edge is directed

Package

cl-graph.

Source

api.lisp.

Methods

Method: directed-edge-p ((edge basic-edge)) ¶

Source

graph.lisp.

Generic Reader: discovery-time (object) ¶

Generic Writer: (setf discovery-time) (object) ¶

Package

cl-graph.

Methods

Reader Method: discovery-time ((basic-vertex basic-vertex)) ¶

Writer Method: (setf discovery-time) ((basic-vertex basic-vertex)) ¶

‘Discovery-time‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]

Source

graph.lisp.

Target Slot

discovery-time.

Generic Function: dot-attribute-value (attribute thing) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: dot-attribute-value ((attr symbol) (thing dot-attributes-mixin)) ¶

Source

graphviz-support.lisp.

Generic Function: (setf dot-attribute-value) (attribute thing) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: (setf dot-attribute-value) ((attr symbol) (thing dot-attributes-mixin)) ¶

Source

graphviz-support.lisp.

Method: (setf dot-attribute-value) :before ((attr symbol) (thing dot-attributes-mixin)) ¶

Source

graphviz-support.lisp.

Generic Reader: dot-attributes (object) ¶

Package

cl-graph.

Methods

Reader Method: dot-attributes ((dot-attributes-mixin dot-attributes-mixin)) ¶

automatically generated reader method

Source

graphviz-support.lisp.

Target Slot

dot-attributes.

Generic Writer: (setf dot-attributes) (object) ¶

Package

cl-graph.

Methods

Writer Method: (setf dot-attributes) ((dot-attributes-mixin dot-attributes-mixin)) ¶

automatically generated writer method

Source

graphviz-support.lisp.

Target Slot

dot-attributes.

Generic Reader: edge (condition) ¶

Package

cl-graph.

Methods

Reader Method: edge ((condition edge-error)) ¶

Source

graph.lisp.

Target Slot

edge.

Generic Function: edge->dot (edge stream) ¶

Used by graph->dot to output edge formatting for
‘edge‘ onto the ‘stream‘. The function can assume that openning and closing square brackets and label have already been taken care of.

Package

cl-graph.

Source

api.lisp.

Methods

Method: edge->dot ((edge dot-edge-mixin) stream) ¶

Source

graphviz-support.lisp.

Method: edge->dot ((v basic-edge) (stream stream)) ¶

Source

graphviz-support.lisp.

Generic Function: edge-count (vertex) ¶

Returns the number of edges attached to
‘vertex‘. Compare with the more flexible ‘vertex-degree‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: edge-count ((graph graph-container)) ¶

Source

graph-container.lisp.

Method: edge-count ((vertex basic-vertex)) ¶

Source

graph.lisp.

Method: edge-count ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Reader: edge-id (object) ¶

Generic Writer: (setf edge-id) (object) ¶

Package

cl-graph.

Methods

Reader Method: edge-id ((basic-edge basic-edge)) ¶

Writer Method: (setf edge-id) ((basic-edge basic-edge)) ¶

The ‘edge-id‘ is used internally by CL-Graph for bookkeeping.

Source

graph.lisp.

Target Slot

edge-id.

Generic Function: edge-lessp-by-direction (edge-1 edge-2) ¶

Returns true if and only if edge-1 is undirected and edge-2 is directed.

Package

cl-graph.

Source

api.lisp.

Methods

Method: edge-lessp-by-direction ((e1 basic-edge) (e2 basic-edge)) ¶

Source

graph-algorithms.lisp.

Generic Function: edge-lessp-by-weight (edge-1 edge-2) ¶

Returns true if the weight of edge-1 is strictly less than the weight of edge-2.

Package

cl-graph.

Source

api.lisp.

Methods

Method: edge-lessp-by-weight ((e1 basic-edge) (e2 basic-edge)) ¶

Source

graph-algorithms.lisp.

Generic Function: edges (thing) ¶

Returns a list of the edges of ‘thing‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: edges ((vertex basic-vertex)) ¶

Source

graph.lisp.

Method: edges ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: find-connected-components (graph) ¶

Returns a list of sub-graphs of ‘graph‘ where each
sub-graph is a different connected component of graph. Compare with connected-components and connected-component-count.

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-connected-components ((graph basic-graph)) ¶

Source

graph-algorithms.lisp.

Generic Function: find-edge (graph edge &optional error-if-not-found?) ¶

Search ‘graph‘ for an edge whose vertexes match
‘edge‘. This means that ‘vertex-1‘ of the edge in the graph must match ‘vertex-1‘ of ‘edge‘ and so forth. Wil signal an error of type ‘graph-edge-not-found-error‘ unless ‘error-if-not-found?‘ is nil. [?? Unused. Remove?]

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-edge ((graph graph-container) (edge graph-container-edge) &optional error-if-not-found?) ¶

Source

graph-container.lisp.

Generic Function: find-edge-between-vertexes (graph value-or-vertex-1 value-or-vertex-2 &key error-if-not-found?) ¶

Searches ‘graph‘ for an edge that connects vertex-1
and vertex-2. [?? Ignores error-if-not-found? Does directedness matter? need test]

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-edge-between-vertexes ((graph graph-container) (vertex-1 graph-container-vertex) (vertex-2 graph-container-vertex) &key error-if-not-found?) ¶

Source

graph-container.lisp.

Method: find-edge-between-vertexes ((graph basic-graph) value-1 value-2 &key error-if-not-found?) ¶

Source

graph.lisp.

Generic Function: find-edge-between-vertexes-if (graph value-or-vertex-1 value-or-vertex-2 fn &key error-if-not-found?) ¶

Finds and returns an edge between value-or-vertex-1
and value-or-vertex-2 which returns true (as a generalized boolean) when evaluated by ‘fn‘. Unless error-if-not-found? is nil, then a error will be signaled. [?? IS error really signaled? need a test.]

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-edge-between-vertexes-if ((graph graph-container) value-1 value-2 fn &key error-if-not-found?) ¶

Source

graph-container.lisp.

Method: find-edge-between-vertexes-if ((graph graph-container) (vertex-1 graph-container-vertex) (vertex-2 graph-container-vertex) fn &key error-if-not-found?) ¶

Source

graph-container.lisp.

Generic Function: find-edge-if (graph fn &key key) ¶

Returns the first edge in ‘thing‘ for which the
‘predicate‘ function returns non-nil. If the ‘key‘ is supplied, then it is applied to the edge before the predicate is.

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-edge-if ((graph basic-graph) fn &key key) ¶

Source

graph.lisp.

Generic Function: find-edges-if (thing predicate) ¶

Returns a list of edges in ‘thing‘ for which the ‘predicate‘ returns non-nil. [?? why no key function?]

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-edges-if ((graph basic-graph) fn) ¶

Source

graph.lisp.

Generic Function: find-vertex (graph value &optional error-if-not-found?) ¶

Search ’graph’ for a vertex with element
’value’. The search is fast but inflexible because it uses an associative-container. If you need more flexibity, see search-for-vertex.

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-vertex ((edge basic-edge) value &optional error-if-not-found?) ¶

Source

graph.lisp.

Method: find-vertex ((graph basic-graph) (vertex basic-vertex) &optional error-if-not-found?) ¶

Source

graph.lisp.

Method: find-vertex ((graph basic-graph) value &optional error-if-not-found?) ¶

Source

graph.lisp.

Generic Function: find-vertex-if (thing predicate &key key) ¶

Returns the first vertex in ‘thing‘ for which the
‘predicate‘ function returns non-nil. If the ‘key‘ is supplied, then it is applied to the vertex before the predicate is.

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-vertex-if ((edge basic-edge) fn &key key) ¶

Source

graph.lisp.

Method: find-vertex-if ((graph basic-graph) fn &key key) ¶

Source

graph.lisp.

Generic Function: find-vertexes-if (thing predicate) ¶

Returns a list of vertexes in ‘thing‘ for which the ‘predicate‘ returns non-nil. [?? why no key function?]

Package

cl-graph.

Source

api.lisp.

Methods

Method: find-vertexes-if ((graph basic-graph) fn) ¶

Source

graph.lisp.

Generic Reader: finish-time (object) ¶

Generic Writer: (setf finish-time) (object) ¶

Package

cl-graph.

Methods

Reader Method: finish-time ((basic-vertex basic-vertex)) ¶

Writer Method: (setf finish-time) ((basic-vertex basic-vertex)) ¶

‘Finish-time‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]

Source

graph.lisp.

Target Slot

finish-time.

Generic Function: force-undirected (graph) ¶

Ensures that the graph is undirected (possibly by calling change-class on the edges).

Package

cl-graph.

Source

api.lisp.

Methods

Method: force-undirected ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: generate-directed-free-tree (graph root) ¶

Returns a version of graph which is a directed free tree rooted at root.

Package

cl-graph.

Source

api.lisp.

Methods

Method: generate-directed-free-tree ((graph basic-graph) root) ¶

Source

graph.lisp.

Generic Reader: graph (object) ¶

Generic Writer: (setf graph) (object) ¶

Package

cl-graph.

Methods

Reader Method: graph ((basic-vertex basic-vertex)) ¶

Writer Method: (setf graph) ((basic-vertex basic-vertex)) ¶

The graph in which this vertex is contained.

Source

graph.lisp.

Target Slot

graph.

Reader Method: graph ((basic-edge basic-edge)) ¶

The ‘graph‘ of which this edge is a part.

Source

graph.lisp.

Target Slot

graph.

Reader Method: graph ((condition graph-error)) ¶

Source

graph.lisp.

Target Slot

graph.

Generic Function: graph->dot (graph output &key graph-formatter vertex-key vertex-labeler vertex-formatter edge-labeler edge-formatter &allow-other-keys) ¶

Generates a description of ‘graph‘ in DOT file format. The
formatting can be altered using ‘graph->dot-properties,‘ ‘vertex->dot,‘ and ‘edge->dot‘ as well as ‘edge-formatter,‘ ‘vertex-formatter,‘ ‘vertex-labeler,‘ and ‘edge-labeler‘. These can
be specified directly in the call to ‘graph->dot‘ or by creating subclasses of basic-graph, basic-vertex and basic-edge.

The output can be a stream or pathname or one of the values ‘nil‘ or
‘t‘. If output is ‘nil‘, then graph->dot returns a string containing
the DOT description. If it is ‘t‘, then the DOT description is written
to \*standard-output\*.

Here is an example;

(let ((g (make-container ’graph-container :default-edge-type :directed))) (loop for (a b) in ’((a b) (b c) (b d) (d e) (e f) (d f)) do (add-edge-between-vertexes g a b))
(graph->dot g nil))

"digraph G {
E []
C []
B []
A []
D []
F []
E->F []
B->C []
B->D []
A->B []
D->E []
D->F []
}"

For more information about DOT file format, search the web for ’DOTTY’ and ’GRAPHVIZ’.

Package

cl-graph.

Source

api.lisp.

Methods

Method: graph->dot ((g basic-graph) (stream pathname) &rest args &key &allow-other-keys) ¶

Source

graphviz-support.lisp.

Method: graph->dot ((g basic-graph) (stream string) &rest args &key &allow-other-keys) ¶

Source

graphviz-support.lisp.

Method: graph->dot ((g basic-graph) (stream (eql t)) &rest args &key &allow-other-keys) ¶

Source

graphviz-support.lisp.

Method: graph->dot ((g basic-graph) (stream (eql nil)) &rest args &key &allow-other-keys) ¶

Source

graphviz-support.lisp.

Method: graph->dot ((g basic-graph) (stream stream) &key graph-formatter vertex-key vertex-labeler vertex-formatter edge-labeler edge-formatter &allow-other-keys) ¶

Source

graphviz-support.lisp.

Generic Function: graph->dot-external (graph file-name &key type &allow-other-keys) ¶

Package

cl-graph.

Source

api.lisp.

Methods

Method: graph->dot-external ((g basic-graph) file-name &rest args &key type &allow-other-keys) ¶

Generate an external represenation of a graph to a file, by running the program in *dot-path*.

Source

graphviz-support.lisp.

Generic Function: graph->dot-properties (g stream) ¶

Unless a different graph-formatter is specified,
this method is called by graph->dot to output graph-properties onto a stream. The function can assume that the openning and closing brackets will be taken care of by the graph->dot.

Package

cl-graph.

Source

api.lisp.

Methods

Method: graph->dot-properties ((graph dot-graph-mixin) stream) ¶

Source

graphviz-support.lisp.

Method: graph->dot-properties (g stream) ¶

Source

graphviz-support.lisp.

Generic Function: graph-edge-mixture-matrix (graph vertex-classifier &key edge-weight) ¶

Return the ‘mixing-matrix‘ of graph based on the
classifier and the edge-weight function. The mixing matrix is a matrix whose runs and columns represent each class of vertex in the graph. The entries of the matrix show the total number of edges between vertexes of the two kinds. [?? Edge-weight is not used; also compare with graph-mixture-matrix.]

Package

cl-graph.

Source

api.lisp.

Generic Reader: graph-edges (object) ¶

Package

cl-graph.

Methods

Reader Method: graph-edges ((basic-graph basic-graph)) ¶

automatically generated reader method

Source

graph.lisp.

Target Slot

graph-edges.

Generic Function: graph-mixing-matrix (graph vertex-classifier &key edge-weight) ¶

Return the ‘mixing-matrix‘ of graph based on the
classifier and the edge-weight function. The mixing matrix is a matrix whose runs and columns represent each class of vertex in the graph. The entries of the matrix show the total number of edges between vertexes of the two kinds. [?? Edge-weight is not used; also compare with graph-edge-mixture-matrix.]

Package

cl-graph.

Source

api.lisp.

Generic Function: graph-roots (graph) ¶

Returns a list of the roots of graph. A root is
defined as a vertex with no source edges (i.e., all of the edges are out-going). (cf. rootp) [?? could be a defun]

Package

cl-graph.

Source

api.lisp.

Methods

Method: graph-roots ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Reader: graph-vertexes (object) ¶

Package

cl-graph.

Methods

Reader Method: graph-vertexes ((basic-graph basic-graph)) ¶

automatically generated reader method

Source

graph.lisp.

Target Slot

graph-vertexes.

Generic Function: has-children-p (vertex) ¶

In a directed graph, returns true if vertex has any
edges that point from vertex to some other
vertex (cf. iterate-source-edges). In an undirected graph, ‘has-children-p‘ is testing only whether or not the vertex has any edges.

Package

cl-graph.

Source

api.lisp.

Methods

Method: has-children-p ((vertex graph-container-vertex)) ¶

Source

graph-container.lisp.

Generic Function: has-parent-p (vertex) ¶

In a directed graph, returns true if vertex has any
edges that point from some other vertex to this
vertex (cf. iterate-target-edges). In an undirected graph, ‘has-parent-p‘ is testing only whether or not the vertex has any edges.

Package

cl-graph.

Source

api.lisp.

Methods

Method: has-parent-p ((vertex graph-container-vertex)) ¶

Source

graph-container.lisp.

Generic Function: height-in-pixels (thing) ¶

Package

cl-graph.

Methods

Method: height-in-pixels ((thing dot-vertex-mixin)) ¶

Return the attribute in pixels assuming 72 dpi

Source

graphviz-support.lisp.

Generic Function: (setf height-in-pixels) (thing) ¶

Package

cl-graph.

Methods

Method: (setf height-in-pixels) ((thing dot-vertex-mixin)) ¶

Set the attribute in pixels assuming 72 dpi

Source

graphviz-support.lisp.

Generic Function: in-cycle-p (graph start-vertex) ¶

Returns true if ‘start-vertex‘ is in some cycle in
‘graph‘. This uses child-vertexes to generate the vertexes adjacent to a vertex.

Package

cl-graph.

Source

api.lisp.

Methods

Method: in-cycle-p ((graph basic-graph) (start-vertex basic-vertex)) ¶

Source

graph.lisp.

Method: in-cycle-p ((graph basic-graph) vertex) ¶

Source

graph.lisp.

Generic Function: in-undirected-cycle-p (graph start-vertex &optional marked previous) ¶

Return true if-and-only-if an undirected cycle in graph is reachable from start-vertex.

Package

cl-graph.

Source

api.lisp.

Methods

Method: in-undirected-cycle-p ((graph basic-graph) (current basic-vertex) &optional marked previous) ¶

Source

graph.lisp.

Generic Function: iterate-edges (graph-or-vertex fn) ¶

Calls ‘fn‘ on each edge of graph or vertex.

Package

cl-graph.

Source

api.lisp.

Methods

Method: iterate-edges ((vertex graph-container-vertex) fn) ¶

Source

graph-container.lisp.

Method: iterate-edges ((graph graph-container) fn) ¶

Source

graph-container.lisp.

Generic Function: iterate-neighbors (vertex fn) ¶

Calls fn on every vertex adjecent to vertex See also iterate-children and iterate-parents.

Package

cl-graph.

Source

api.lisp.

Methods

Method: iterate-neighbors ((vertex graph-container-vertex) fn) ¶

Source

graph-container.lisp.

Generic Function: iterate-parents (vertex fn) ¶

Calls fn on every vertex that is either connected
to vertex by an undirected edge or is at the source end of a directed edge.

Package

cl-graph.

Source

api.lisp.

Methods

Method: iterate-parents ((vertex graph-container-vertex) fn) ¶

Source

graph-container.lisp.

Generic Function: iterate-source-edges (vertex fn) ¶

In a directed graph, calls ‘fn‘ on each edge of a
vertex that begins at vertex. In an undirected graph, this is equivalent to ‘iterate-edges‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: iterate-source-edges ((vertex graph-container-vertex) fn) ¶

Source

graph-container.lisp.

Generic Function: iterate-target-edges (vertex fn) ¶

In a directed graph, calls ‘fn‘ on each edge of a
vertex that ends at vertex. In an undirected graph, this is equivalent to ‘iterate-edges‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: iterate-target-edges ((vertex graph-container-vertex) fn) ¶

Source

graph-container.lisp.

Generic Function: iterate-vertexes (thing fn) ¶

Calls ‘fn‘ on each of the vertexes of ‘thing‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: iterate-vertexes ((edge basic-edge) fn) ¶

Source

graph.lisp.

Method: iterate-vertexes ((graph basic-graph) fn) ¶

Source

graph.lisp.

Generic Function: make-filtered-graph (old-graph test-fn &key graph-completion-method depth new-graph) ¶

Takes a GRAPH and a TEST-FN (a single argument
function returning NIL or non-NIL), and filters the graph nodes according to the test-fn (those that return non-NIL are accepted), returning a new graph with only nodes corresponding to those in the original graph that satisfy the test (the nodes in the new graph are new, but their values and name point to the same contents of the original graph). There are four options for how the new graph is filled-out, depending on the following keywords passed to the optional GRAPH-COMPLETION-METHOD argument:

* NIL (default)

New graph has only nodes that correspond to those in the original graph that pass the test. NO LINKS are reproduced.

* :COMPLETE-LINKS

New graph has only nodes that pass, but reproduces corresponding links between passing nodes in the original graph.

* :COMPLETE-CLOSURE-NODES-ONLY

New graph also includes nodes corresponding to the transitive closure(s) that include the passign nodes in the original graph. NO LINKS are reproduced.

* :COMPLETE-CLOSURE-WITH-LINKS

Same as above, except corresponding links are reproduced.

For both transitive closure options, an additional optional argument, DEPTH, specifies how many links away from a source vertex to travel in gathering vertexes of the closure. E.g., a depth of 1 returns the source vertex and the parents and children of that vertex (all vertexes one link away from the source). The default value is NIL, indicating that all vertexes are to be included, no matter their depth. This value is ignored in non closure options.

Package

cl-graph.

Source

api.lisp.

Generic Function: make-graph (graph-type &key &allow-other-keys) ¶

Create a new graph of type ‘graph-type’. Graph type
can be a symbol naming a sub-class of basic-graph or a list. If it is a list of symbols naming different classes. If graph-type is a list, then a class which has all of the listed classes as superclasses will be found (or created). In either case, the new graph will be created as if with a call to make-instance.

Package

cl-graph.

Source

api.lisp.

Methods

Method: make-graph ((graph-type symbol) &rest args &key &allow-other-keys) ¶

Source

graph.lisp.

Generic Function: make-graph-from-vertexes (vertex-list) ¶

Create a new graph given a list of vertexes (which
are assumed to be from the same graph). The new graph contains all of the vertexes in the list and all of the edges between any vertexes on the list.

Package

cl-graph.

Source

api.lisp.

Generic Function: make-vertex-edges-container (vertex container-class &rest args) ¶

Called during the initialization of a vertex to
create the create the container used to store the edges incident to the vertex. The initarg :vertex-edges-container-class can be used to alter the default container class.

Package

cl-graph.

Source

api.lisp.

Methods

Method: make-vertex-edges-container ((vertex graph-container-vertex) container-class &rest args) ¶

Source

graph-container.lisp.

Generic Function: make-vertex-for-graph (graph &key vertex-class &allow-other-keys) ¶

Creates a new vertex for graph ‘graph‘. The keyword
arguments include:

* vertex-class : specify the class of the vertex
* element : specify the ‘element‘ of the vertex

and any other initialization arguments that make sense for the vertex class.

Package

cl-graph.

Source

api.lisp.

Methods

Method: make-vertex-for-graph ((graph basic-graph) &rest args &key vertex-class &allow-other-keys) ¶

Source

graph.lisp.

Generic Function: minimum-spanning-tree (graph &key edge-sorter) ¶

Returns a minimum spanning tree of graph if one exists and nil otherwise.

Package

cl-graph.

Source

api.lisp.

Methods

Method: minimum-spanning-tree ((graph basic-graph) &key edge-sorter) ¶

Source

graph-algorithms.lisp.

Generic Function: neighbor-vertexes (vertex &optional filter) ¶

Returns a list of the vertexes to which ‘vertex‘ is
connected by an edge disregarding edge direction. In a directed graph, neighbor-vertexes is the union of parent-vertexes and child-vertexes. [?? Could be a defun].

Package

cl-graph.

Source

api.lisp.

Methods

Method: neighbor-vertexes (vertex &optional filter) ¶

Source

graph.lisp.

Generic Reader: next-node (object) ¶

Generic Writer: (setf next-node) (object) ¶

Package

cl-graph.

Methods

Reader Method: next-node ((basic-vertex basic-vertex)) ¶

Writer Method: (setf next-node) ((basic-vertex basic-vertex)) ¶

‘Next-node‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]

Source

graph.lisp.

Target Slot

next-node.

Generic Function: number-of-neighbors (vertex) ¶

Returns the number of neighbors of
‘vertex‘ (cf. ‘neighbor-vertexes‘). [?? could be a defun]

Package

cl-graph.

Source

api.lisp.

Methods

Method: number-of-neighbors (vertex) ¶

Source

graph.lisp.

Generic Function: other-vertex (edge value-or-vertex) ¶

Assuming that the value-or-vertex corresponds to
one of the vertexes for ‘edge‘, this method returns the other vertex of ‘edge‘. If the value-or-vertex is not part of edge, then an error is signaled. [?? Should create a new condition for this]

Package

cl-graph.

Source

api.lisp.

Methods

Method: other-vertex ((edge graph-container-edge) value) ¶

Source

graph-container.lisp.

Method: other-vertex ((edge graph-container-edge) (v graph-container-vertex)) ¶

Source

graph-container.lisp.

Generic Function: out-edge-for-vertex-p (edge vertex) ¶

Returns true if the edge is connected to vertex and
is either an undirected edge or a directed edge for which vertex is the source vertex of the edge.

Package

cl-graph.

Source

api.lisp.

Methods

Method: out-edge-for-vertex-p ((edge basic-edge) (vertex basic-vertex)) ¶

Source

graph-algorithms.lisp.

Generic Function: parent-vertexes (vertex &optional filter) ¶

Returns a list of the vertexes to which ‘vertex‘ is
connected by an edge and for which ‘vertex‘ is the target vertex. If the connecting edge is undirected, then the vertex is always counted as a target. [?? Could be a defun].

Package

cl-graph.

Source

api.lisp.

Methods

Method: parent-vertexes (vertex &optional filter) ¶

Source

graph.lisp.

Generic Reader: previous-node (object) ¶

Generic Writer: (setf previous-node) (object) ¶

Package

cl-graph.

Methods

Reader Method: previous-node ((basic-vertex basic-vertex)) ¶

Writer Method: (setf previous-node) ((basic-vertex basic-vertex)) ¶

‘Previous-node‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]

Source

graph.lisp.

Target Slot

previous-node.

Generic Function: project-bipartite-graph (new-graph existing-graph vertex-class vertex-classifier) ¶

Creates the unimodal bipartite projects of
existing-graph with vertexes for each vertex of existing graph whose ‘vertex-classifier‘ is eq to ‘vertex-class‘ and where an edge existing between two vertexes of the graph if and only if they are connected to a shared vertex in the existing-graph.

Package

cl-graph.

Source

api.lisp.

Methods

Method: project-bipartite-graph ((new-graph basic-graph) graph vertex-class vertex-classifier) ¶

Source

graph.lisp.

Method: project-bipartite-graph ((new-graph symbol) graph vertex-class vertex-classifier) ¶

Source

graph.lisp.

Generic Reader: rank (object) ¶

Generic Writer: (setf rank) (object) ¶

Package

cl-graph.

Methods

Reader Method: rank ((basic-vertex basic-vertex)) ¶

Writer Method: (setf rank) ((basic-vertex basic-vertex)) ¶

The ‘rank‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]

Source

graph.lisp.

Target Slot

rank.

Generic Function: renumber-edges (graph) ¶

Assign a number to each edge in a graph in some unspecified order. [?? internal]

Package

cl-graph.

Source

api.lisp.

Methods

Method: renumber-edges ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: renumber-vertexes (graph) ¶

Assign a number to each vertex in a graph in some unspecified order. [?? internal]

Package

cl-graph.

Source

api.lisp.

Methods

Method: renumber-vertexes ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: replace-vertex (graph old new) ¶

Replace vertex ‘old‘ in graph ‘graph‘ with vertex ‘new‘. The edge structure of the graph is maintained.

Package

cl-graph.

Source

api.lisp.

Methods

Method: replace-vertex :after ((graph graph-container) (old basic-vertex) (new basic-vertex)) ¶

Source

graph-container.lisp.

Method: replace-vertex :before ((graph graph-container) (old basic-vertex) (new basic-vertex)) ¶

Source

graph-container.lisp.

Method: replace-vertex ((graph basic-graph) (old basic-vertex) (new basic-vertex)) ¶

Source

graph.lisp.

Generic Function: rooted-dfs (graph root fn &key out-edge-sorter) ¶

A variant of DFS that does not visit nodes that are unreachable from the ROOT.

Package

cl-graph.

Source

graph-algorithms.lisp.

Methods

Method: rooted-dfs ((graph basic-graph) root fn &key out-edge-sorter) ¶

Method: rooted-dfs ((graph basic-graph) (root basic-vertex) fn &key out-edge-sorter) ¶

Generic Function: rootp (vertex) ¶

Returns true if ‘vertex‘ is a root vertex (i.e., it has no incoming (source) edges).

Package

cl-graph.

Source

api.lisp.

Methods

Method: rootp ((vertex basic-vertex)) ¶

Source

graph.lisp.

Generic Function: search-for-vertex (graph value &key key test error-if-not-found?) ¶

Search ’graph’ for a vertex with element
’value’. The ’key’ function is applied to each element before that element is compared with the value. The comparison is done using the function ’test’. If you don’t need to use key or test, then consider using find-vertex instead.

Package

cl-graph.

Source

api.lisp.

Methods

Method: search-for-vertex ((graph basic-graph) vertex &key key test error-if-not-found?) ¶

Source

graph.lisp.

Method: search-for-vertex ((graph basic-graph) (vertex basic-vertex) &key key test error-if-not-found?) ¶

Source

graph.lisp.

Generic Function: source-edge-count (vertex) ¶

Returns the number of source edges of
vertex (cf. source-edges). [?? could be a defun]

Package

cl-graph.

Source

api.lisp.

Methods

Method: source-edge-count ((vertex basic-vertex)) ¶

Source

graph.lisp.

Generic Function: source-edges (vertex &optional filter) ¶

Returns a list of the source edges of ‘vertex‘. I.e., the edges that begin at ‘vertex‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: source-edges ((vertex basic-vertex) &optional filter) ¶

Source

graph.lisp.

Generic Function: source-vertex (edge) ¶

Returns the source-vertex of a directed edge. Compare with ‘vertex-1‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: source-vertex ((edge graph-container-edge)) ¶

Source

graph-container.lisp.

Generic Function: subgraph-containing (graph vertex &key depth new-graph) ¶

Returns a new graph that is a subset of ‘graph‘
that contains ‘vertex‘ and all of the other vertexes that can be reached from vertex by paths of less than or equal of length ‘depth‘. If depth is not specified, then the entire sub-graph reachable from vertex will be returned. [?? Edge weights are always assumed to be one.]

Package

cl-graph.

Source

api.lisp.

Generic Function: tag-all-edges (thing) ¶

Sets the ‘tag‘ of all the edges of ‘thing‘ to true. [?? why does this exist?]

Package

cl-graph.

Source

api.lisp.

Methods

Method: tag-all-edges ((vertex basic-vertex)) ¶

Source

graph.lisp.

Method: tag-all-edges ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: tagged-edge-p (edge) ¶

Returns true if-and-only-if edge’s tag slot is t

Package

cl-graph.

Source

api.lisp.

Methods

Method: tagged-edge-p ((edge basic-edge)) ¶

Source

graph.lisp.

Generic Function: target-edge-count (vertex) ¶

Returns the number of target edges of
vertex (cf. target-edges). [?? could be a defun]

Package

cl-graph.

Source

api.lisp.

Methods

Method: target-edge-count ((vertex basic-vertex)) ¶

Source

graph.lisp.

Generic Function: target-edges (vertex &optional filter) ¶

Returns a list of the target edges of ‘vertex‘. I.e., the edges that end at ‘vertex‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: target-edges ((vertex basic-vertex) &optional filter) ¶

Source

graph.lisp.

Generic Function: target-vertex (edge) ¶

Returns the target-vertex of a directed edge. Compare with ‘vertex-2‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: target-vertex ((edge graph-container-edge)) ¶

Source

graph-container.lisp.

Generic Function: topological-sort (graph) ¶

Returns a list of vertexes sorted by the depth from
the roots of the graph. See also assign-level and graph-roots.

Package

cl-graph.

Source

api.lisp.

Methods

Method: topological-sort ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Reader: undirected-edge-class (object) ¶

Package

cl-graph.

Methods

Reader Method: undirected-edge-class ((basic-graph basic-graph)) ¶

The class used to create undirected edges in the graph. This must extend the base-class for edges of the graph type and undirected-edge-mixin. E.g., all undirected edges of a graph-container must extend graph-container-edge and undirected-edge-mixin.

Source

graph.lisp.

Target Slot

undirected-edge-class.

Generic Function: undirected-edge-p (edge) ¶

Returns true if-and-only-if edge is undirected

Package

cl-graph.

Source

api.lisp.

Methods

Method: undirected-edge-p ((edge basic-edge)) ¶

Source

graph.lisp.

Generic Function: untag-all-edges (thing) ¶

Sets the ‘tag‘ of all the edges of ‘thing‘ to nil. [?? why does this exist?]

Package

cl-graph.

Source

api.lisp.

Methods

Method: untag-all-edges ((vertex basic-vertex)) ¶

Source

graph.lisp.

Method: untag-all-edges ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: untagged-edge-p (edge) ¶

Returns true if-and-only-if edge’s tage slot is nil

Package

cl-graph.

Source

api.lisp.

Methods

Method: untagged-edge-p ((edge basic-edge)) ¶

Source

graph.lisp.

Generic Reader: vertex (condition) ¶

Package

cl-graph.

Methods

Reader Method: vertex ((condition graph-vertex-not-found-in-edge-error)) ¶

Source

graph.lisp.

Target Slot

vertex.

Reader Method: vertex ((condition graph-vertex-not-found-error)) ¶

Source

graph.lisp.

Target Slot

vertex.

Generic Reader: vertex-1 (condition) ¶

Package

cl-graph.

Methods

Reader Method: vertex-1 ((graph-container-edge graph-container-edge)) ¶

‘Vertex-1‘ is one of the two vertexes that an edge connects. In a directed-edge, ‘vertex-1‘ is also the ‘source-vertex‘.

Source

graph-container.lisp.

Target Slot

vertex-1.

Reader Method: vertex-1 ((condition graph-edge-not-found-error)) ¶

Source

graph.lisp.

Target Slot

vertex-1.

Generic Reader: vertex-2 (condition) ¶

Package

cl-graph.

Methods

Reader Method: vertex-2 ((graph-container-edge graph-container-edge)) ¶

‘Vertex-2‘ is one of the two vertexes that an edge connects. In a directed edge, ‘vertex-2‘ is also the ‘target-vertex‘.

Source

graph-container.lisp.

Target Slot

vertex-2.

Reader Method: vertex-2 ((condition graph-edge-not-found-error)) ¶

Source

graph.lisp.

Target Slot

vertex-2.

Generic Function: vertex->dot (vertex stream) ¶

Unless a different vertex-formatter is specified
with a keyword argument, this is used by graph->dot to output vertex formatting for ‘vertex‘ onto the ‘stream‘. The function can assume that openning and closing square brackets and label have already been taken care of.

Package

cl-graph.

Source

api.lisp.

Methods

Method: vertex->dot ((vertex dot-vertex-mixin) stream) ¶

Source

graphviz-support.lisp.

Method: vertex->dot ((v basic-vertex) (stream stream)) ¶

Source

graphviz-support.lisp.

Generic Reader: vertex-class (object) ¶

Package

cl-graph.

Methods

Reader Method: vertex-class ((basic-graph basic-graph)) ¶

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.

Source

graph.lisp.

Target Slot

vertex-class.

Generic Function: vertex-count (graph) ¶

Returns the number of vertexes in ‘graph‘. [?? could be a defun]

Package

cl-graph.

Source

api.lisp.

Methods

Method: vertex-count ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Reader: vertex-id (object) ¶

Package

cl-graph.

Methods

Reader Method: vertex-id ((basic-vertex basic-vertex)) ¶

‘Vertex-id‘ is used internally to keep track of vertexes.

Source

graph.lisp.

Target Slot

vertex-id.

Generic Function: vertexes (thing) ¶

Returns a list of the vertexes of ‘thing‘.

Package

cl-graph.

Source

api.lisp.

Methods

Method: vertexes ((edge graph-container-edge)) ¶

Source

graph-container.lisp.

Method: vertexes ((graph basic-graph)) ¶

Source

graph.lisp.

Generic Function: vertices-share-edge-p (vertex-1 vertex-2) ¶

Return true if vertex-1 and vertex-2 are connected by an edge. [?? Compare adjacentp]

Package

cl-graph.

Source

api.lisp.

Methods

Method: vertices-share-edge-p ((vertex-1 graph-container-vertex) (vertex-2 graph-container-vertex)) ¶

Source

graph-container.lisp.

Generic Function: width-in-pixels (thing) ¶

Package

cl-graph.

Methods

Method: width-in-pixels ((thing dot-vertex-mixin)) ¶

Return the attribute in pixels assuming 72 dpi

Source

graphviz-support.lisp.

Generic Function: (setf width-in-pixels) (thing) ¶

Package

cl-graph.

Methods

Method: (setf width-in-pixels) ((thing dot-vertex-mixin)) ¶

Set the attribute in pixels assuming 72 dpi

Source

graphviz-support.lisp.

---