autodoc.git / traditional_manual / chapter_21.html

version» Context lines:

autodoc.git/traditional_manual/chapter_21.html:22813:   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>Getopt.get_args()</code>, <code>Getopt.find_option()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>find_option</b></span>   </dt> - <dd><p><code><code class='datatype'>string</code>|<code class='datatype'>bool</code> <b><span class='method'>find_option</span>(</b><code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>argv</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code> <code class='argument'>shortform</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>longform</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>envvars</code>, <code class='datatype'>string</code>|<code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>def</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>throw_errors</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>void</code>|<code class='datatype'>string</code>|<code class='datatype'>bool</code> <b><span class='method'>find_option</span>(</b><code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>argv</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code> <code class='argument'>shortform</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>longform</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>envvars</code>, <code class='datatype'>string</code>|<code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>def</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>throw_errors</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>This is a generic function to parse command line options of the    type <tt>-f</tt>, <tt>--foo</tt> or <tt>--foo=bar</tt>.</p>   </dd>   <dt class='head--doc'><span id='p-argv'></span>Parameter <code class='parameter'>argv</code></dt>   <dd></dd><dd class='body--doc'><p>The first argument should be the array of strings that was sent as    the second argument to your <code class='expr'>main()</code> function.</p>   </dd>   <dt class='head--doc'><span id='p-shortform'></span>Parameter <code class='parameter'>shortform</code></dt>
autodoc.git/traditional_manual/chapter_21.html:58567:   </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Val.Null</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Type for the <code>Val.null</code> object. Do not create more instances of    this - use <code>Val.null</code> instead.</p>   </dd></dl></dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Val.Range</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Generic lightweight range type. Supports any values for lower -  and upper boundaries that implement the <code class='expr'>`&lt;</code> lfun.</p> +  and upper boundaries that implement <code>lfun::`&lt;()</code> and <code>lfun::`</code>()], +  and preferrably also cast to <code class='expr'>int</code> and <code class='expr'>string</code>.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>Can only contain a single contiguous range.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>The empty range must be stored as <code class='expr'>(Math.inf,&nbsp;-Math.inf)</code>    if assigned directly to <code>from</code> and <code>till</code>.</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'>bool</code> res = !<code class='class'>Val.Range()</code></code></p></dd>      <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><p>True if range is empty.</p> -  + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>isempty()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>`&amp;</b></span>   </dt>   <dd><p><code><code class='datatype'>bool</code> res = <code class='class'>Val.Range()</code>&#32;&amp;&#32;<code class='class'>that</code></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Overlap: have points in common.</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'>Val.Range()</code>&#32;*&#32;<code class='class'>that</code></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> res = <code class='class'>Val.Range()</code>&#32;*&#32;<code class='class'>that</code></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Intersection</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'>Val.Range()</code>&#32;+&#32;<code class='class'>that</code></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> res = <code class='class'>Val.Range()</code>&#32;+&#32;<code class='class'>that</code></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Union</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'>Val.Range()</code>&#32;-&#32;<code class='class'>that</code></code></p></dd> + <dd><p><code><code class='object unresolved'>this_program</code> res = <code class='class'>Val.Range()</code>&#32;-&#32;<code class='class'>that</code></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Difference</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>`&lt;&lt;</b></span>
autodoc.git/traditional_manual/chapter_21.html:58670:      <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'>bool</code> res = <code class='class'>Val.Range()</code>&#32;|&#32;<code class='class'>that</code></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Is adjacent to</p> + </dd><dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>This does NOT seem like a good operator for this operation.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>contains</b></span>   </dt> - <dd><p><code><code class='datatype'>bool</code> <b><span class='method'>contains</span>(</b><code class='datatype'>mixed</code> <code class='argument'>other</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>bool</code> <b><span class='method'>contains</span>(</b><code class='object unresolved'>this_program</code>|<code class='object unresolved'>value_type</code> <code class='argument'>other</code><b>)</b></code></p></dd>      <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><p>True if this range fully contains another range or element.</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'>Val.Range</span> <span class='class'>Val.Range</span><b>(</b><code class='datatype'>mixed</code> <code class='argument'>from</code>, <code class='datatype'>mixed</code> <code class='argument'>till</code><b>)</b></code><br> + <dd><p><code><span class='object'>Val.Range</span> <span class='class'>Val.Range</span><b>(</b><code class='object unresolved'>value_type</code> <code class='argument'>from</code>, <code class='object unresolved'>value_type</code> <code class='argument'>till</code><b>)</b></code><br>   <code><span class='object'>Val.Range</span> <span class='class'>Val.Range</span><b>(</b><code class='object unresolved'>this_program</code> <code class='argument'>copy</code><b>)</b></code><br>   <code><span class='object'>Val.Range</span> <span class='class'>Val.Range</span><b>(</b><b>)</b></code></p></dd>      <dt class='head--doc'><span id='p-from'></span>Parameter <code class='parameter'>from</code></dt>   <dd></dd><dd class='body--doc'><p>Lower inclusive boundary for the range. Specify no lower-boundary    by filling in <code class='expr'>-Math.inf</code>.</p>   </dd>   <dt class='head--doc'><span id='p-till'></span>Parameter <code class='parameter'>till</code></dt>   <dd></dd><dd class='body--doc'><p>Upper exclusive boundary for the range. Specify no upper-boundary    by filling in <code class='expr'>Math.inf</code>.</p>
autodoc.git/traditional_manual/chapter_21.html:58712:   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>Math.inf</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Variable</span>   <span class='homogen--name'><b>from</b></span>   </dt> - <dd><p><code><code class='datatype'>mixed</code> Val.Range.<b><span class='variable'>from</span></b></code></p></dd> + <dd><p><code><code class='object unresolved'>value_type</code> Val.Range.<b><span class='variable'>from</span></b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>The lower inclusive boundary.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>interval</b></span>
autodoc.git/traditional_manual/chapter_21.html:58741:      <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>isempty</b></span>   </dt>   <dd><p><code><code class='modifier'>local</code> <code class='datatype'>bool</code> <b><span class='method'>isempty</span>(</b><b>)</b></code></p></dd>      <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><p>True if range is empty.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><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>merge</b></span>   </dt>   <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>merge</span>(</b><code class='object unresolved'>this_program</code> ... <code class='argument'>other</code><b>)</b></code></p></dd>      <dt class='head--doc'><span id='p-other'></span>Parameter <code class='parameter'>other</code></dt>   <dd></dd><dd class='body--doc'><p>Extends the current range to the smallest range which encompasses    itself and all other given ranges.</p> -  + </dd><dt class='head--fixme'>FIXME</dt> + <dd class='body--fixme'><p>This seems like the operation that <code class='expr'>`|()</code> ought to do.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>sql</b></span>   </dt>   <dd><p><code><code class='modifier'>final</code> <code class='datatype'>string</code> <b><span class='method'>sql</span>(</b><b>)</b></code></p></dd>      <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><p>A string representing the range using SQL-compliant syntax.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Variable</span>   <span class='homogen--name'><b>till</b></span>   </dt> - <dd><p><code><code class='datatype'>mixed</code> Val.Range.<b><span class='variable'>till</span></b></code></p></dd> + <dd><p><code><code class='object unresolved'>value_type</code> Val.Range.<b><span class='variable'>till</span></b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>The upper exclusive boundary.</p>   </dd></dl>   </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Val.Time</b></h2>   </dt><dd><dl class='group--doc'>   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Lightweight time type. Stores absolute times in a day    with nanosecond resolution. Normalised value range is between    <code class='expr'>00:00:00.000000000</code> and <code class='expr'>23:59:59.999999999</code>.