autodoc.git/
traditional_manual/
chapter_9.html
Branch:
Tag:
Non-build tags
All tags
No tags
2003-01-03
2003-01-03 18:35:38 by Martin Nilsson <mani@lysator.liu.se>
78c3e237ce6b6b41affe053180532f797d1be036 (
57
lines) (+
57
/-
0
)
[
Show
|
Annotate
]
Branch:
8.0
Added _indices and _values
Rev: lib/modules/ADT.pmod/Struct.pike:1.3
1393:
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>_indices</b></span>
+
</dt>
+
<dd><p><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) <b><span class='method'>indices</span>(</b> <span class='class'>ADT.Struct</span> <span class='argument'>arg</span> <b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>The indices of a struct is the name of the struct items.</p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
<span class='homogen--name'><b>_sizeof</b></span> </dt> <dd><p><code><code class='datatype'>int</code> <b><span class='method'>sizeof</span>(</b> <span class='class'>ADT.Struct</span> <span class='argument'>arg</span> <b>)</b></code></p></dd>
1406:
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>_values</b></span>
+
</dt>
+
<dd><p><code><code class='datatype'>array</code> <b><span class='method'>values</span>(</b> <span class='class'>ADT.Struct</span> <span class='argument'>arg</span> <b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>The values of a struct is the values of the struct items.</p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>`[]</b></span><br>
+
<span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>`-></b></span><br>
+
</dt>
+
<dd><p><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Struct()</code>[ <code class='class'>item</code> ]</code><br>
+
<code><code class='datatype'>mixed</code> res = <code class='class'>ADT.Struct()</code>->X</code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>The struct can be indexed by item name to get the
+
associated value.</p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>`[]=</b></span><br>
+
<span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>`->=</b></span><br>
+
</dt>
+
<dd><p><code><code class='class'>ADT.Struct()</code>[ <code class='class'>item</code> ] = y</code><br>
+
<code><code class='class'>ADT.Struct()</code>->X = y</code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>It is possible to assign a new value to a struct
+
item by indexing it by name and assign a value.</p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
<span class='homogen--name'><b>cast</b></span> </dt> <dd><p><code><b>(</b><span class='datatype'>int</span><b>)</b><span class='class'>ADT.Struct</span>()<br><b>(</b><span class='datatype'>float</span><b>)</b><span class='class'>ADT.Struct</span>()<br><b>(</b><span class='datatype'>string</span><b>)</b><span class='class'>ADT.Struct</span>()<br><b>(</b><span class='datatype'>array</span><b>)</b><span class='class'>ADT.Struct</span>()<br><b>(</b><span class='datatype'>mapping</span><b>)</b><span class='class'>ADT.Struct</span>()<br><b>(</b><span class='datatype'>multiset</span><b>)</b><span class='class'>ADT.Struct</span>()</code></p></dd>