This is the cl-graph Reference Manual, version 0.10.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:44:47 2022 GMT+0.
Next: Modules, Previous: The cl-graph Reference Manual, Up: The cl-graph Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Graph manipulation utilities for Common Lisp
Gary Warren King <gwking@metabang.com>
Gary Warren King <gwking@metabang.com>
MIT Style License
0.10.2
Next: Files, Previous: Systems, Up: The cl-graph Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: cl-graph/dev/graphviz, Previous: Modules, Up: Modules [Contents][Index]
cl-graph (system).
Next: cl-graph/website, Previous: cl-graph/dev, Up: Modules [Contents][Index]
graph.lisp (file).
dev (module).
graphviz-support.lisp (file).
Next: cl-graph/website/source, Previous: cl-graph/dev/graphviz, Up: Modules [Contents][Index]
Next: Packages, Previous: Modules, Up: The cl-graph Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-graph/dev/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-graph (system).
Next: cl-graph/dev/api.lisp, Previous: cl-graph/cl-graph.asd, Up: Lisp [Contents][Index]
dev (module).
Next: cl-graph/dev/macros.lisp, Previous: cl-graph/dev/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
dev (module).
Next: cl-graph/dev/graph.lisp, Previous: cl-graph/dev/api.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
dev (module).
with-changing-vertex (macro).
Next: cl-graph/dev/graph-container.lisp, Previous: cl-graph/dev/macros.lisp, Up: Lisp [Contents][Index]
dev (module).
Next: cl-graph/dev/graph-matrix.lisp, Previous: cl-graph/dev/graph.lisp, Up: Lisp [Contents][Index]
graph.lisp (file).
dev (module).
Next: cl-graph/dev/graph-algorithms.lisp, Previous: cl-graph/dev/graph-container.lisp, Up: Lisp [Contents][Index]
graph.lisp (file).
dev (module).
Next: cl-graph/dev/graphviz/graphviz-support.lisp, Previous: cl-graph/dev/graph-matrix.lisp, Up: Lisp [Contents][Index]
graph.lisp (file).
dev (module).
Previous: cl-graph/dev/graph-algorithms.lisp, Up: Lisp [Contents][Index]
graphviz (module).
Next: cl-graph/dev/notes.text, Previous: Static, Up: Static [Contents][Index]
cl-graph (system).
Next: cl-graph/website/source/index.mmd, Previous: cl-graph/COPYING, Up: Static [Contents][Index]
dev (module).
Previous: cl-graph/dev/notes.text, Up: Static [Contents][Index]
source (module).
Next: Definitions, Previous: Files, Up: The cl-graph Reference Manual [Contents][Index]
Packages are listed by definition order.
CL-Graph is a Common Lisp library for manipulating graphs and running graph algorithms.
metabang.graph
Next: Indexes, Previous: Packages, Up: The cl-graph Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
Next: Compiler macros, Previous: Special variables, Up: Public Interface [Contents][Index]
This is used to maintain consistency when changing the value of vertex elements while iterating over the vertexes...
Next: Ordinary functions, Previous: Macros, Up: Public Interface [Contents][Index]
Next: Generic functions, Previous: Compiler macros, Up: Public Interface [Contents][Index]
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).
Apply fn to each path that starts at start-vertex and is of exactly length length
Apply fn to each shortest path starting at ‘start-vertex‘ of depth ‘depth‘. The ‘filter‘ predicate is used to remove vertexes from consideration.
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
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.
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.
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.
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]
Returns true if there are any undirected cycles in ‘graph‘.
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’.
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].
The ‘color‘ is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]
The ‘color‘ slot is used by some algorithms for bookkeeping.
Returns the number of connected-components of graph.
Returns a union-find-container representing the connected-components of ‘graph‘.
Returns true if graph is a connected graph and nil otherwise.
Returns true if graph contains at least one directed edge. [?? Not sure if this is really kept up-to-date.]
Returns true if graph contains at least one undirected edge. [?? Not sure if this is really kept up-to-date.]
The default edge class for the graph.
The default edge type for the graph. This should be one of :undirected or :directed.
Delete all edges from ‘graph’. Returns the graph..
Delete the ‘edge’ from the ‘graph’ and returns it.
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.
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.
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.
‘Depth-level‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
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.
Returns true if-and-only-if edge is directed
‘Discovery-time‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
automatically generated reader method
automatically generated writer method
edge.
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.
Returns the number of edges attached to
‘vertex‘. Compare with the more flexible ‘vertex-degree‘.
The ‘edge-id‘ is used internally by CL-Graph for bookkeeping.
Returns true if and only if edge-1 is undirected and edge-2 is directed.
Returns true if the weight of edge-1 is strictly less than the weight of edge-2.
Returns a list of the edges of ‘thing‘.
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.
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?]
Searches ‘graph‘ for an edge that connects vertex-1
and vertex-2. [?? Ignores error-if-not-found? Does directedness
matter? need test]
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.]
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.
Returns a list of edges in ‘thing‘ for which the ‘predicate‘ returns non-nil. [?? why no key function?]
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.
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.
Returns a list of vertexes in ‘thing‘ for which the ‘predicate‘ returns non-nil. [?? why no key function?]
‘Finish-time‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
Ensures that the graph is undirected (possibly by calling change-class on the edges).
Returns a version of graph which is a directed free tree rooted at root.
The graph in which this vertex is contained.
The ‘graph‘ of which this edge is a part.
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’.
Generate an external represenation of a graph to a file, by running the program in *dot-path*.
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.
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.]
automatically generated reader method
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.]
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]
automatically generated reader method
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.
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.
Return the attribute in pixels assuming 72 dpi
Set the attribute in pixels assuming 72 dpi
Returns true if ‘start-vertex‘ is in some cycle in
‘graph‘. This uses child-vertexes to generate the vertexes adjacent
to a vertex.
Return true if-and-only-if an undirected cycle in graph is reachable from start-vertex.
Calls ‘fn‘ on each edge of graph or vertex.
Calls fn on every vertex adjecent to vertex See also iterate-children and iterate-parents.
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.
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‘.
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‘.
Calls ‘fn‘ on each of the vertexes of ‘thing‘.
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.
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.
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.
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.
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.
Returns a minimum spanning tree of graph if one exists and nil otherwise.
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].
‘Next-node‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
Returns the number of neighbors of
‘vertex‘ (cf. ‘neighbor-vertexes‘). [?? could be a defun]
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]
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.
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].
‘Previous-node‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
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.
The ‘rank‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
rank.
Assign a number to each edge in a graph in some unspecified order. [?? internal]
Assign a number to each vertex in a graph in some unspecified order. [?? internal]
Replace vertex ‘old‘ in graph ‘graph‘ with vertex ‘new‘. The edge structure of the graph is maintained.
A variant of DFS that does not visit nodes that are unreachable from the ROOT.
Returns true if ‘vertex‘ is a root vertex (i.e., it has no incoming (source) edges).
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.
Returns the number of source edges of
vertex (cf. source-edges). [?? could be a defun]
Returns a list of the source edges of ‘vertex‘. I.e., the edges that begin at ‘vertex‘.
Returns the source-vertex of a directed edge. Compare with ‘vertex-1‘.
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.]
Sets the ‘tag‘ of all the edges of ‘thing‘ to true. [?? why does this exist?]
Returns true if-and-only-if edge’s tag slot is t
Returns the number of target edges of
vertex (cf. target-edges). [?? could be a defun]
Returns a list of the target edges of ‘vertex‘. I.e., the edges that end at ‘vertex‘.
Returns the target-vertex of a directed edge. Compare with ‘vertex-2‘.
Returns a list of vertexes sorted by the depth from
the roots of the graph. See also assign-level and graph-roots.
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.
Returns true if-and-only-if edge is undirected
Sets the ‘tag‘ of all the edges of ‘thing‘ to nil. [?? why does this exist?]
Returns true if-and-only-if edge’s tage slot is nil
‘Vertex-1‘ is one of the two vertexes that an edge connects. In a directed-edge, ‘vertex-1‘ is also the ‘source-vertex‘.
‘Vertex-2‘ is one of the two vertexes that an edge connects. In a directed edge, ‘vertex-2‘ is also the ‘target-vertex‘.
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.
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.
Returns the number of vertexes in ‘graph‘. [?? could be a defun]
‘Vertex-id‘ is used internally to keep track of vertexes.
Returns a list of the vertexes of ‘thing‘.
Return true if vertex-1 and vertex-2 are connected by an edge. [?? Compare adjacentp]
Return the attribute in pixels assuming 72 dpi
Set the attribute in pixels assuming 72 dpi
Next: Conditions, Previous: Generic functions, Up: Public Interface [Contents][Index]
metabang.cl-containers.
automatically generated writer method
metabang.utilities.
automatically generated reader method
metabang.utilities.
metabang.utilities.
The ‘element‘ is the value that this vertex represents.
metabang.utilities.
The ‘element‘ is the value that this vertex represents.
metabang.utilities.
metabang.cl-containers.
metabang.cl-containers.
metabang.cl-containers.
metabang.cl-containers.
metabang.cl-containers.
metabang.cl-containers.
metabang.cl-containers.
metabang.utilities.
The ‘tag‘ is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]
metabang.utilities.
tag.
The ‘tag‘ is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]
metabang.utilities.
tag.
The ‘tag‘ slot is used by some algorithms to keep track of which vertexes have been visited.
metabang.utilities.
tag.
The ‘tag‘ slot is used by some algorithms to keep track of which vertexes have been visited.
metabang.utilities.
tag.
The value of the weight of this edge. Defaults to 1.0d0
metabang.cl-containers.
The value of the weight of this edge. Defaults to 1.0d0
metabang.cl-containers.
metabang.cl-containers.
Next: Classes, Previous: Standalone methods, Up: Public Interface [Contents][Index]
This is the root condition for graph errors that have to do with edges.
edge.
This condition is signaled when an edge cannot be found in a graph.
One of the vertexes for which no connecting edge could be found.
(quote nil)
:vertex-1
This slot is read-only.
This is the root condition for errors that occur while running code in CL-Graph.
error.
This condition is signaled when a vertex can not be found in a graph.
This condition is signaled when a vertex can not be found in an edge.
Previous: Conditions, Up: Public Interface [Contents][Index]
This is the root class for all edges in CL-Graph.
The ‘edge-id‘ is used internally by CL-Graph for bookkeeping.
0
:edge-id
metabang.utilities.
:element, :value
The ‘tag‘ is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]
metabang.utilities.
:tag
tag.
The ‘graph‘ of which this edge is a part.
:graph
This slot is read-only.
The ‘color‘ is used by some algorithms for bookkeeping. [?? Should probably be in a mixin]
:color
This is the root class for all graphs in CL-Graph.
Initarg | Value |
---|---|
:initial-size | 25 |
:graph-vertexes
This slot is read-only.
:graph-edges
This slot is read-only.
0
This slot is read-only.
0
This slot is read-only.
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.
(quote cl-graph:basic-vertex)
:vertex-class
This slot is read-only.
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.
(quote cl-graph::basic-directed-edge)
:directed-edge-class
This slot is read-only.
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.
(quote cl-graph::basic-undirected-edge)
:undirected-edge-class
This slot is read-only.
Returns true if graph contains at least one directed edge. [?? Not sure if this is really kept up-to-date.]
Returns true if graph contains at least one undirected edge. [?? Not sure if this is really kept up-to-date.]
(function eq)
:vertex-test
This slot is read-only.
(function identity)
:vertex-key
This slot is read-only.
(function eq)
:edge-test
This slot is read-only.
(function identity)
:edge-key
This slot is read-only.
The default edge type for the graph. This should be one of :undirected or :directed.
:default-edge-type
This slot is read-only.
The default edge class for the graph.
:default-edge-class
This slot is read-only.
This is the root class for all vertexes in CL-Graph.
container-node-mixin.
‘Depth-level‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
number
0
:depth-level
‘Vertex-id‘ is used internally to keep track of vertexes.
0
:vertex-id
This slot is read-only.
The ‘element‘ is the value that this vertex represents.
metabang.utilities.
:element
The ‘tag‘ slot is used by some algorithms to keep track of which vertexes have been visited.
metabang.utilities.
:tag
tag.
The graph in which this vertex is contained.
:graph
The ‘color‘ slot is used by some algorithms for bookkeeping.
:color
The ‘rank‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
:rank
rank.
‘Previous-node‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
:previous-node
‘Next-node‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
:next-node
‘Discovery-time‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
-1
:discovery-time
‘Finish-time‘ is used by some algorithms for bookkeeping. [?? Should be in a mixin]
-1
:finish-time
This mixin class is used to indicate that an edge is directed.
:dot-attributes
Initarg | Value |
---|---|
:vertex-class | (quote dot-vertex) |
:directed-edge-class | (quote dot-directed-edge) |
:undirected-edge-class | (quote dot-edge) |
A graph container is essentially an adjacency list graph representation [?? The Bad name comes from it being implemented with containers... ugh]
Initarg | Value |
---|---|
:vertex-class | (quote graph-container-vertex) |
:directed-edge-class | (quote graph-container-directed-edge) |
:undirected-edge-class | (quote graph-container-undirected-edge) |
(metabang.cl-containers:make-container (quote metabang.cl-containers:simple-associative-container) :test (function equal))
This slot is read-only.
A graph-container-directed-edge is both a directed-edge-mixin and a graph-container-edge.
This is the root class for edges in graph-containers. It adds vertex-1 and vertex-2 slots.
‘Vertex-1‘ is one of the two vertexes that an edge connects. In a directed-edge, ‘vertex-1‘ is also the ‘source-vertex‘.
:vertex-1
This slot is read-only.
A graph-container-undirected-edge is both an undirected-edge-mixin and a graph-container-edge.
A graph container vertex keeps track of its edges in the the vertex-edges slot. The storage for this defaults to a vector-container but can be changed using the vertex-edges-container-class initarg.
Initarg | Value |
---|---|
:vertex-edges-container-class | (quote vector-container) |
This slot is read-only.
Stub for matrix based graph. Not implemented.
Initarg | Value |
---|---|
:vertex-class | (quote graph-matrix-vertex) |
:undirected-edge-class | (quote graph-matrix-edge) |
This slot is read-only.
Stub for matrix based graph. Not implemented.
Stub for matrix based graph. Not implemented.
This mixin class is used to indicate that an edge is undirected.
A weighted edge is a weighted-edge-mixin, a directed-edge-mixin, and a graph-container-edge.
A weighted edge is both a weighted-edge-mixin and a graph-container-edge.
This mixin class adds a ‘weight‘ slot to an edge.
The value of the weight of this edge. Defaults to 1.0d0
metabang.cl-containers.
1.0d0
:weight
A weighted undirected edge is a weighted-edge-mixin, an undirected-edge-mixin, and a graph-container-edge.
Previous: Public Interface, Up: Definitions [Contents][Index]
Path to ‘dot‘
Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]
Next: Generic functions, Previous: Macros, Up: Internals [Contents][Index]
Return a copy of SEQUENCE which is EQUAL to SEQUENCE but not EQ.
copy-seq.
Collects set of unique relatives of nodes in node-list.
Find a state that satisfies goal-p. Start with states, and search according to successors and combiner. Don’t try the same state twice.
Removes all elements in original from target.
Previous: Ordinary functions, Up: Internals [Contents][Index]
Attaches the edge ‘edge‘ to the vertex ‘vertex‘.
automatically generated reader method
Sets the depth of ‘vertex‘ to level and then
recursively sets the depth of all of the children of ‘vertex‘ to
(1+ level).
Add edges between vertexes in the new-graph for
which the matching vertexes in the old-graph have edges. The vertex
matching is done using ‘find-vertex‘.
automatically generated reader method
automatically generated reader method
Generate a ’classic’ random graph G(n, m) with n vertexes and m edges.
Generate the Erd"os-R’enyi random graph G(n,
p). I.e., a graph with n vertexes where each possible edge appears
with probability p. This implementation is from Efficient Generation
of Large Random Networks (see batagelj-generation-2005 in doab).
Generate a Barabasi-Albert type scale free graph
with multiple vertex kinds.
The idea behind this implementation is from Efficient Generation of Large Random Networks (see batagelj-generation-2005 in moab).
Generates a ’scale-free’ graph using preferential
attachment – too damn slow.
Size is the number of vertexes; kind-matrix is as in generate-undirected-graph-via-assortativity-matrix, etc.; add-edge-count is the number of edges to add for each vertex; other-vertex-kind-samplers are confusing...; and vertex-labeler is used to create vertex elements (as in other generators).
Generate a simple scale-free graph using the
preferential attachment mechanism of Barabasi and Albert. The
implementation is from Efficient Generation of Large Random Networks
(see batagelj-generation-2005 in moab). Self-edges are possible.
This generates a random graph with ’size’ vertexes.
The vertexes can be in multiple different classes and the number of
vertexes in each class is specified in the ’kind-matrix’. If the
matrix has all fixnums, then it specifies the counts and these should
add up to the size. If the kind-matrix contains non-fixnums then the
values are treated as ratios.
The assortativity-matrix specifies the number of edges between
vertexes of different kinds.
The vertex-labeler is a function of two parameters: the vertex kind and the index. It should return whatever the ’value’ of the vertex ought to be.
Generate an Erd"os-R/’enyi like random graph
having multiple vertex kinds. See the function Gnp for the simple one
vertex kind method.
Generator and graph-class specify the random number generator used and
the class of the graph produced; Size the number of vertexes. Kind
matrix is a vector of ratios specifying the distribution of vertex
kinds {0 ... (1- k)}. The probability-matrix is a k x k matrix
specifying the probability that two vertexes of the row-kind and the
column-kind will have an edge between them. vertex-labeler is a
function of two arguments (the kind and the vertex number) called to
create values for vertexes. It will be called only once for each
vertex created.
The clever sequential sampling technique in this implementation is from Efficient Generation of Large Random Networks (see batagelj-generation-2005 in moab).
automatically generated reader method
automatically generated reader method
Make-edge-container is called during graph creation
and can be used to create specialized containers to hold graph
edges.
It should not usually necessary to call this in
user code. Creates a new edge between vertex-1 and vertex-2 for the
graph. If the edge-type and edge-class are not specified, they will
be determined from the defaults of the graph.
Make-vertex-container is called during graph
creation and can be used to create specialized containers to hold
graph vertexes.
Sets the ‘tag‘ of all the edges of ‘thing‘ to true. [?? why does this exist?]
WIP
WIP
Sets the ‘tag‘ of all the edges of ‘thing‘ to true. [?? why does this exist?]
automatically generated reader method
The ‘element‘ is the value that this vertex represents.
automatically generated writer method
The ‘element‘ is the value that this vertex represents.
automatically generated reader method
automatically generated reader method
automatically generated reader method
automatically generated reader method
Previous: Definitions, Up: The cl-graph Reference Manual [Contents][Index]
Jump to: | (
A B C D E F G H I L M N O P R S T U V W |
---|
Jump to: | (
A B C D E F G H I L M N O P R S T U V W |
---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
Jump to: | *
A C D E F G L N P R S T U V W |
---|
Jump to: | *
A C D E F G L N P R S T U V W |
---|
Jump to: | A B C D E F G I M N P S U W |
---|
Jump to: | A B C D E F G I M N P S U W |
---|