autodoc.git/ traditional_manual/ chapter_9.html

Branch: Tag:

2002-10-19

2002-10-19 14:21:12 by Martin Nilsson <mani@lysator.liu.se>

Improved some types and doc and added some code form an old source tree of mine. Now supports []=, _indices, _values, set_no_adjacent_duplicates and get_no_adjacent_duplicates.

Rev: lib/modules/ADT.pmod/History.pike:1.6

877:   <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'>int</code>) <b><span class='method'>indices</span>(</b> <span class='class'>ADT.History</span> <span class='argument'>arg</span> <b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Returns the index numbers of the history entries +  available.</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.History</span> <span class='argument'>arg</span> <b>)</b></code></p></dd>
891:   <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.History</span> <span class='argument'>arg</span> <b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Returns the values of the available history entries.</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>   </dt>   <dd><p><code><code class='datatype'>mixed</code> res = <code class='class'>ADT.History()</code>[&#32;<code class='class'>i</code>&#32;]</code></p></dd>
906:   <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>`[]=</b></span> + </dt> + <dd><p><code><code class='class'>ADT.History()</code>[&#32;<code class='class'>i</code>&#32;]&#32;=&#32;<code class='class'>value</code></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Overwrite one value in the history. The history position may be +  identified either by positive or negative offset, like <code>`[]</code>.</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.History</span> <span class='class'>ADT.History</span><b>(</b><code class='datatype'>int</code> <code class='argument'>max_size</code><b>)</b></code></p></dd>
966:      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Returns the maximum number of values in the history</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>set_maxsize</code></p>   </dd></dl>      
984:   <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>query_no_adjacent_duplicates</b></span> + </dt> + <dd><p><code><code class='datatype'>bool</code> <b><span class='method'>query_no_adjacent_duplicates</span>(</b><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Tells if the History object allows adjacent equal +  values. 1 means that only uniqe values are allowed +  adter each other.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>set_no_adjacent_duplicates</code></p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_maxsize</b></span>   </dt>   <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_maxsize</span>(</b><code class='datatype'>int</code> <code class='argument'>_maxsize</code><b>)</b></code></p></dd>
991:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Set the maximume number of entries that can be    stored in the history simultaneous.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>get_maxsize</code></p>   </dd></dl> -  +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>set_no_adjacent_duplicates</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_no_adjacent_duplicates</span>(</b><code class='datatype'>bool</code> <code class='argument'>i</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Change how the History object should treat two +  identical values in a row. If 1 than only unique +  values are allowed after each other.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>query_no_adjacent_duplicates</code></p> + </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>ADT.Priority_queue</b></h2>   </dt><dd>