autodoc.git
/
modref
/
ex
/
predef_3A_3A
/
ADT
/
OrderedMapping.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/modref/ex/predef_3A_3A/ADT/OrderedMapping.html:1:
+
<!doctype html>
+
<html>
+
<head>
+
<meta content="width=device-width, initial-scale=1" name="viewport">
+
<meta charset="utf-8">
+
<title>Pike Reference Manual - ADT.OrderedMapping</title>
+
<!-- 221-->
+
<link rel='stylesheet' href='../../../style.css'>
+
<script src='../../../site.js'></script>
+
<script src='../../../constants.js'></script>
+
<script>PikeDoc.NO_DYNAMIC = true;</script>
+
<style type='text/css'>
+
svg line { stroke:#343434; stroke-width:2; }
+
svg text { fill:#343434; }
+
svg a { fill:#0768b2; text-decoration: underline; }
+
</style>
-
+
</head>
+
<body>
+
<header>
+
<div class="header">
+
<div id="version"><strong data-id="version"></strong></div>
+
<div id="burger">☰</div><!-- Hamburger icon -->
+
<h1>
+
<a href="http://pike.lysator.liu.se/" class="logo">
+
<span>Pike programming language</span>
+
</a>
+
</h1>
+
</div>
+
</header>
+
<div id="page">
+
<div class="navbar">
+
<nav>
+
<div class="inner" id="navbar">
+
<a href='../../../index.html'><b class='top head'>Top</b></a>
+
<a href='../../../ex/predef_3A_3A/ADT.html'><b class='head'>ADT</b></a>
+
<b class='selected head'>ADT.OrderedMapping</b>
+
<script></script>
+
<noscript>
+
<div class='sidebar'>
+
<a href='../../../ex/predef_3A_3A/ADT/OrderedMapping/index.html'><b>Symbol index</b></a><br />
+
</div>
+
</noscript>
+
+
</div>
+
</nav>
+
</div>
+
<div class="content">
+
<div class="navbox">
+
<nav>
+
<div class="sidebar">
+
<a href="../../../ex/predef_3A_3A/ADT/List/cast.html" class="prev"><span>➤</span> ADT.List()->cast()</a>
+
<a href="../../../ex/predef_3A_3A/ADT/OrderedMapping/create.html" class="next">ADT.OrderedMapping()->create() <span>➤</span></a>
+
</div>
+
</nav>
+
</div>
+
<div class="contentbox">
+
<article>
+
<h1>Class ADT.OrderedMapping</h1>
+
<dl class='group--doc'>
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>This class works pretty much as a mapping except the order of the indices
+
is kept in the order they are added.</p>
+
</dd>
+
<dt class='head--doc'>Example</dt>
+
<dd class='example'><pre><pre><code>OrderedMapping m1 <span class='delim'>=</span> OrderedMapping<span class='delim'>(</span><span class='string'>"foo"</span><span class='delim'>,</span> 1<span class='delim'>,</span> <span class='string'>"bar"</span><span class='delim'>,</span> 2<span class='delim'>)</span><span class='delim'>;</span>
+
m1->gazonk <span class='delim'>=</span> 3<span class='delim'>;</span>
+
+
<span class='lang'>foreach</span> <span class='delim'>(</span>m1<span class='delim'>;</span> <span class='type'>string</span> key<span class='delim'>;</span> <span class='type'>int</span> val<span class='delim'>)</span> <span class='delim'>{</span>
+
write<span class='delim'>(</span><span class='string'>"# %s: %d\n"</span><span class='delim'>,</span> key<span class='delim'>,</span> val<span class='delim'>)</span><span class='delim'>;</span>
+
<span class='delim'>}</span>
+
+
<span class='comment'>/*
+
output:
+
# foo: 1
+
# bar: 2
+
# gazonk: 3
+
*/</span>
+
+
m_delete<span class='delim'>(</span>m1<span class='delim'>,</span> <span class='string'>"gazonk"</span><span class='delim'>)</span><span class='delim'>;</span>
+
+
m1 += OrderedMapping<span class='delim'>(</span><span class='string'>"afoo"</span><span class='delim'>,</span> 3<span class='delim'>)</span><span class='delim'>;</span>
+
+
<span class='lang'>foreach</span> <span class='delim'>(</span>m1<span class='delim'>;</span> <span class='type'>string</span> key<span class='delim'>;</span> <span class='type'>int</span> val<span class='delim'>)</span> <span class='delim'>{</span>
+
write<span class='delim'>(</span><span class='string'>"# %s: %d\n"</span><span class='delim'>,</span> key<span class='delim'>,</span> val<span class='delim'>)</span><span class='delim'>;</span>
+
<span class='delim'>}</span>
+
+
<span class='comment'>/*
+
output:
+
# foo: 1
+
# bar: 2
+
# afoo: 3
+
*/</span>
+
</code></pre>
+
</pre></dd><dt class='head--fixme'>FIXME</dt>
+
<dd class='body--fixme'><p>Implement subtraction operator</p>
+
</dd></dl>
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>create</b></span>
+
</dt>
+
<dd><p><code><span class='object'>ADT.OrderedMapping</span> <span class='class'>ADT.OrderedMapping</span><b>(</b><code class='datatype'>mixed</code> ... <code class='argument'>args</code><b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Example</dt>
+
<dd class='example'><pre><pre><code><span class='ns'>ADT</span><span class='delim'>.</span>OrderedMapping m1 <span class='delim'>=</span> <span class='ns'>ADT</span><span class='delim'>.</span>OrderedMapping<span class='delim'>(</span><span class='string'>"key1"</span><span class='delim'>,</span> <span class='string'>"val1"</span><span class='delim'>,</span>
+
<span class='string'>"key2"</span><span class='delim'>,</span> <span class='string'>"val2"</span><span class='delim'>)</span><span class='delim'>;</span>
+
</code></pre>
+
</pre></dd>
+
<dt class='head--doc'>Throws</dt>
+
<dd class='body--doc'><p>An error is thrown if the number of arguments isn't even.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-args'></span>Parameter <code class='parameter'>args</code></dt>
+
<dd></dd><dd class='body--doc'><p>Odd arguments are the indices, even arguments the values.
+
<code class='expr'>"index", "value", "index", "value", ... </code></p>
+
</dd></dl>
+
+
</article>
+
</div>
+
</div>
+
</div>
+
<footer>
+
<div id="build-date">Extracted from <strong data-id="version"></strong> as of <strong data-id="date" data-timestamp=""></strong>.</div>
+
</footer>
+
<script>PikeDoc.current = {"link":"ex/predef_3A_3A/ADT/OrderedMapping.html","name":"OrderedMapping"};</script>
+
<script src='../../../ex/predef_3A_3A/ADT/index.js'></script>
+
<script src='../../../ex/predef_3A_3A/ADT/OrderedMapping/load_index.js'></script>
+
<script>
+
// Tell PikeDoc that next actions are from loaded scripts
+
PikeDoc.isInline = false;
+
</script>
+
</body>
+
</html>
Newline at end of file added.