# walkmap.superstructure documentation

## Generated by Codox

# Walkmap 0.1.0-SNAPSHOT

# walkmap.superstructure

single indexing structure for walkmap objects

### add-to-superstructure

`(add-to-superstructure o)``(add-to-superstructure s o)`

Return a superstructure like `s` with object `o` added. If `o` is a collection, return a superstructure like `s` with each element of `o` added. If only one argument is supplied it will be assumed to represent `o` and a new superstructure will be returned.

It is an error (and an exception may be thrown) if

1. `s` is not a map;
2. `o` is not a map, or a sequence of maps.

view source

### index-vertex

`(index-vertex s o v)`

Return a superstructure like `s` in which object `o` is indexed by vertex `v`. It is an error (and an exception may be thrown) if

1. `s` is not a map;
2. `o` is not a map;
3. `o` does not have a value for the key `:id`;
4. `v` is not a vertex.

view source

### index-vertices

`(index-vertices s o)`

Return a superstructure like `s` in which object `o` is indexed by its vertices. It is an error (and an exception may be thrown) if

1. `s` is not a map;
2. `o` is not a map;
3. `o` does not have a value for the key `:id`.

view source