Current section
Files
Jump to
Current section
Files
doc/keys1value.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module keys1value</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module keys1value</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="Keys1Value">Keys1Value</a></h3>
Maintain an associative lookup for a list of keys and 1 value.
<p>Copyright © 2014-2020 Michael Truog</p>
<p><b>Version:</b> 2.0.1 Nov 26 2020 14:52:41
------------------------------------------------------------------------</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="Keys1Value">Keys1Value</a></h3>
Maintain an associative lookup for a list of keys and 1 value.
The supplied data structure module must have dict interface functions
(unless the module is maps).
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-dict_proxy">dict_proxy()</a></h3>
<p><tt>dict_proxy(Key, Value) = <a href="dict.html#type-dict">dict:dict</a>(Key, Value)</tt></p>
<h3 class="typedecl"><a name="type-key">key()</a></h3>
<p><tt>key() = any()</tt></p>
<p> not a list()</p>
<h3 class="typedecl"><a name="type-keys">keys()</a></h3>
<p><tt>keys() = [<a href="#type-key">key()</a>, ...]</tt></p>
<h3 class="typedecl"><a name="type-keys1value">keys1value()</a></h3>
<p><tt>keys1value(Key, Value) = <a href="#type-keys1value_dict">keys1value_dict</a>(Key, Value) | #keys1value{module = module(), lookup = any()}</tt></p>
<h3 class="typedecl"><a name="type-keys1value_dict">keys1value_dict()</a></h3>
<p><tt>keys1value_dict(Key, Value) = {keys1value, dict, <a href="#type-dict_proxy">dict_proxy</a>(Key, {[Key], Value})}</tt></p>
<h3 class="typedecl"><a name="type-value">value()</a></h3>
<p><tt>value() = any()</tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#erase-2">erase/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#fetch-2">fetch/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#find-2">find/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#is_key-2">is_key/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#new-0">new/0</a></td><td></td></tr>
<tr><td valign="top"><a href="#new-1">new/1</a></td><td></td></tr>
<tr><td valign="top"><a href="#store-3">store/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="erase-2">erase/2</a></h3>
<div class="spec">
<p><tt>erase(Key::<a href="#type-key">key()</a>, State::<a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)) -> <a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)</tt><br></p>
</div>
<h3 class="function"><a name="fetch-2">fetch/2</a></h3>
<div class="spec">
<p><tt>fetch(Key::<a href="#type-key">key()</a>, Keys1value::<a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)) -> <a href="#type-value">value()</a></tt><br></p>
</div>
<h3 class="function"><a name="find-2">find/2</a></h3>
<div class="spec">
<p><tt>find(Key::<a href="#type-key">key()</a>, Keys1value::<a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)) -> {ok, <a href="#type-value">value()</a>} | error</tt><br></p>
</div>
<h3 class="function"><a name="is_key-2">is_key/2</a></h3>
<div class="spec">
<p><tt>is_key(Key::<a href="#type-keys">keys()</a> | <a href="#type-key">key()</a>, Keys1value::<a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)) -> boolean()</tt><br></p>
</div>
<h3 class="function"><a name="new-0">new/0</a></h3>
<div class="spec">
<p><tt>new() -> <a href="#type-keys1value_dict">keys1value_dict</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)</tt><br></p>
</div>
<h3 class="function"><a name="new-1">new/1</a></h3>
<div class="spec">
<p><tt>new(Module::module()) -> <a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)</tt><br></p>
</div>
<h3 class="function"><a name="store-3">store/3</a></h3>
<div class="spec">
<p><tt>store(Keys::<a href="#type-keys">keys()</a>, Value::<a href="#type-value">value()</a>, State::<a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)) -> <a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)</tt><br></p>
</div>
<h3 class="function"><a name="to_list-1">to_list/1</a></h3>
<div class="spec">
<p><tt>to_list(Keys1value::<a href="#type-keys1value">keys1value</a>(<a href="#type-key">key()</a>, <a href="#type-value">value()</a>)) -> [{<a href="#type-keys">keys()</a>, <a href="#type-value">value()</a>}]</tt><br></p>
</div>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc</i></p>
</body>
</html>