protocol
dictionaryp
¶
Dictionary protocol.
static
Public predicates¶
as_dictionary/2
¶
Converts a list of key-value pairs to a dictionary.
static
as_dictionary(Pairs,Dictionary)
as_dictionary(@list(pairs),-dictionary)
- one
as_list/2
¶
Converts a dictionary to a ordered list of key-value pairs.
static
as_list(Dictionary,Pairs)
as_list(@dictionary,-list(pairs))
- one
clone/3
¶
Clones a dictionary using the same keys but with all values unbound and returning a list of all the pairs in the new clone.
static
clone(Dictionary,Clone,ClonePairs)
clone(+tree,-tree,-list(pairs))
- one
clone/4
¶
Clones a dictionary using the same keys but with all values unbound and returning the list of all pairs in the dictionary and in the clone.
static
clone(Dictionary,Pairs,Clone,ClonePairs)
clone(+tree,-list(pairs),-tree,-list(pairs))
- one
insert/4
¶
Inserts a key-value pair into a dictionary, returning the updated dictionary. When the key already exists, the associated value is updated.
static
insert(OldDictionary,Key,Value,NewDictionary)
insert(+dictionary,+ground,@term,-dictionary)
- one
delete/4
¶
Deletes a matching key-value pair from a dictionary, returning the updated dictionary.
static
delete(OldDictionary,Key,Value,NewDictionary)
delete(+dictionary,@ground,?term,-dictionary)
- zero_or_one
update/4
¶
Updates the value associated with Key in a dictionary, returning the updated dictionary. Fails if it cannot find the key.
static
update(OldDictionary,Key,NewValue,NewDictionary)
update(+dictionary,@ground,+term,-dictionary)
- zero_or_one
update/5
¶
Updates the value associated with a key in a dictionary, returning the updated dictionary. Fails if it cannot find the key or if the existing value does not match the old value.
static
update(OldDictionary,Key,OldValue,NewValue,NewDictionary)
update(+dictionary,@ground,?term,+term,-dictionary)
- zero_or_one
update/3
¶
Updates the key-value pairs in a dictionary, returning the updated dictionary. Fails if it cannot find one of the keys.
static
update(OldDictionary,Pairs,NewDictionary)
update(+dictionary,@list(pair),-dictionary)
- zero_or_one
empty/1
¶
True if the dictionary is empty.
static
empty(Dictionary)
empty(@dictionary)
- zero_or_one
lookup/3
¶
Lookups a matching key-value pair from a dictionary.
static
lookup(Key,Value,Dictionary)
lookup(+ground,?term,@dictionary)
- zero_or_one
lookup(-ground,?term,@dictionary)
- zero_or_more
lookup/2
¶
Lookups all matching key-value pairs from a dictionary. Fails if it cannot find one of the keys or if a value for a key does not unify.
static
lookup(Pairs,Dictionary)
lookup(+list(pair),@dictionary)
- zero_or_one
previous/4
¶
Returns the previous pair in a dictionary given a key.
static
previous(Dictionary,Key,Previous,Value)
previous(+dictionary,+key,-key,-value)
- zero_or_one
next/4
¶
Returns the next pair in a dictionary given a key.
static
next(Dictionary,Key,Next,Value)
next(+dictionary,+key,-key,-value)
- zero_or_one
min/3
¶
Returns the pair with the minimum key in a dictionary. Fails if the dictionary is empty.
static
min(Dictionary,Key,Value)
min(+dictionary,-key,-value)
- zero_or_one
max/3
¶
Returns the pair with the maximum key in a dictionary. Fails if the dictionary is empty.
static
max(Dictionary,Key,Value)
max(+dictionary,-key,-value)
- zero_or_one
delete_min/4
¶
Deletes the pair with the minimum key from a dictionary, returning the deleted pair and the updated dictionary.
static
delete_min(OldDictionary,Key,Value,NewDictionary)
delete_min(+dictionary,-key,-value,-dictionary)
- zero_or_one
delete_max/4
¶
Deletes the pair with the maximum key from a dictionary, returning the deleted pair and the updated dictionary.
static
delete_max(OldDictionary,Key,Value,NewDictionary)
delete_max(+dictionary,-key,-value,-dictionary)
- zero_or_one
keys/2
¶
Returns a list with all the dictionary keys in ascending order.
static
keys(Dictionary,Keys)
keys(@dictionary,-list)
- one
values/2
¶
Returns a list with all the dictionary values in ascending order of the keys.
static
values(Dictionary,Values)
values(@dictionary,-list)
- one
map/2
¶
Maps a closure over each dictionary key-value pair. Fails if the mapped closure attempts to modify the keys.
static
map(Closure,Dictionary)
map(1,*)
map(@callable,+dictionary)
- zero_or_more
map/3
¶
Maps a closure over each dictionary key-value pair, returning the new dictionary. Fails if the mapped closure attempts to modify the keys.
static
map(Closure,OldDictionary,NewDictionary)
map(2,*,*)
map(@callable,+dictionary,-dictionary)
- zero_or_more
apply/4
¶
Applies a closure to a specific key-value pair, returning the new dictionary. Fails if the key cannot be found or if the mapped closure attempts to modify the key.
static
apply(Closure,OldDictionary,Key,NewDictionary)
apply(2,*,*,*)
apply(+callable,+dictionary,+key,-dictionary)
- zero_or_one
Protected predicates¶
(none)
Private predicates¶
(none)