KeyedDictionary(Key, Entry)

aggcat.spad line 726 [edit on github]

A keyed dictionary is a dictionary of key-entry pairs for which there is a unique entry for each key.

# : % -> NonNegativeInteger if % has finiteAggregate
from Aggregate
= : (%, %) -> Boolean if Record(key : Key, entry : Entry) has SetCategory or Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from BasicType
any? : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> Boolean if % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
coerce : % -> OutputForm if Record(key : Key, entry : Entry) has CoercibleTo(OutputForm)
from CoercibleTo(OutputForm)
construct : List(Record(key : Key, entry : Entry)) -> %
from Collection(Record(key : Key, entry : Entry))
convert : % -> InputForm if Record(key : Key, entry : Entry) has ConvertibleTo(InputForm)
from ConvertibleTo(InputForm)
copy : % -> %
from Aggregate
count : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> NonNegativeInteger if % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
count : (Record(key : Key, entry : Entry), %) -> NonNegativeInteger if Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
dictionary : () -> %
from DictionaryOperations(Record(key : Key, entry : Entry))
dictionary : List(Record(key : Key, entry : Entry)) -> %
from DictionaryOperations(Record(key : Key, entry : Entry))
empty : () -> %
from Aggregate
empty? : % -> Boolean
from Aggregate
eq? : (%, %) -> Boolean
from Aggregate
eval : (%, Equation(Record(key : Key, entry : Entry))) -> % if Record(key : Key, entry : Entry) has Evalable(Record(key : Key, entry : Entry)) and Record(key : Key, entry : Entry) has SetCategory
from Evalable(Record(key : Key, entry : Entry))
eval : (%, List(Equation(Record(key : Key, entry : Entry)))) -> % if Record(key : Key, entry : Entry) has Evalable(Record(key : Key, entry : Entry)) and Record(key : Key, entry : Entry) has SetCategory
from Evalable(Record(key : Key, entry : Entry))
eval : (%, List(Record(key : Key, entry : Entry)), List(Record(key : Key, entry : Entry))) -> % if Record(key : Key, entry : Entry) has Evalable(Record(key : Key, entry : Entry)) and Record(key : Key, entry : Entry) has SetCategory
from InnerEvalable(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry))
eval : (%, Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)) -> % if Record(key : Key, entry : Entry) has Evalable(Record(key : Key, entry : Entry)) and Record(key : Key, entry : Entry) has SetCategory
from InnerEvalable(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry))
every? : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> Boolean if % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
extract! : % -> Record(key : Key, entry : Entry)
from BagAggregate(Record(key : Key, entry : Entry))
find : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> Union(Record(key : Key, entry : Entry), "failed")
from Collection(Record(key : Key, entry : Entry))
insert! : (Record(key : Key, entry : Entry), %) -> %
from BagAggregate(Record(key : Key, entry : Entry))
inspect : % -> Record(key : Key, entry : Entry)
from BagAggregate(Record(key : Key, entry : Entry))
key? : (Key, %) -> Boolean

key?(k, t) tests if k is a key in table t.

keys : % -> List(Key)

keys(t) returns the list of keys in table t.

latex : % -> String if Record(key : Key, entry : Entry) has SetCategory
from SetCategory
less? : (%, NonNegativeInteger) -> Boolean
from Aggregate
map : (Mapping(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)), %) -> %
from HomogeneousAggregate(Record(key : Key, entry : Entry))
map! : (Mapping(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)), %) -> %
from HomogeneousAggregate(Record(key : Key, entry : Entry))
max : % -> Record(key : Key, entry : Entry) if Record(key : Key, entry : Entry) has OrderedSet and % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
max : (Mapping(Boolean, Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)), %) -> Record(key : Key, entry : Entry) if % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
member? : (Record(key : Key, entry : Entry), %) -> Boolean if Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
members : % -> List(Record(key : Key, entry : Entry)) if % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
min : % -> Record(key : Key, entry : Entry) if Record(key : Key, entry : Entry) has OrderedSet and % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
more? : (%, NonNegativeInteger) -> Boolean
from Aggregate
parts : % -> List(Record(key : Key, entry : Entry)) if % has finiteAggregate
from HomogeneousAggregate(Record(key : Key, entry : Entry))
reduce : (Mapping(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)), %) -> Record(key : Key, entry : Entry) if % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
reduce : (Mapping(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)), %, Record(key : Key, entry : Entry)) -> Record(key : Key, entry : Entry) if % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
reduce : (Mapping(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)), %, Record(key : Key, entry : Entry), Record(key : Key, entry : Entry)) -> Record(key : Key, entry : Entry) if Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
remove : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> % if % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
remove : (Record(key : Key, entry : Entry), %) -> % if Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
remove! : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> % if % has finiteAggregate
from DictionaryOperations(Record(key : Key, entry : Entry))
remove! : (Record(key : Key, entry : Entry), %) -> % if Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from DictionaryOperations(Record(key : Key, entry : Entry))
remove! : (Key, %) -> Union(Entry, "failed")

remove!(k, t) searches the table t for the key k removing (and return) the entry if there. If t has no such key, remove!(k,t) returns "failed".

removeDuplicates : % -> % if Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
sample : () -> %
from Aggregate
search : (Key, %) -> Union(Entry, "failed")

search(k, t) searches the table t for the key k, returning the entry stored in t for key k. If t has no such key, search(k,t) returns "failed".

select : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> % if % has finiteAggregate
from Collection(Record(key : Key, entry : Entry))
select! : (Mapping(Boolean, Record(key : Key, entry : Entry)), %) -> % if % has finiteAggregate
from DictionaryOperations(Record(key : Key, entry : Entry))
size? : (%, NonNegativeInteger) -> Boolean
from Aggregate
~= : (%, %) -> Boolean if Record(key : Key, entry : Entry) has SetCategory or Record(key : Key, entry : Entry) has BasicType and % has finiteAggregate
from BasicType

Collection(Record(key : Key, entry : Entry))

Dictionary(Record(key : Key, entry : Entry))

InnerEvalable(Record(key : Key, entry : Entry), Record(key : Key, entry : Entry))

Evalable(Record(key : Key, entry : Entry))

HomogeneousAggregate(Record(key : Key, entry : Entry))

DictionaryOperations(Record(key : Key, entry : Entry))

BasicType

shallowlyMutable

SetCategory

BagAggregate(Record(key : Key, entry : Entry))

CoercibleTo(OutputForm)

Aggregate

ConvertibleTo(InputForm)