The cl-directed-graph Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-directed-graph Reference Manual

This is the cl-directed-graph Reference Manual, version 20161106, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:03:40 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CL-DIRECTED-GRAPH

CL-DIRECTED-GRAPH is a simple implementation of the directed graph data structure in Common Lisp.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-directed-graph

Author

Hunter Chandler <wohonajax@gmail.com>

License

MIT

Description

Directed graph data structure

Version

20161106

Dependency

serapeum

Source

cl-directed-graph.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-directed-graph.asd

Location

cl-directed-graph.asd

Systems

cl-directed-graph (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-directed-graph/package.lisp

Parent

cl-directed-graph (system)

Location

package.lisp

Packages

cl-directed-graph


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-directed-graph/src.lisp

Dependency

package.lisp (file)

Parent

cl-directed-graph (system)

Location

src.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 cl-directed-graph

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: add-edge GRAPH X Y

Adds an edge from X to Y in GRAPH.

Package

cl-directed-graph

Source

src.lisp (file)

Function: add-vertex GRAPH VERTEX

Adds VERTEX to GRAPH.

Package

cl-directed-graph

Source

src.lisp (file)

Function: adjacent GRAPH X Y

Tests whether GRAPH contains an edge from X to Y.

Package

cl-directed-graph

Source

src.lisp (file)

Function: make-graph &key VERTICES EDGES

Creates a new directed graph object. VERTICES should be a list of vertices unique under EQUAL. EDGES should be a hash table whose keys are objects in VERTICES and whose values are lists of vertices.

Package

cl-directed-graph

Source

src.lisp (file)

Function: map-breadth-first FUNCTION GRAPH

Returns a list of the results of calling FUNCTION on each vertex of GRAPH in breadth-first traversal order.

Package

cl-directed-graph

Source

src.lisp (file)

Function: map-depth-first FUNCTION GRAPH

Returns a list of the results of calling FUNCTION on each vertex of GRAPH in depth-first traversal order.

Package

cl-directed-graph

Source

src.lisp (file)

Function: map-edges FUNCTION GRAPH

Returns a list of the results of calling FUNCTION on each edge of GRAPH. FUNCTION should take 2 arguments: the starting and ending vertices of an edge.

Package

cl-directed-graph

Source

src.lisp (file)

Function: map-vertices FUNCTION GRAPH

Returns a list of the results of calling FUNCTION on each vertex of GRAPH.

Package

cl-directed-graph

Source

src.lisp (file)

Function: neighbors GRAPH VERTEX

Returns a list of all vertices in GRAPH where there is an edge from VERTEX.

Package

cl-directed-graph

Source

src.lisp (file)

Function: remove-edge GRAPH X Y

Removes the edge from X to Y in GRAPH.

Package

cl-directed-graph

Source

src.lisp (file)

Function: remove-vertex GRAPH VERTEX

Removes VERTEX from GRAPH.

Package

cl-directed-graph

Source

src.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Classes

Class: graph ()
Package

cl-directed-graph

Source

src.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • edges (method)
  • edges (method)
  • vertices (method)
  • vertices (method)
Direct slots
Slot: vertices
Initargs

:vertices

Readers

vertices (generic function)

Writers

(setf vertices) (generic function)

Slot: edges
Initargs

:edges

Readers

edges (generic function)

Writers

(setf edges) (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: traverse &body BODY
Package

cl-directed-graph

Source

src.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Generic functions

Generic Function: edges OBJECT
Generic Function: (setf edges) NEW-VALUE OBJECT
Package

cl-directed-graph

Methods
Method: edges (GRAPH graph)

automatically generated reader method

Source

src.lisp (file)

Method: (setf edges) NEW-VALUE (GRAPH graph)

automatically generated writer method

Source

src.lisp (file)

Generic Function: vertices OBJECT
Generic Function: (setf vertices) NEW-VALUE OBJECT
Package

cl-directed-graph

Methods
Method: vertices (GRAPH graph)

automatically generated reader method

Source

src.lisp (file)

Method: (setf vertices) NEW-VALUE (GRAPH graph)

automatically generated writer method

Source

src.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-directed-graph.asd: The cl-directed-graph<dot>asd file
cl-directed-graph/package.lisp: The cl-directed-graph/package<dot>lisp file
cl-directed-graph/src.lisp: The cl-directed-graph/src<dot>lisp file

F
File, Lisp, cl-directed-graph.asd: The cl-directed-graph<dot>asd file
File, Lisp, cl-directed-graph/package.lisp: The cl-directed-graph/package<dot>lisp file
File, Lisp, cl-directed-graph/src.lisp: The cl-directed-graph/src<dot>lisp file

L
Lisp File, cl-directed-graph.asd: The cl-directed-graph<dot>asd file
Lisp File, cl-directed-graph/package.lisp: The cl-directed-graph/package<dot>lisp file
Lisp File, cl-directed-graph/src.lisp: The cl-directed-graph/src<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   E   F   G   M   N   R   T   V  
Index Entry  Section

(
(setf edges): Internal generic functions
(setf edges): Internal generic functions
(setf vertices): Internal generic functions
(setf vertices): Internal generic functions

A
add-edge: Exported functions
add-vertex: Exported functions
adjacent: Exported functions

E
edges: Internal generic functions
edges: Internal generic functions

F
Function, add-edge: Exported functions
Function, add-vertex: Exported functions
Function, adjacent: Exported functions
Function, make-graph: Exported functions
Function, map-breadth-first: Exported functions
Function, map-depth-first: Exported functions
Function, map-edges: Exported functions
Function, map-vertices: Exported functions
Function, neighbors: Exported functions
Function, remove-edge: Exported functions
Function, remove-vertex: Exported functions

G
Generic Function, (setf edges): Internal generic functions
Generic Function, (setf vertices): Internal generic functions
Generic Function, edges: Internal generic functions
Generic Function, vertices: Internal generic functions

M
Macro, traverse: Internal macros
make-graph: Exported functions
map-breadth-first: Exported functions
map-depth-first: Exported functions
map-edges: Exported functions
map-vertices: Exported functions
Method, (setf edges): Internal generic functions
Method, (setf vertices): Internal generic functions
Method, edges: Internal generic functions
Method, vertices: Internal generic functions

N
neighbors: Exported functions

R
remove-edge: Exported functions
remove-vertex: Exported functions

T
traverse: Internal macros

V
vertices: Internal generic functions
vertices: Internal generic functions

Jump to:   (  
A   E   F   G   M   N   R   T   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   E   S   V  
Index Entry  Section

E
edges: Exported classes

S
Slot, edges: Exported classes
Slot, vertices: Exported classes

V
vertices: Exported classes

Jump to:   E   S   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   G   P   S  
Index Entry  Section

C
cl-directed-graph: The cl-directed-graph system
cl-directed-graph: The cl-directed-graph package
Class, graph: Exported classes

G
graph: Exported classes

P
Package, cl-directed-graph: The cl-directed-graph package

S
System, cl-directed-graph: The cl-directed-graph system

Jump to:   C   G   P   S