Package Fset [Tinaa]

Package Fset - external symbols

Part of:

Package Fset uses the packages Common-Lisp, Gmap, Lexical-Contexts and New-Let. It has 1390 total symbols and 132 external ones.

Class

bag	The abstract class for FSet functional bags (multisets). It is a structure class.
bounded-set	A “bounded set” is a subset (not necessarily proper) of a specified set, called the “universe”. ...
collection	The root class of the FSet functional collections hierarchy. It is a structure class.
dyn-tuple	A class of functional tuples represented as vectors with dynamically- reordered key vectors. Thi...
identity-ordering-mixin	A mixin class for classes whose instances will be used in FSet collections, and for which the app...
map	The abstract class for FSet functional maps. It is a structure class.
relation	The abstract class for FSet relations. It is a structure class.
seq	The abstract class for FSet functional seqs (sequences, but we use the short name to avoid confus...
set	The abstract class for FSet functional sets. It is a structure class.
tuple	The abstract class for FSet functional tuples. It is a structure class.
wb-bag	A class of functional bags (multisets) represented as weight-balanced binary trees. This is the ...
wb-map	A class of functional maps represented as weight-balanced binary trees. This is the default impl...
wb-seq	A class of functional seqs (sequences, but we use the short name to avoid confusion with `cl:sequ...`
wb-set	A class of functional sets represented as weight-balanced binary trees. This is the default impl...

Variable

fset-readtable	A copy of the standard readtable with FSet reader macros installed.

Function

bag?
bounded-set-contents
collection?
empty-bag	Returns an empty bag of the default implementation.
empty-dyn-tuple	Returns an empty dyn-tuple.
empty-map	Returns an empty map of the default implementation.
empty-seq	Returns an empty seq of the default implementation.
empty-set	Returns an empty set of the default implementation.
empty-tuple	Returns an empty tuple of the default implementation.
empty-wb-bag	Returns an empty wb-bag.
empty-wb-map	Returns an empty wb-map.
empty-wb-seq	Returns an empty wb-seq.
empty-wb-set	Returns an empty wb-set.
equal?
fset-setup-readtable	Adds FSet reader macros to `readtable`. Returns `readtable`.
get-tuple-key	Finds or creates a tuple key named `name`. If the key did not already exist, and `default-fn` is...
head	Another name for the `car` operation on lists.
lastcons	Returns the last cons of `list`. This is a renaming of the CL function `last`.
make-bounded-set
map-default
map?
nonempty?	Returns true iff the collection is not empty.
seq?
set?
tail	Another name for the `cdr` operation on lists.
tuple?

Generic-Function

arb	Returns an arbitrary member or pair of a set, bag, or map. Specifically, on a nonempty set, retu...
bag-difference	Returns a bag whose multiplicity, for any value, is its multiplicity in `bag1` less that in `bag2...`
bag-product	Returns a bag whose multiplicity, for any value, is the product of its multiplicities in the two ...
bag-sum	Returns a bag whose multiplicity, for any value, is the sum of its multiplicities in the two argu...
compare	Returns one of `:less`, `:greater`, `:equal`, or `:unequal` according as `x` is less than, greate...
complement	Returns the complement of the set.
compose	Returns a new map with the same domain as `map1`, which maps each member of that domain to the re...
concat	Returns the concatenation of `seq1` and `seq2`.
conflicts	Returns a 2-relation containing only those pairs of `2-relation` whose domain value is mapped to ...
contains?	Returns true iff the set or bag contains `x`.
convert	Converts the collection to the specified type. Some methods may take additional keyword argument...
count	If `collection` is a Lisp sequence, this simply calls `cl:count`. On an FSet collection, the def...
count-if	If `collection` is a Lisp sequence, this simply calls `cl:count-if`. On an FSet collection, the ...
count-if-not	If `collection` is a Lisp sequence, this simply calls `cl:count-if-not`. On an FSet collection, t...
disjoint?	Returns true iff `set1` and `set2` have a null intersection (without actually constructing said i...
domain	Returns the domain of the map, that is, the set of keys mapped by the map.
empty?	Returns true iff the collection is empty.
filter	Returns a new collection containing those members or pairs of `collection` for which `fn` returns...
find	If `collection` is a Lisp sequence, this simply calls `cl:find`. On an FSet collection, the defa...
find-if	If `collection` is a Lisp sequence, this simply calls `cl:find-if`. On an FSet collection, the `...`
find-if-not	If `collection` is a Lisp sequence, this simply calls `cl:find-if-not`. On an FSet collection, th...
first	Returns the first element of `seq`, i.e., element 0. This has a back- compatibility method for l...
greatest	On a set, returns two values: the greatest member of the set and true; on a bag, returns three va...
image	Returns a new collection containing the result of applying `fn` to each member of `collection`, w...
insert	Returns a new sequence like `seq` but with `val` inserted at `idx` (the seq is extended in either...
intersection	Returns the intersection of the two sets/bags. The result is a bag if both arguments are bags; o...
inverse	The inverse of a binary relation.
iterator	Returns an iterator for the collection. (These are stateful iterators and are not thread-safe; i...
join	A relational equijoin, matching up `column-a` of `relation-a` with `column-b` of `relation-b`. F...
last	Returns the last element of `seq`, i.e., element `(1- (size seq))`. This has methods for CL list...
least	On a set, returns two values: the smallest member of the set and true; on a bag, returns three va...
less	On a set, removes `value1` from it if present, returning the updated set. On a bag, removes `valu...`
less-first	Returns the subsequence of `seq` from element 1 through the end.
less-last	Returns the subsequence of `seq` from element 0 through the next-to-last element.
lookup	If `collection` is a map, returns the value to which `key` is mapped. If `collection` is a seq, t...
lookup-inv	Does an inverse lookup on a binary relation.
map-difference-2	Returns, as two values: a map containing all the pairs that are in `map1` but not `map2`, with th...
map-intersection	Returns a map containing all the keys that are in the domains of both `map1` and `map2`, where th...
map-union	Returns a map containing all the keys of `map1` and `map2`, where the value for each key containe...
multiplicity	Returns the multiplicity of `x` in the bag.
position	If `collection` is a Lisp sequence, this simply calls `cl:position`. On an FSet seq, the default...
position-if	If `collection` is a Lisp sequence, this simply calls `cl:position-if`. Also works on an FSet seq...
position-if-not	If `collection` is a Lisp sequence, this simply calls `cl:position-if-not`. Also works on an FSet...
range	Returns the range of the map, that is, the set of all values to which keys are mapped by the map.
reduce	If `collection` is a Lisp sequence, this simply calls `cl:reduce` (q.v.). On an FSet collection, ...
remove	If `collection` is a Lisp sequence, this simply calls `cl:remove`. On an FSet seq, the default f...
remove-if	If `collection` is a Lisp sequence, this simply calls `cl:remove-if`. Also works on an FSet seq; ...
remove-if-not	If `collection` is a Lisp sequence, this simply calls `cl:remove-if-not`. Also works on an FSet s...
restrict	Returns a map containing only those pairs of `map` whose keys are also in `set`.
restrict-not	Returns a map containing only those pairs of `map` whose keys are not in `set`.
reverse	Returns `seq` in reverse order.
set-difference	Returns the set difference of set1 and set2, i.e., the set containing every member of `set1` that...
set-difference-2	Returns `set1 - set2` and `set2 - set1` as two values.
size	Returns the number of members in a set, seq, or bag, or the number of pairs in a map. The size o...
sort	Returns `seq` sorted by `pred`, a function of two arguments; if `key` is supplied, it is a functi...
stable-sort	Returns `seq` sorted by `pred`, a function of two arguments; if `key` is supplied, it is a functi...
subbag?	Returns true iff `sub` is a subbag of `super`, that is, for every member of `sub`, `super` contai...
subseq	Returns the subsequence of `seq` from `start` (inclusive) to `end` (exclusive), where `end` defau...
subset?	Returns true iff `sub` is a subset of `super`.
substitute	If `collection` is a Lisp sequence, this simply calls `cl:substitute`. On an FSet seq, the defau...
substitute-if	If `collection` is a Lisp sequence, this simply calls `cl:substitute-if`. Also works on an FSet s...
substitute-if-not	If `collection` is a Lisp sequence, this simply calls `cl:substitute-if-not`. Also works on an FS...
tuple-merge	Returns a new tuple containing all the keys of `tuple1` and `tuple2`, where the value for each ke...
union	Returns the union of the two sets/bags. The result is a set if both arguments are sets; otherwis...
with	On a set, adds `value1` to it, returning the updated set. On a bag, adds `value2` occurrences of...
with-default	Returns a new map or seq with the same contents as `collection` but whose default is now `new-def...`
with-first	Returns `seq` with `val` prepended, that is, `val` is element 0 of the result, and the elements o...
with-last	Returns `seq` with `val` appended, that is, `val` is element `(size seq)` of the result.

Macro

@	A little hack with two purposes: (1) to make it easy to make FSet maps behave like Lisp functions...
adjoinf	(adjoinf coll . args) --> (setf coll (with coll . args))
bag	Constructs a bag of the default implementation according to the supplied argument subforms. Each...
compare-slots	A handy macro for writing the bodies of `compare` methods for user classes. Returns the result of...
def-tuple-key	Defines a tuple key named `name`. If `default-fn` is supplied, it is used to compute a value for...
define-cross-type-compare-methods	Generates cross-type comparison methods for `type` against the types on which the macro has previ...
do-bag	For each member of `bag`, binds `value-var` to it and and executes `body` a number of times equal...
do-bag-pairs	For each member of `bag`, binds `value-var` and `mult-var` to the member and its multiplicity res...
do-map	For each pair of `map`, binds `key-var` and `value-var` and executes `body`. When done, returns `...`
do-seq	For each element of `seq`, possibly restricted by `start` and `end`, and in reverse order if `fro...`
do-set	For each member of `set`, binds `var` to it and executes `body`. When done, returns `value`.
do-tuple	For each pair of `tuple`, binds `key-var` and `value-var` and executes `body`. When done, returns...
dyn-tuple	Constructs a dyn-tuple according to the supplied argument subforms. Each argument subform can be...
map	Constructs a map of the default implementation according to the supplied argument subforms. Each...
pop-first	Removes the first element from `seq` and returns it.
pop-last	Removes the last element from `seq` and returns it.
push-first	(push-first seq val) --> (setf seq (with-first seq val))
push-last	(push-last seq val) --> (setf seq (with-last seq val))
removef	(removef coll . args) --> (setf coll (less coll . args))
seq	Constructs a seq of the default implementation according to the supplied argument subforms. Each...
set	Constructs a set of the default implementation according to the supplied argument subforms. Each...
tuple	Constructs a tuple of the default implementation according to the supplied argument subforms. Ea...
unionf
wb-bag	Constructs a wb-bag according to the supplied argument subforms. Each argument subform can be an...
wb-map	Constructs a wb-map according to the supplied argument subforms. Each argument subform can be a ...
wb-seq	Constructs a wb-seq according to the supplied argument subforms. Each argument subform can be an...
wb-set	Constructs a wb-set according to the supplied argument subforms. Each argument subform can be an...