autodoc.git/ traditional_manual/ chapter_21.html

Branch: Tag:

2019-11-20

2019-11-20 19:13:40 by Henrik Grubbström (Grubba) <grubba@grubba.org>

LFUNs: Added lfun::_reverse().

This is a function that is called by reverse() to generate
a reversed object.

3416:   </dt>   <dd><p><code><code class='datatype'>string</code> <b><span class='method'>reverse</span>(</b><code class='datatype'>string</code> <code class='argument'>s</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code><b>)</b></code><br>   <code><code class='datatype'>array</code> <b><span class='method'>reverse</span>(</b><code class='datatype'>array</code> <code class='argument'>a</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code><b>)</b></code><br> - <code><code class='datatype'>int</code> <b><span class='method'>reverse</span>(</b><code class='datatype'>int</code> <code class='argument'>i</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code><b>)</b></code></p></dd> + <code><code class='datatype'>int</code> <b><span class='method'>reverse</span>(</b><code class='datatype'>int</code> <code class='argument'>i</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>start</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>end</code><b>)</b></code><br> + <code><code class='datatype'>mixed</code> <b><span class='method'>reverse</span>(</b><code class='datatype'>object</code> <code class='argument'>o</code>, <code class='datatype'>mixed</code> ... <code class='argument'>options</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Reverses a string, array or int.</p>
3430:   <dt class='head--doc'><span id='p-i'></span>Parameter <code class='parameter'>i</code></dt>   <dd></dd><dd class='body--doc'><p>Integer to reverse.</p>   </dd> + <dt class='head--doc'><span id='p-o'></span>Parameter <code class='parameter'>o</code></dt> + <dd></dd><dd class='body--doc'><p>Object to reverse.</p> + </dd>   <dt class='head--doc'><span id='p-start'></span>Parameter <code class='parameter'>start</code></dt>   <dd></dd><dd class='body--doc'><p>Optional start index of the range to reverse.    Default: <code class='expr'>0</code> (zero).</p>
3439:    Default for strings: <code class='expr'>sizeof(s)-1</code>.    Default for arrays: <code class='expr'>sizeof(a)-1</code>.    Default for integers: <code class='expr'>Pike.get_runtime_info()-&gt;int_size&nbsp;-&nbsp;1</code>.</p> + </dd> + <dt class='head--doc'><span id='p-options'></span>Parameter <code class='parameter'>options</code></dt> + <dd></dd><dd class='body--doc'><p>Optional arguments that are to be passed to <code>lfun::_reverse()</code>.</p>   <p> This function reverses a string, char by char, an array, value    by value or an int, bit by bit and returns the result. It's not -  destructive on the input value.</p> +  destructive on the input value. For objects it simply calls +  <code>lfun::_reverse()</code> in the object, and returns the result.</p>   <p> Reversing strings can be particularly useful for parsing difficult    syntaxes which require scanning backwards.</p>   </dd>