dict

19962016 Ericsson AB. All Rights Reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. dict Robert Virding 1997-01-15 B

dict Key-value dictionary.

This module provides a Key-Value dictionary. The representation of a dictionary is not defined.

This module provides the same interface as the orddict(3) module. One difference is that while this module considers two keys as different if they do not match (=:=), orddict considers two keys as different if and only if they do not compare equal (==).

Dictionary as returned by new/0.

Append a value to keys in a dictionary.

Appends a new Value to the current list of values associated with Key.

See also section Notes.

Append new values to keys in a dictionary.

Appends a list of values ValList to the current list of values associated with Key. An exception is generated if the initial value associated with Key is not a list of values.

See also section Notes.

Erase a key from a dictionary.

Erases all items with a given key from a dictionary.

Look up values in a dictionary.

Returns the value associated with Key in dictionary Dict. This function assumes that Key is present in dictionary Dict, and an exception is generated if Key is not in the dictionary.

See also section Notes.

Return all keys in a dictionary.

Returns a list of all keys in dictionary Dict.

Return value and new dictionary without element with this value.

This function returns value from dictionary and a new dictionary without this value. Returns error if the key is not present in the dictionary.

Select elements that satisfy a predicate.

Dict2 is a dictionary of all keys and values in Dict1 for which Pred(Key, Value) is true.

Search for a key in a dictionary.

Searches for a key in dictionary Dict. Returns {ok, Value}, where Value is the value associated with Key, or error if the key is not present in the dictionary.

See also section Notes.

Fold a function over a dictionary.

Calls Fun on successive keys and values of dictionary Dict together with an extra argument Acc (short for accumulator). Fun must return a new accumulator that is passed to the next call. Acc0 is returned if the dictionary is empty. The evaluation order is undefined.

Convert a list of pairs to a dictionary.

Converts the Key-Value list List to dictionary Dict.

Return true if the dictionary is empty.

Returns true if dictionary Dict has no elements, otherwise false.

Test if a key is in a dictionary.

Tests if Key is contained in dictionary Dict.

Map a function over a dictionary.

Calls Fun on successive keys and values of dictionary Dict1 to return a new value for each key. The evaluation order is undefined.

Merge two dictionaries.

Merges two dictionaries, Dict1 and Dict2, to create a new dictionary. All the Key-Value pairs from both dictionaries are included in the new dictionary. If a key occurs in both dictionaries, Fun is called with the key and both values to return a new value. merge can be defined as follows, but is faster:


merge(Fun, D1, D2) ->
    fold(fun (K, V1, D) ->
                 update(K, fun (V2) -> Fun(K, V1, V2) end, V1, D)
         end, D2, D1).

Create a dictionary.

Creates a new dictionary.

Return the number of elements in a dictionary.

Returns the number of elements in dictionary Dict.

Store a value in a dictionary.

Stores a Key-Value pair in dictionary Dict2. If Key already exists in Dict1, the associated value is replaced by Value.

Convert a dictionary to a list of pairs.

Converts dictionary Dict to a list representation.

Update a value in a dictionary.

Updates a value in a dictionary by calling Fun on the value to get a new value. An exception is generated if Key is not present in the dictionary.

Update a value in a dictionary.

Updates a value in a dictionary by calling Fun on the value to get a new value. If Key is not present in the dictionary, Initial is stored as the first value. For example, append/3 can be defined as:


append(Key, Val, D) ->
    update(Key, fun (Old) -> Old ++ [Val] end, [Val], D).

Increment a value in a dictionary.

Adds Increment to the value associated with Key and stores this value. If Key is not present in the dictionary, Increment is stored as the first value.

This can be defined as follows, but is faster:


update_counter(Key, Incr, D) ->
    update(Key, fun (Old) -> Old + Incr end, Incr, D).

Notes

Functions append and append_list are included so that keyed values can be stored in a list accumulator, for example:

> D0 = dict:new(),
  D1 = dict:store(files, [], D0),
  D2 = dict:append(files, f1, D1),
  D3 = dict:append(files, f2, D2),
  D4 = dict:append(files, f3, D3),
  dict:fetch(files, D4).
[f1,f2,f3]

This saves the trouble of first fetching a keyed value, appending a new value to the list of stored values, and storing the result.

Function fetch is to be used if the key is known to be in the dictionary, otherwise function find.