Package Metabang.Cl-Containers - internal and external symbols

Part of:

asdf-system cl-containers
See only external symbols

A library of container classes and algorithms for Common Lisp.

Package Metabang.Cl-Containers uses the packages Common-Lisp. It is also known as Cl-Containers and Containers. It has 664 total symbols and 242 external ones.

Condition

basic-iterator-condition
container-condition
container-error
element-not-found-error
index-out-of-range-error
key-does-not-exist-error
no-current-element-error
queue-empty
record-not-found-error

Class

abstract-bag/set-container
abstract-container

Inherited by all container classes, this is a good place to
put those pesky superclasses you need...

abstract-generator
abstract-queue
abstract-stack
abstract-tree-container
alist-container
arithmetic-sequence-generator
array-container
array-container-abstract
array-iterator
associative-array
associative-container
associative-container-mixin
bag-container
bag/set-container
basic-filtered-iterator-mixin
basic-generator
basic-initial-contents-mixin
basic-iterator
basic-queue

A simple FIFO queue implemented as a list with extra bookkeeping for efficiency.

basic-stream-iterator
basic-vector-container
biassociative-container-mixin
binary-search-tree
bounded-container-mixin
bounded-vector-container
bst-node
circular-iterator-mixin
classified-container-mixin

A classified container returns some value appropriate to the specific
container class. For exampl...

concrete-container

Inherited by all container classes that can/should
be instantiated using make-container.

container-node-mixin
container-uses-nodes-mixin
contents-as-array-mixin
contents-as-hashtable-mixin
contents-as-list-mixin
contents-as-sequence-mixin
delimited-iterator
dlist-container

A double-linked list

dlist-container-node

A double-linked list node

file-form-iterator
file-iterator
file-line-iterator
filtered-container-mixin
filtered-iterator-mixin
findable-container-mixin
finite-arithmetic-sequence-generator
flexible-vector-container
forward-iterator
four-child-node
hash-table-iterator
heap-container
heap-node
i-know-my-node-mixin
indexed-container-mixin
initial-contents-key-value-mixin
initial-contents-mixin
initial-element-mixin
internal-iterator-mixin
iteratable-container-mixin
k-best-heap-container

Stores the k best values where best is defined by sorter. This
means that the item at the to...

key-value-iteratable-container-mixin
keyed-associative-container
keyed-bag/set-container
keyed-container-mixin
line-iterator
list-container
list-iterator
many-child-node
many-ordered-child-node

A node with many ordered children is a vector

many-unordered-child-node

Children are unordered

non-associative-container-mixin

A non associative container should implement at least empty-p,
empty, insert-item and delete-item...

ordered-container-mixin
package-container
parent-node-mixin

A mixin for nodes with parent pointers

priority-queue-on-container
quad-tree
quad-tree-node
red-black-node
red-black-tree
ring-buffer
rooted-tree-container

Base class of all trees with roots.

searchable-container-mixin
set-container
simple-associative-container
sorted-container-mixin
sorted-dlist-container

A persistently sorted double-linked list

sorted-list-container

A list container that keeps its items sorted as needed. This uses 'sort'
so it best for small con...

sparse-array-container
splay-tree
stable-associative-container
stack-container
test-container-mixin
transforming-iterator-mixin
two-child-node
typed-container-mixin
union-find-container
union-find-node
unique-value-iterator-mixin
unordered-container-mixin
uses-contents-mixin
vector-container
vector-container-mixin
word-iterator

Variable

*current-iteratee*
*rbt-empty-node*
+empty-initial-element+

Constant

+iterator-after-end+
+iterator-before-beginning+
+rbt-color-black+
+rbt-color-red+

Function

%best-helper
%collect-key-value
%container-counts
%every-thing-p
%merge-helper
%search-for-match
%search-in-container
%some-thing-p
%unique-elements
add-initial-contents-internal
associative-container-p

Returns true if the container is associative. Tries to work for native Lisp
containers too.

bound-symbols-in-package
collect-containers
collect-pairs
collect-using

Collects stuff by applying the map-fn to the arguments. Assumes that
the map-fn signature has the...

collect-window-over-elements

Moves a windows of size window-size across the elements of container, stepping by `window-ste...

collect-window-over-nodes

Moves a windows of size window-size across the elements of container, stepping by `window-ste...

collector-internal
count-using

Counts stuff by applying the map-fn to the arguments. Assumes that
the map-fn signature has the f...

descend-ht
determine-generator-class
determine-iterator-class
element-counts
find-or-create-ht
first-item
front-of-queue
front-of-queue!
identity-2
last-item
make-array-container
make-generator
make-ring-buffer
map-containers
map-pairs
map-window-over-elements

Moves a windows of size window-size across the elements of container, stepping by `window-ste...

map-window-over-elements-helper
map-window-over-nodes

Moves a windows of size window-size across the elements of container, stepping by `window-ste...

maybe-set-initial-element
merge-elements
merge-nodes
move-forward-p
node-counts
reduce-internal
resize-vector
return-empty-initial-element
sparse-array-row-major-index
sparse-array-value-to-index
tail-of-queue
tail-of-queue!
tuple-index

Generic-Function

%operate-after-finding
add-default-item
add-initial-contents
advance
append-item

Add an item to the end of an ordered container.

append-new-item

Add an item to the end of an ordered container unless its
already there.

base-class-for-iteratee
best-element
best-node
biggest-item
bst-node-is-left-child

Is this node the left child of its parent?

bst-node-is-right-child

Is this node the right child of its parent?

bst-node-replace-child

Replace the child of this node.

bst-node-set-left-child

Set new-left as the left child of node

bst-node-set-right-child

Set new-right as the right child of node

characterize-element

Examines element in the context of iterator and returns a value describing how to treat it. This ...

children
class-for-contents-as
clean-up
collect-elements

Returns a possibly filtered and possibly transformed list of the elements in a container. If the ...

collect-elements-stably
collect-items
collect-key-value

Iterate over the keys and values of the container and
return a list of the ones that pass the fi...

collect-key-value-stably
collect-keys

Collects the keys of a container into a list.

The filter and transform arguments should be...

collect-nodes

Returns a possibly filtered and possibly transformed list
of the nodes in a container. If the con...

combine-elements
container->list
container-difference
container-dimension
count-elements
count-elements-if
count-items
current-element
current-element-p
current-item
delete-biggest-item
delete-element
delete-first

Removes (and returns) the first item in an ordered
container.
Behavior is undefined if the conta...

delete-item
delete-item-after
delete-item-at
delete-item-before
delete-item-if
delete-last

Removes (and returns) the last item in an ordered
container.
Behavior is undefined if the contai...

delete-list

Deletes each item in the list from the container.

delete-node
dequeue
dimensions
element-passes-p
element-position

Returns the position of element in container using test and
key to match. Key defaults to identit...

empty!

Removes all items from the container and returns nil.

empty-p

Returns t if there are no items in the container.

enqueue
ensure-sorted

This method ensures that the sorted-list-container is sorted,
and then returns the container.

error-if-queue-empty
every-element-p
every-item-p

Returns true if every item in the container satisfies the
predicate. Predicate should be a funct...

every-key-value-p
exchange-heap-nodes
find-child-node
find-element

For now, compare find-item.

find-item

Find item in container using the container's test
method for comparisons. The test method must ta...

find-node

Find node containing thing in container using the container's test
method for comparisons. The te...

find-set
find-successor-item
find-successor-node
find-value
finish

Tell Lisp that you are done with this iterator. Further calls to current-element, etc. will have ...

first-element
first-node
force-sort

This method forces a sort on the next pertinent access of
the container.

graft-nodes
has-children-p
heap-node-parent
heapify
height
increment-end
initialize-container
inorder-walk
inorder-walk-nodes
insert-initial-contents-p

Returns true if this container type should rely on the default behavior of basic-initial-contents...

insert-item

Adds item to the container

insert-item-after
insert-item-at

Inserts item at the specified index, increasing the index of all following elements

insert-item-before
insert-item-ordered
insert-item-ordered-about-node
insert-list

Adds each item in the list to the container in an
upspecified order.

insert-new-item

Adds item to the container unless it is already there

insert-sequence

Adds each item in the sequence to the container in an
upspecified order.

item-at

Returns the item specified by the indexes.

item-at!

[Destructively] modifies the item specified by the
indexes to the value.

item-at-1
item-at-1!
item-key
iteratable-p

Returns true if thing knows how to iterate-nodes.

iterate-children

Calls fn on every child of node.

iterate-container
iterate-elements
iterate-elements-stably
iterate-forward
iterate-key-value
iterate-key-value-stably
iterate-keys
iterate-left
iterate-left-nodes
iterate-nodes

Applies function to each node in the container. If the container doesn't have nodes, then this is...

iterate-nodes-about-node
iterate-right
iterate-right-nodes
key-exists-p
key-value-iteratable-p

Returns true if thing knows how to iterate-nodes.

l-child
l-child-index
last-element
last-node
left-and-right-nodes-for-item
left-node-for-item
link-nodes
make-container

Creates a new container of type class using the additional
arguments (args).

make-container-for-contents

Creates a sub-container to be used as contents for a
super-container.

make-initial-element
make-internal-iterator
make-iterator
make-node-for-container
make-set
move
move-forward
move-forward-to-next-element
move-internal
move-p
next-item
node-empty-p
node-parent-index
notify-element-of-child-status

This is called to allow the element to know its
status as a child. Useful for quad tree elements,...

nth-element

Returns the nth element in the container's 'natural' order.

open-file-for-iterator
pop-item
postorder-walk
postorder-walk-nodes
predecessor

Return the item that comes before item in the container. Only makes sense for sorted containers...

preorder-walk
preorder-walk-nodes
print-container

Prints the contents of container (using PRINT). Returns the container.

print-container-summary
print-iterator
push-item
r-child
r-child-index
rb-delete-fixup
reduce-container
reduce-elements
reduce-nodes
remove-items-if

Removes items from a container that satisfy the test. The
container is returned.

replace-item
representative
representative-node
reset
reverse-container

Destructively alters the elements/nodes of an ordered container so that they are reversed.

reverse-find

Finds the key in the associative-container whose
value is VALUE.

right-most-child

Walk down the right side of the tree until a leaf node is
found, then return that node

right-node-for-item
rotate-left
rotate-right
search-for-element
search-for-item

Hunt for the item in the container. Key and Test
are as in member.

search-for-key
search-for-match

Hunt for an item in the container that satisfies
the predicate. Key is as in count-if.

search-for-matching-node
search-for-node
search-for-node*
set-dirty-flag
setup-initial-container
some-element-p
some-item-p

Returns the first item in the container for which predicate
holds. Predicate should be a function...

some-key-value-p
sort-container
sort-elements
sort-keys
sort-update-left
sort-update-right
splay-tree-rotate

rotate the node (and maybe the parent) until the node is
the root of the tree

splay-tree-splay

Preform the splay operation on the tree about this node
rotating the node until it becomes the ro...

successor

Return the item that comes after item in the container. Only makes sense for sorted containers. R...

unique-elements
unique-nodes
update-element
update-item
walk-tree
walk-tree-nodes
weight

Returns the weight of an edge. This defaults to 1.0
and can only be altered if the edge is a sub-...

Macro

with-iterator