diff options
author | chai <chaifix@163.com> | 2021-10-30 11:32:16 +0800 |
---|---|---|
committer | chai <chaifix@163.com> | 2021-10-30 11:32:16 +0800 |
commit | 42ec7286b2d36a9ba22925f816a17cb1cc2aa5ce (patch) | |
tree | 24bc7009457a8d7500f264e89946dc20d069294f /Data/Libraries/Penlight/docs/classes | |
parent | 164885fd98d48703bd771f802d79557b7db97431 (diff) |
+ Penlight
Diffstat (limited to 'Data/Libraries/Penlight/docs/classes')
-rw-r--r-- | Data/Libraries/Penlight/docs/classes/pl.Date.html | 1049 | ||||
-rw-r--r-- | Data/Libraries/Penlight/docs/classes/pl.List.html | 1443 | ||||
-rw-r--r-- | Data/Libraries/Penlight/docs/classes/pl.Map.html | 454 | ||||
-rw-r--r-- | Data/Libraries/Penlight/docs/classes/pl.MultiMap.html | 207 | ||||
-rw-r--r-- | Data/Libraries/Penlight/docs/classes/pl.OrderedMap.html | 417 | ||||
-rw-r--r-- | Data/Libraries/Penlight/docs/classes/pl.Set.html | 655 |
6 files changed, 4225 insertions, 0 deletions
diff --git a/Data/Libraries/Penlight/docs/classes/pl.Date.html b/Data/Libraries/Penlight/docs/classes/pl.Date.html new file mode 100644 index 0000000..47d3d65 --- /dev/null +++ b/Data/Libraries/Penlight/docs/classes/pl.Date.html @@ -0,0 +1,1049 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Penlight Documentation</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>Penlight</h1> + +<ul> + <li><a href="https://github.com/lunarmodules/Penlight">GitHub Project</a></li> + <li><a href="../index.html">Documentation</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Functions">Functions</a></li> +<li><a href="#Methods">Methods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><strong>pl.Date</strong></li> + <li><a href="../classes/pl.List.html">pl.List</a></li> + <li><a href="../classes/pl.Map.html">pl.Map</a></li> + <li><a href="../classes/pl.MultiMap.html">pl.MultiMap</a></li> + <li><a href="../classes/pl.OrderedMap.html">pl.OrderedMap</a></li> + <li><a href="../classes/pl.Set.html">pl.Set</a></li> +</ul> +<h2>Libraries</h2> +<ul class="nowrap"> + <li><a href="../libraries/pl.html">pl</a></li> + <li><a href="../libraries/pl.app.html">pl.app</a></li> + <li><a href="../libraries/pl.array2d.html">pl.array2d</a></li> + <li><a href="../libraries/pl.class.html">pl.class</a></li> + <li><a href="../libraries/pl.compat.html">pl.compat</a></li> + <li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li> + <li><a href="../libraries/pl.config.html">pl.config</a></li> + <li><a href="../libraries/pl.data.html">pl.data</a></li> + <li><a href="../libraries/pl.dir.html">pl.dir</a></li> + <li><a href="../libraries/pl.file.html">pl.file</a></li> + <li><a href="../libraries/pl.func.html">pl.func</a></li> + <li><a href="../libraries/pl.import_into.html">pl.import_into</a></li> + <li><a href="../libraries/pl.input.html">pl.input</a></li> + <li><a href="../libraries/pl.lapp.html">pl.lapp</a></li> + <li><a href="../libraries/pl.lexer.html">pl.lexer</a></li> + <li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li> + <li><a href="../libraries/pl.operator.html">pl.operator</a></li> + <li><a href="../libraries/pl.path.html">pl.path</a></li> + <li><a href="../libraries/pl.permute.html">pl.permute</a></li> + <li><a href="../libraries/pl.pretty.html">pl.pretty</a></li> + <li><a href="../libraries/pl.seq.html">pl.seq</a></li> + <li><a href="../libraries/pl.sip.html">pl.sip</a></li> + <li><a href="../libraries/pl.strict.html">pl.strict</a></li> + <li><a href="../libraries/pl.stringio.html">pl.stringio</a></li> + <li><a href="../libraries/pl.stringx.html">pl.stringx</a></li> + <li><a href="../libraries/pl.tablex.html">pl.tablex</a></li> + <li><a href="../libraries/pl.template.html">pl.template</a></li> + <li><a href="../libraries/pl.test.html">pl.test</a></li> + <li><a href="../libraries/pl.text.html">pl.text</a></li> + <li><a href="../libraries/pl.types.html">pl.types</a></li> + <li><a href="../libraries/pl.url.html">pl.url</a></li> + <li><a href="../libraries/pl.utils.html">pl.utils</a></li> + <li><a href="../libraries/pl.xml.html">pl.xml</a></li> +</ul> +<h2>Manual</h2> +<ul class="nowrap"> + <li><a href="../manual/01-introduction.md.html">Introduction</a></li> + <li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li> + <li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li> + <li><a href="../manual/04-paths.md.html">Paths and Directories</a></li> + <li><a href="../manual/05-dates.md.html">Date and Time</a></li> + <li><a href="../manual/06-data.md.html">Data</a></li> + <li><a href="../manual/07-functional.md.html">Functional Programming</a></li> + <li><a href="../manual/08-additional.md.html">Additional Libraries</a></li> + <li><a href="../manual/09-discussion.md.html">Technical Choices</a></li> +</ul> +<h2>Examples</h2> +<ul class="nowrap"> + <li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li> + <li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li> + <li><a href="../examples/symbols.lua.html">symbols.lua</a></li> + <li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li> + <li><a href="../examples/test-data.lua.html">test-data.lua</a></li> + <li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li> + <li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li> + <li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li> + <li><a href="../examples/testclone.lua.html">testclone.lua</a></li> + <li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li> + <li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li> + <li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li> + <li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li> + <li><a href="../examples/testxml.lua.html">testxml.lua</a></li> + <li><a href="../examples/which.lua.html">which.lua</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>pl.Date</code></h1> +<p>Date and Date Format classes.</p> +<p> See <a href="../manual/05-dates.md.html#">the Guide</a>.</p> + +<p> NOTE: the date module is deprecated! see + https://github.com/lunarmodules/Penlight/issues/285</p> + +<p> Dependencies: <a href="../libraries/pl.class.html#">pl.class</a>, <a href="../libraries/pl.stringx.html#">pl.stringx</a>, <a href="../libraries/pl.utils.html#">pl.utils</a></p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#Date:set">Date:set (t)</a></td> + <td class="summary">set the current time of this Date object.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.tzone">Date.tzone (ts)</a></td> + <td class="summary">get the time zone offset from UTC.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:toUTC">Date:toUTC ()</a></td> + <td class="summary">convert this date to UTC.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:toLocal">Date:toLocal ()</a></td> + <td class="summary">convert this UTC date to local.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:year">Date:year (y)</a></td> + <td class="summary">set the year.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:month">Date:month (m)</a></td> + <td class="summary">set the month.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:day">Date:day (d)</a></td> + <td class="summary">set the day.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:hour">Date:hour (h)</a></td> + <td class="summary">set the hour.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:min">Date:min (min)</a></td> + <td class="summary">set the minutes.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:sec">Date:sec (sec)</a></td> + <td class="summary">set the seconds.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:yday">Date:yday (yday)</a></td> + <td class="summary">set the day of year.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:year">Date:year (y)</a></td> + <td class="summary">get the year.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:month">Date:month ()</a></td> + <td class="summary">get the month.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:day">Date:day ()</a></td> + <td class="summary">get the day.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:hour">Date:hour ()</a></td> + <td class="summary">get the hour.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:min">Date:min ()</a></td> + <td class="summary">get the minutes.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:sec">Date:sec ()</a></td> + <td class="summary">get the seconds.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:yday">Date:yday ()</a></td> + <td class="summary">get the day of year.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:weekday_name">Date:weekday_name (full)</a></td> + <td class="summary">name of day of week.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:month_name">Date:month_name (full)</a></td> + <td class="summary">name of month.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:is_weekend">Date:is_weekend ()</a></td> + <td class="summary">is this day on a weekend?.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:add">Date:add (t)</a></td> + <td class="summary">add to a date object.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:last_day">Date:last_day ()</a></td> + <td class="summary">last day of the month.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:diff">Date:diff (other)</a></td> + <td class="summary">difference between two Date objects.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:__tostring">Date:__tostring ()</a></td> + <td class="summary">long numerical ISO data format version of this date.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:__eq">Date:__eq (other)</a></td> + <td class="summary">equality between Date objects.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:__lt">Date:__lt (other)</a></td> + <td class="summary">ordering between Date objects.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:__sub">Date:__sub ()</a></td> + <td class="summary">difference between Date objects.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date:__add">Date:__add (other)</a></td> + <td class="summary">add a date and an interval.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.Interval">Date.Interval (t)</a></td> + <td class="summary">Date.Interval constructor</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.Interval:__tostring">Date.Interval:__tostring ()</a></td> + <td class="summary">If it's an interval then the format is '2 hours 29 sec' etc.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.Format">Date.Format (fmt.)</a></td> + <td class="summary">Date.Format constructor.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.Format:parse">Date.Format:parse (str)</a></td> + <td class="summary">parse a string into a Date object.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.Format:tostring">Date.Format:tostring (d)</a></td> + <td class="summary">convert a Date object into a string.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#Date.Format:US_order">Date.Format:US_order (yesno)</a></td> + <td class="summary">force US order in dates like 9/11/2001</td> + </tr> +</table> +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.Date:Date">pl.Date:Date (t, ...)</a></td> + <td class="summary">Date constructor.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "Date:set"></a> + <strong>Date:set (t)</strong> + </dt> + <dd> + set the current time of this Date object. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + <span class="types"><span class="type">int</span></span> + seconds since epoch + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date.tzone"></a> + <strong>Date.tzone (ts)</strong> + </dt> + <dd> + get the time zone offset from UTC. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">ts</span> + <span class="types"><span class="type">int</span></span> + seconds ahead of UTC + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:toUTC"></a> + <strong>Date:toUTC ()</strong> + </dt> + <dd> + convert this date to UTC. + + + + + + + +</dd> + <dt> + <a name = "Date:toLocal"></a> + <strong>Date:toLocal ()</strong> + </dt> + <dd> + convert this UTC date to local. + + + + + + + +</dd> + <dt> + <a name = "Date:year"></a> + <strong>Date:year (y)</strong> + </dt> + <dd> + set the year. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">y</span> + <span class="types"><span class="type">int</span></span> + Four-digit year + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:month"></a> + <strong>Date:month (m)</strong> + </dt> + <dd> + set the month. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">m</span> + <span class="types"><span class="type">int</span></span> + month + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:day"></a> + <strong>Date:day (d)</strong> + </dt> + <dd> + set the day. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">d</span> + <span class="types"><span class="type">int</span></span> + day + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:hour"></a> + <strong>Date:hour (h)</strong> + </dt> + <dd> + set the hour. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">h</span> + <span class="types"><span class="type">int</span></span> + hour + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:min"></a> + <strong>Date:min (min)</strong> + </dt> + <dd> + set the minutes. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">min</span> + <span class="types"><span class="type">int</span></span> + minutes + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:sec"></a> + <strong>Date:sec (sec)</strong> + </dt> + <dd> + set the seconds. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">sec</span> + <span class="types"><span class="type">int</span></span> + seconds + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:yday"></a> + <strong>Date:yday (yday)</strong> + </dt> + <dd> + set the day of year. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">yday</span> + <span class="types"><span class="type">int</span></span> + day of year + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:year"></a> + <strong>Date:year (y)</strong> + </dt> + <dd> + get the year. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">y</span> + <span class="types"><span class="type">int</span></span> + Four-digit year + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:month"></a> + <strong>Date:month ()</strong> + </dt> + <dd> + get the month. + + + + + + + +</dd> + <dt> + <a name = "Date:day"></a> + <strong>Date:day ()</strong> + </dt> + <dd> + get the day. + + + + + + + +</dd> + <dt> + <a name = "Date:hour"></a> + <strong>Date:hour ()</strong> + </dt> + <dd> + get the hour. + + + + + + + +</dd> + <dt> + <a name = "Date:min"></a> + <strong>Date:min ()</strong> + </dt> + <dd> + get the minutes. + + + + + + + +</dd> + <dt> + <a name = "Date:sec"></a> + <strong>Date:sec ()</strong> + </dt> + <dd> + get the seconds. + + + + + + + +</dd> + <dt> + <a name = "Date:yday"></a> + <strong>Date:yday ()</strong> + </dt> + <dd> + get the day of year. + + + + + + + +</dd> + <dt> + <a name = "Date:weekday_name"></a> + <strong>Date:weekday_name (full)</strong> + </dt> + <dd> + name of day of week. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">full</span> + <span class="types"><span class="type">bool</span></span> + abbreviated if true, full otherwise. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + name + </ol> + + + + +</dd> + <dt> + <a name = "Date:month_name"></a> + <strong>Date:month_name (full)</strong> + </dt> + <dd> + name of month. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">full</span> + <span class="types"><span class="type">int</span></span> + abbreviated if true, full otherwise. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + name + </ol> + + + + +</dd> + <dt> + <a name = "Date:is_weekend"></a> + <strong>Date:is_weekend ()</strong> + </dt> + <dd> + is this day on a weekend?. + + + + + + + +</dd> + <dt> + <a name = "Date:add"></a> + <strong>Date:add (t)</strong> + </dt> + <dd> + add to a date object. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + a table containing one of the following keys and a value: + one of <a href="../classes/pl.Date.html#Date:year">year</a>,<a href="../classes/pl.Date.html#Date:month">month</a>,<a href="../classes/pl.Date.html#Date:day">day</a>,<a href="../classes/pl.Date.html#Date:hour">hour</a>,<a href="../classes/pl.Date.html#Date:min">min</a>,<a href="../classes/pl.Date.html#Date:sec">sec</a> + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + this date + </ol> + + + + +</dd> + <dt> + <a name = "Date:last_day"></a> + <strong>Date:last_day ()</strong> + </dt> + <dd> + last day of the month. + + + + <h3>Returns:</h3> + <ol> + + int day + </ol> + + + + +</dd> + <dt> + <a name = "Date:diff"></a> + <strong>Date:diff (other)</strong> + </dt> + <dd> + difference between two Date objects. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">other</span> + <span class="types"><a class="type" href="../classes/pl.Date.html">Date</a></span> + Date object + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/pl.Date.html#Date.Interval">Date.Interval</a></span> + object + </ol> + + + + +</dd> + <dt> + <a name = "Date:__tostring"></a> + <strong>Date:__tostring ()</strong> + </dt> + <dd> + long numerical ISO data format version of this date. + + + + + + + +</dd> + <dt> + <a name = "Date:__eq"></a> + <strong>Date:__eq (other)</strong> + </dt> + <dd> + equality between Date objects. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">other</span> + + + + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:__lt"></a> + <strong>Date:__lt (other)</strong> + </dt> + <dd> + ordering between Date objects. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">other</span> + + + + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date:__sub"></a> + <strong>Date:__sub ()</strong> + </dt> + <dd> + difference between Date objects. + + + + + + + +</dd> + <dt> + <a name = "Date:__add"></a> + <strong>Date:__add (other)</strong> + </dt> + <dd> + add a date and an interval. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">other</span> + either a <a href="../classes/pl.Date.html#Date.Interval">Date.Interval</a> object or a table such as + passed to <a href="../classes/pl.Date.html#Date:add">Date:add</a> + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date.Interval"></a> + <strong>Date.Interval (t)</strong> + </dt> + <dd> + Date.Interval constructor + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + <span class="types"><span class="type">int</span></span> + an interval in seconds + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "Date.Interval:__tostring"></a> + <strong>Date.Interval:__tostring ()</strong> + </dt> + <dd> + If it's an interval then the format is '2 hours 29 sec' etc. + + + + + + + +</dd> + <dt> + <a name = "Date.Format"></a> + <strong>Date.Format (fmt.)</strong> + </dt> + <dd> + Date.Format constructor. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fmt.</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + A string where the following fields are significant:</p> + +<ul> + <li>d day (either d or dd)</li> + <li>y year (either yy or yyy)</li> + <li>m month (either m or mm)</li> + <li>H hour (either H or HH)</li> + <li>M minute (either M or MM)</li> + <li>S second (either S or SS)</li> +</ul> + +<p> Alternatively, if fmt is nil then this returns a flexible date parser + that tries various date/time schemes in turn:</p> + +<ul> + <li><a href="http://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a>, like <code>2010-05-10 12:35:23Z</code> or <code>2008-10-03T14:30+02</code></li> + <li>times like 15:30 or 8.05pm (assumed to be today's date)</li> + <li>dates like 28/10/02 (European order!) or 5 Feb 2012</li> + <li>month name like march or Mar (case-insensitive, first 3 letters); here the + day will be 1 and the year this current year</li> +</ul> + +<p> A date in format 3 can be optionally followed by a time in format 2. + Please see test-date.lua in the tests folder for more examples. + </li> + </ul> + + + + + <h3>Usage:</h3> + <ul> + <pre class="example">df = Date.Format(<span class="string">"yyyy-mm-dd HH:MM:SS"</span>)</pre> + </ul> + +</dd> + <dt> + <a name = "Date.Format:parse"></a> + <strong>Date.Format:parse (str)</strong> + </dt> + <dd> + parse a string into a Date object. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">str</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + a date string + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + date object + </ol> + + + + +</dd> + <dt> + <a name = "Date.Format:tostring"></a> + <strong>Date.Format:tostring (d)</strong> + </dt> + <dd> + convert a Date object into a string. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">d</span> + a date object, or a time value as returned by <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.time">os.time</a> + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + string + </ol> + + + + +</dd> + <dt> + <a name = "Date.Format:US_order"></a> + <strong>Date.Format:US_order (yesno)</strong> + </dt> + <dd> + force US order in dates like 9/11/2001 + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">yesno</span> + + + + </li> + </ul> + + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "pl.Date:Date"></a> + <strong>pl.Date:Date (t, ...)</strong> + </dt> + <dd> + Date constructor. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + +<p> this can be either</p> + +<ul> + <li><code>nil</code> or empty - use current date and time</li> + <li>number - seconds since epoch (as returned by <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.time">os.time</a>). Resulting time is UTC</li> + <li><a href="../classes/pl.Date.html">Date</a> - make a copy of this date</li> + <li>table - table containing year, month, etc as for <a href="https://www.lua.org/manual/5.1/manual.html#pdf-os.time">os.time</a>. You may leave out year, month or day, + in which case current values will be used.</li> + <li>year (will be followed by month, day etc)</li> +</ul> + + + </li> + <li><span class="parameter">...</span> + true if Universal Coordinated Time, or two to five numbers: month,day,hour,min,sec + </li> + </ul> + + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/Data/Libraries/Penlight/docs/classes/pl.List.html b/Data/Libraries/Penlight/docs/classes/pl.List.html new file mode 100644 index 0000000..b84209f --- /dev/null +++ b/Data/Libraries/Penlight/docs/classes/pl.List.html @@ -0,0 +1,1443 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Penlight Documentation</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>Penlight</h1> + +<ul> + <li><a href="https://github.com/lunarmodules/Penlight">GitHub Project</a></li> + <li><a href="../index.html">Documentation</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Functions">Functions</a></li> +<li><a href="#metamethods">metamethods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/pl.Date.html">pl.Date</a></li> + <li><strong>pl.List</strong></li> + <li><a href="../classes/pl.Map.html">pl.Map</a></li> + <li><a href="../classes/pl.MultiMap.html">pl.MultiMap</a></li> + <li><a href="../classes/pl.OrderedMap.html">pl.OrderedMap</a></li> + <li><a href="../classes/pl.Set.html">pl.Set</a></li> +</ul> +<h2>Libraries</h2> +<ul class="nowrap"> + <li><a href="../libraries/pl.html">pl</a></li> + <li><a href="../libraries/pl.app.html">pl.app</a></li> + <li><a href="../libraries/pl.array2d.html">pl.array2d</a></li> + <li><a href="../libraries/pl.class.html">pl.class</a></li> + <li><a href="../libraries/pl.compat.html">pl.compat</a></li> + <li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li> + <li><a href="../libraries/pl.config.html">pl.config</a></li> + <li><a href="../libraries/pl.data.html">pl.data</a></li> + <li><a href="../libraries/pl.dir.html">pl.dir</a></li> + <li><a href="../libraries/pl.file.html">pl.file</a></li> + <li><a href="../libraries/pl.func.html">pl.func</a></li> + <li><a href="../libraries/pl.import_into.html">pl.import_into</a></li> + <li><a href="../libraries/pl.input.html">pl.input</a></li> + <li><a href="../libraries/pl.lapp.html">pl.lapp</a></li> + <li><a href="../libraries/pl.lexer.html">pl.lexer</a></li> + <li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li> + <li><a href="../libraries/pl.operator.html">pl.operator</a></li> + <li><a href="../libraries/pl.path.html">pl.path</a></li> + <li><a href="../libraries/pl.permute.html">pl.permute</a></li> + <li><a href="../libraries/pl.pretty.html">pl.pretty</a></li> + <li><a href="../libraries/pl.seq.html">pl.seq</a></li> + <li><a href="../libraries/pl.sip.html">pl.sip</a></li> + <li><a href="../libraries/pl.strict.html">pl.strict</a></li> + <li><a href="../libraries/pl.stringio.html">pl.stringio</a></li> + <li><a href="../libraries/pl.stringx.html">pl.stringx</a></li> + <li><a href="../libraries/pl.tablex.html">pl.tablex</a></li> + <li><a href="../libraries/pl.template.html">pl.template</a></li> + <li><a href="../libraries/pl.test.html">pl.test</a></li> + <li><a href="../libraries/pl.text.html">pl.text</a></li> + <li><a href="../libraries/pl.types.html">pl.types</a></li> + <li><a href="../libraries/pl.url.html">pl.url</a></li> + <li><a href="../libraries/pl.utils.html">pl.utils</a></li> + <li><a href="../libraries/pl.xml.html">pl.xml</a></li> +</ul> +<h2>Manual</h2> +<ul class="nowrap"> + <li><a href="../manual/01-introduction.md.html">Introduction</a></li> + <li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li> + <li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li> + <li><a href="../manual/04-paths.md.html">Paths and Directories</a></li> + <li><a href="../manual/05-dates.md.html">Date and Time</a></li> + <li><a href="../manual/06-data.md.html">Data</a></li> + <li><a href="../manual/07-functional.md.html">Functional Programming</a></li> + <li><a href="../manual/08-additional.md.html">Additional Libraries</a></li> + <li><a href="../manual/09-discussion.md.html">Technical Choices</a></li> +</ul> +<h2>Examples</h2> +<ul class="nowrap"> + <li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li> + <li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li> + <li><a href="../examples/symbols.lua.html">symbols.lua</a></li> + <li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li> + <li><a href="../examples/test-data.lua.html">test-data.lua</a></li> + <li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li> + <li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li> + <li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li> + <li><a href="../examples/testclone.lua.html">testclone.lua</a></li> + <li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li> + <li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li> + <li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li> + <li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li> + <li><a href="../examples/testxml.lua.html">testxml.lua</a></li> + <li><a href="../examples/which.lua.html">which.lua</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>pl.List</code></h1> +<p>Python-style list class.</p> +<p> <strong>Please Note</strong>: methods that change the list will return the list. + This is to allow for method chaining, but please note that <code>ls = ls:sort()</code> + does not mean that a new copy of the list is made. In-place (mutable) methods + are marked as returning 'the list' in this documentation.</p> + +<p> See the Guide for further <a href="../manual/02-arrays.md.html#Python_style_Lists">discussion</a></p> + +<p> See <a href="http://www.python.org/doc/current/tut/tut.html">http://www.python.org/doc/current/tut/tut.html</a>, section 5.1</p> + +<p> <strong>Note</strong>: The comments before some of the functions are from the Python docs + and contain Python code.</p> + +<p> Written for Lua version Nick Trout 4.0; Redone for Lua 5.1, Steve Donovan.</p> + +<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.tablex.html#">pl.tablex</a>, <a href="../libraries/pl.class.html#">pl.class</a></p> + + +<h2><a href="#Functions">Functions</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#List.new">List.new ([t])</a></td> + <td class="summary">Create a new list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:clone">List:clone ()</a></td> + <td class="summary">Make a copy of an existing list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:append">List:append (i)</a></td> + <td class="summary">Add an item to the end of the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:extend">List:extend (L)</a></td> + <td class="summary">Extend the list by appending all the items in the given list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:insert">List:insert (i, x)</a></td> + <td class="summary">Insert an item at a given position.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:put">List:put (x)</a></td> + <td class="summary">Insert an item at the begining of the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:remove">List:remove (i)</a></td> + <td class="summary">Remove an element given its index.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:remove_value">List:remove_value (x)</a></td> + <td class="summary">Remove the first item from the list whose value is given.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:pop">List:pop ([i])</a></td> + <td class="summary">Remove the item at the given position in the list, and return it.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:index">List:index (x[, idx=1])</a></td> + <td class="summary">Return the index in the list of the first item whose value is given.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:contains">List:contains (x)</a></td> + <td class="summary">Does this list contain the value?</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:count">List:count (x)</a></td> + <td class="summary">Return the number of times value appears in the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:sort">List:sort ([cmp='<'])</a></td> + <td class="summary">Sort the items of the list, in place.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:sorted">List:sorted ([cmp='<'])</a></td> + <td class="summary">Return a sorted copy of this list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:reverse">List:reverse ()</a></td> + <td class="summary">Reverse the elements of the list, in place.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:minmax">List:minmax ()</a></td> + <td class="summary">Return the minimum and the maximum value of the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:slice">List:slice (first, last)</a></td> + <td class="summary">Emulate list slicing.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:clear">List:clear ()</a></td> + <td class="summary">Empty the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List.range">List.range (start[, finish[, incr=1]])</a></td> + <td class="summary">Emulate Python's range(x) function.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:len">List:len ()</a></td> + <td class="summary">list:len() is the same as #list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:chop">List:chop (i1, i2)</a></td> + <td class="summary">Remove a subrange of elements.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:splice">List:splice (idx, list)</a></td> + <td class="summary">Insert a sublist into a list + equivalent to 's[idx:idx] = list' in Python</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:slice_assign">List:slice_assign (i1, i2, seq)</a></td> + <td class="summary">General slice assignment s[i1:i2] = seq.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:join">List:join ([delim=''])</a></td> + <td class="summary">Join the elements of a list using a delimiter.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:concat">List:concat ([delim=''])</a></td> + <td class="summary">Join a list of strings.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:foreach">List:foreach (fun, ...)</a></td> + <td class="summary">Call the function on each element of the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:foreachm">List:foreachm (name, ...)</a></td> + <td class="summary">Call the named method on each element of the list.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:filter">List:filter (fun[, arg])</a></td> + <td class="summary">Create a list of all elements which match a function.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List.split">List.split (s[, delim])</a></td> + <td class="summary">Split a string using a delimiter.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:map">List:map (fun, ...)</a></td> + <td class="summary">Apply a function to all elements.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:transform">List:transform (fun, ...)</a></td> + <td class="summary">Apply a function to all elements, in-place.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:map2">List:map2 (fun, ls, ...)</a></td> + <td class="summary">Apply a function to elements of two lists.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:mapm">List:mapm (name, ...)</a></td> + <td class="summary">apply a named method to all elements.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:reduce">List:reduce (fun)</a></td> + <td class="summary">'reduce' a list using a binary function.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:partition">List:partition (fun, ...)</a></td> + <td class="summary">Partition a list using a classifier function.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:iter">List:iter ()</a></td> + <td class="summary">return an iterator over all values.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List.iterate">List.iterate (seq)</a></td> + <td class="summary">Create an iterator over a seqence.</td> + </tr> +</table> +<h2><a href="#metamethods">metamethods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#List:__concat">List:__concat (L)</a></td> + <td class="summary">Concatenation operator.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:__eq">List:__eq (L)</a></td> + <td class="summary">Equality operator ==.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#List:__tostring">List:__tostring ()</a></td> + <td class="summary">How our list should be rendered as a string.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Functions"></a>Functions</h2> + + <dl class="function"> + <dt> + <a name = "List.new"></a> + <strong>List.new ([t])</strong> + </dt> + <dd> + Create a new list. Can optionally pass a table; + passing another instance of List will cause a copy to be created; + this will return a plain table with an appropriate metatable. + we pass anything which isn't a simple table to iterate() to work out + an appropriate iterator + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + An optional list-like table + (<em>optional</em>) + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new List + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../classes/pl.List.html#List.iterate">List.iterate</a> + </ul> + + <h3>Usage:</h3> + <ul> + <pre class="example">ls = List(); ls = List {<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>,<span class="number">4</span>}</pre> + </ul> + +</dd> + <dt> + <a name = "List:clone"></a> + <strong>List:clone ()</strong> + </dt> + <dd> + Make a copy of an existing list. + The difference from a plain 'copy constructor' is that this returns + the actual List subtype. + + + + + + + +</dd> + <dt> + <a name = "List:append"></a> + <strong>List:append (i)</strong> + </dt> + <dd> + Add an item to the end of the list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i</span> + An item + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:extend"></a> + <strong>List:extend (L)</strong> + </dt> + <dd> + Extend the list by appending all the items in the given list. + equivalent to 'a[len(a):] = L'. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">L</span> + <span class="types"><a class="type" href="../classes/pl.List.html">List</a></span> + Another List + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:insert"></a> + <strong>List:insert (i, x)</strong> + </dt> + <dd> + Insert an item at a given position. i is the index of the + element before which to insert. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i</span> + <span class="types"><span class="type">int</span></span> + index of element before whichh to insert + </li> + <li><span class="parameter">x</span> + A data item + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:put"></a> + <strong>List:put (x)</strong> + </dt> + <dd> + Insert an item at the begining of the list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + a data item + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:remove"></a> + <strong>List:remove (i)</strong> + </dt> + <dd> + Remove an element given its index. + (equivalent of Python's del s[i]) + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i</span> + <span class="types"><span class="type">int</span></span> + the index + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:remove_value"></a> + <strong>List:remove_value (x)</strong> + </dt> + <dd> + Remove the first item from the list whose value is given. + (This is called 'remove' in Python; renamed to avoid confusion + with table.remove) + Return nil if there is no such item. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + A data value + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:pop"></a> + <strong>List:pop ([i])</strong> + </dt> + <dd> + Remove the item at the given position in the list, and return it. + If no index is specified, a:pop() returns the last item in the list. + The item is also removed from the list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i</span> + <span class="types"><span class="type">int</span></span> + An index + (<em>optional</em>) + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the item + </ol> + + + + +</dd> + <dt> + <a name = "List:index"></a> + <strong>List:index (x[, idx=1])</strong> + </dt> + <dd> + Return the index in the list of the first item whose value is given. + Return nil if there is no such item. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + A data value + </li> + <li><span class="parameter">idx</span> + <span class="types"><span class="type">int</span></span> + where to start search + (<em>default</em> 1) + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the index, or nil if not found. + </ol> + + + + +</dd> + <dt> + <a name = "List:contains"></a> + <strong>List:contains (x)</strong> + </dt> + <dd> + Does this list contain the value? + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + A data value + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true or false + </ol> + + + + +</dd> + <dt> + <a name = "List:count"></a> + <strong>List:count (x)</strong> + </dt> + <dd> + Return the number of times value appears in the list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">x</span> + A data value + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + number of times x appears + </ol> + + + + +</dd> + <dt> + <a name = "List:sort"></a> + <strong>List:sort ([cmp='<'])</strong> + </dt> + <dd> + Sort the items of the list, in place. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">cmp</span> + <span class="types"><span class="type">func</span></span> + an optional comparison function + (<em>default</em> '<') + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:sorted"></a> + <strong>List:sorted ([cmp='<'])</strong> + </dt> + <dd> + Return a sorted copy of this list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">cmp</span> + <span class="types"><span class="type">func</span></span> + an optional comparison function + (<em>default</em> '<') + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new list + </ol> + + + + +</dd> + <dt> + <a name = "List:reverse"></a> + <strong>List:reverse ()</strong> + </dt> + <dd> + Reverse the elements of the list, in place. + + + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:minmax"></a> + <strong>List:minmax ()</strong> + </dt> + <dd> + Return the minimum and the maximum value of the list. + + + + <h3>Returns:</h3> + <ol> + <li> + minimum value</li> + <li> + maximum value</li> + </ol> + + + + +</dd> + <dt> + <a name = "List:slice"></a> + <strong>List:slice (first, last)</strong> + </dt> + <dd> + Emulate list slicing. like 'list[first:last]' in Python. + If first or last are negative then they are relative to the end of the list + eg. slice(-2) gives last 2 entries in a list, and + slice(-4,-2) gives from -4th to -2nd + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">first</span> + An index + </li> + <li><span class="parameter">last</span> + An index + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new List + </ol> + + + + +</dd> + <dt> + <a name = "List:clear"></a> + <strong>List:clear ()</strong> + </dt> + <dd> + Empty the list. + + + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List.range"></a> + <strong>List.range (start[, finish[, incr=1]])</strong> + </dt> + <dd> + Emulate Python's range(x) function. + Include it in List table for tidiness + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">start</span> + <span class="types"><span class="type">int</span></span> + A number + </li> + <li><span class="parameter">finish</span> + <span class="types"><span class="type">int</span></span> + A number greater than start; if absent, + then start is 1 and finish is start + (<em>optional</em>) + </li> + <li><span class="parameter">incr</span> + <span class="types"><span class="type">int</span></span> + an increment (may be less than 1) + (<em>default</em> 1) + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a List from start .. finish + </ol> + + + + <h3>Usage:</h3> + <ul> + <li><pre class="example">List.range(<span class="number">0</span>,<span class="number">3</span>) == List{<span class="number">0</span>,<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>}</pre></li> + <li><pre class="example">List.range(<span class="number">4</span>) = List{<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>,<span class="number">4</span>}</pre></li> + <li><pre class="example">List.range(<span class="number">5</span>,<span class="number">1</span>,-<span class="number">1</span>) == List{<span class="number">5</span>,<span class="number">4</span>,<span class="number">3</span>,<span class="number">2</span>,<span class="number">1</span>}</pre></li> + </ul> + +</dd> + <dt> + <a name = "List:len"></a> + <strong>List:len ()</strong> + </dt> + <dd> + list:len() is the same as #list. + + + + + + + +</dd> + <dt> + <a name = "List:chop"></a> + <strong>List:chop (i1, i2)</strong> + </dt> + <dd> + Remove a subrange of elements. + equivalent to 'del s[i1:i2]' in Python. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i1</span> + <span class="types"><span class="type">int</span></span> + start of range + </li> + <li><span class="parameter">i2</span> + <span class="types"><span class="type">int</span></span> + end of range + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:splice"></a> + <strong>List:splice (idx, list)</strong> + </dt> + <dd> + Insert a sublist into a list + equivalent to 's[idx:idx] = list' in Python + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">idx</span> + <span class="types"><span class="type">int</span></span> + index + </li> + <li><span class="parameter">list</span> + <span class="types"><a class="type" href="../classes/pl.List.html">List</a></span> + list to insert + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + <h3>Usage:</h3> + <ul> + <pre class="example">l = List{<span class="number">10</span>,<span class="number">20</span>}; l:splice(<span class="number">2</span>,{<span class="number">21</span>,<span class="number">22</span>}); <span class="global">assert</span>(l == List{<span class="number">10</span>,<span class="number">21</span>,<span class="number">22</span>,<span class="number">20</span>})</pre> + </ul> + +</dd> + <dt> + <a name = "List:slice_assign"></a> + <strong>List:slice_assign (i1, i2, seq)</strong> + </dt> + <dd> + General slice assignment s[i1:i2] = seq. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">i1</span> + <span class="types"><span class="type">int</span></span> + start index + </li> + <li><span class="parameter">i2</span> + <span class="types"><span class="type">int</span></span> + end index + </li> + <li><span class="parameter">seq</span> + <span class="types"><a class="type" href="../classes/pl.List.html">List</a></span> + a list + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list + </ol> + + + + +</dd> + <dt> + <a name = "List:join"></a> + <strong>List:join ([delim=''])</strong> + </dt> + <dd> + Join the elements of a list using a delimiter. + This method uses tostring on all elements. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">delim</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + a delimiter string, can be empty. + (<em>default</em> '') + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a string + </ol> + + + + +</dd> + <dt> + <a name = "List:concat"></a> + <strong>List:concat ([delim=''])</strong> + </dt> + <dd> + Join a list of strings. <br> + Uses <a href="https://www.lua.org/manual/5.1/manual.html#pdf-table.concat">table.concat</a> directly. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">delim</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + a delimiter + (<em>default</em> '') + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a string + </ol> + + + + +</dd> + <dt> + <a name = "List:foreach"></a> + <strong>List:foreach (fun, ...)</strong> + </dt> + <dd> + Call the function on each element of the list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + a function or callable object + </li> + <li><span class="parameter">...</span> + optional values to pass to function + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "List:foreachm"></a> + <strong>List:foreachm (name, ...)</strong> + </dt> + <dd> + Call the named method on each element of the list. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">name</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + the method name + </li> + <li><span class="parameter">...</span> + optional values to pass to function + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "List:filter"></a> + <strong>List:filter (fun[, arg])</strong> + </dt> + <dd> + Create a list of all elements which match a function. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + a boolean function + </li> + <li><span class="parameter">arg</span> + optional argument to be passed as second argument of the predicate + (<em>optional</em>) + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new filtered list. + </ol> + + + + +</dd> + <dt> + <a name = "List.split"></a> + <strong>List.split (s[, delim])</strong> + </dt> + <dd> + Split a string using a delimiter. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">s</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + the string + </li> + <li><span class="parameter">delim</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + the delimiter (default spaces) + (<em>optional</em>) + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a List of strings + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../libraries/pl.utils.html#split">pl.utils.split</a> + </ul> + + +</dd> + <dt> + <a name = "List:map"></a> + <strong>List:map (fun, ...)</strong> + </dt> + <dd> + Apply a function to all elements. + Any extra arguments will be passed to the function. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + a function of at least one argument + </li> + <li><span class="parameter">...</span> + arbitrary extra arguments. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new list: {f(x) for x in self} + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../libraries/pl.tablex.html#imap">pl.tablex.imap</a> + </ul> + + <h3>Usage:</h3> + <ul> + <pre class="example">List{<span class="string">'one'</span>,<span class="string">'two'</span>}:map(<span class="global">string</span>.upper) == {<span class="string">'ONE'</span>,<span class="string">'TWO'</span>}</pre> + </ul> + +</dd> + <dt> + <a name = "List:transform"></a> + <strong>List:transform (fun, ...)</strong> + </dt> + <dd> + Apply a function to all elements, in-place. + Any extra arguments are passed to the function. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + A function that takes at least one argument + </li> + <li><span class="parameter">...</span> + arbitrary extra arguments. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the list. + </ol> + + + + +</dd> + <dt> + <a name = "List:map2"></a> + <strong>List:map2 (fun, ls, ...)</strong> + </dt> + <dd> + Apply a function to elements of two lists. + Any extra arguments will be passed to the function + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + a function of at least two arguments + </li> + <li><span class="parameter">ls</span> + <span class="types"><a class="type" href="../classes/pl.List.html">List</a></span> + another list + </li> + <li><span class="parameter">...</span> + arbitrary extra arguments. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new list: {f(x,y) for x in self, for x in arg1} + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../libraries/pl.tablex.html#imap2">pl.tablex.imap2</a> + </ul> + + +</dd> + <dt> + <a name = "List:mapm"></a> + <strong>List:mapm (name, ...)</strong> + </dt> + <dd> + apply a named method to all elements. + Any extra arguments will be passed to the method. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">name</span> + <span class="types"><a class="type" href="https://www.lua.org/manual/5.1/manual.html#5.4">string</a></span> + name of method + </li> + <li><span class="parameter">...</span> + extra arguments + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new list of the results + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../libraries/pl.seq.html#mapmethod">pl.seq.mapmethod</a> + </ul> + + +</dd> + <dt> + <a name = "List:reduce"></a> + <strong>List:reduce (fun)</strong> + </dt> + <dd> + 'reduce' a list using a binary function. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + a function of two arguments + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + result of the function + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../libraries/pl.tablex.html#reduce">pl.tablex.reduce</a> + </ul> + + +</dd> + <dt> + <a name = "List:partition"></a> + <strong>List:partition (fun, ...)</strong> + </dt> + <dd> + Partition a list using a classifier function. + The function may return nil, but this will be converted to the string key '<nil>'. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">fun</span> + <span class="types"><span class="type">func</span></span> + a function of at least one argument + </li> + <li><span class="parameter">...</span> + will also be passed to the function + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + <span class="types"><a class="type" href="../classes/pl.MultiMap.html">MultiMap</a></span> + a table where the keys are the returned values, and the values are Lists + of values where the function returned that key. + </ol> + + + <h3>See also:</h3> + <ul> + <a href="../classes/pl.MultiMap.html#">pl.MultiMap</a> + </ul> + + +</dd> + <dt> + <a name = "List:iter"></a> + <strong>List:iter ()</strong> + </dt> + <dd> + return an iterator over all values. + + + + + + + +</dd> + <dt> + <a name = "List.iterate"></a> + <strong>List.iterate (seq)</strong> + </dt> + <dd> + Create an iterator over a seqence. + This captures the Python concept of 'sequence'. + For tables, iterates over all values with integer indices. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">seq</span> + a sequence; a string (over characters), a table, a file object (over lines) or an iterator function + </li> + </ul> + + + + + <h3>Usage:</h3> + <ul> + <li><pre class="example"><span class="keyword">for</span> x <span class="keyword">in</span> iterate {<span class="number">1</span>,<span class="number">10</span>,<span class="number">22</span>,<span class="number">55</span>} <span class="keyword">do</span> <span class="global">io</span>.write(x,<span class="string">','</span>) <span class="keyword">end</span> ==> <span class="number">1</span>,<span class="number">10</span>,<span class="number">22</span>,<span class="number">55</span></pre></li> + <li><pre class="example"><span class="keyword">for</span> ch <span class="keyword">in</span> iterate <span class="string">'help'</span> <span class="keyword">do</span> <span class="keyword">do</span> <span class="global">io</span>.write(ch,<span class="string">' '</span>) <span class="keyword">end</span> ==> h e l p</pre></li> + </ul> + +</dd> +</dl> + <h2 class="section-header "><a name="metamethods"></a>metamethods</h2> + + <dl class="function"> + <dt> + <a name = "List:__concat"></a> + <strong>List:__concat (L)</strong> + </dt> + <dd> + Concatenation operator. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">L</span> + <span class="types"><a class="type" href="../classes/pl.List.html">List</a></span> + another List + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new list consisting of the list with the elements of the new list appended + </ol> + + + + +</dd> + <dt> + <a name = "List:__eq"></a> + <strong>List:__eq (L)</strong> + </dt> + <dd> + Equality operator ==. True iff all elements of two lists are equal. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">L</span> + <span class="types"><a class="type" href="../classes/pl.List.html">List</a></span> + another List + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true or false + </ol> + + + + +</dd> + <dt> + <a name = "List:__tostring"></a> + <strong>List:__tostring ()</strong> + </dt> + <dd> + How our list should be rendered as a string. Uses join(). + + + + + + <h3>See also:</h3> + <ul> + <a href="../classes/pl.List.html#List:join">List:join</a> + </ul> + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/Data/Libraries/Penlight/docs/classes/pl.Map.html b/Data/Libraries/Penlight/docs/classes/pl.Map.html new file mode 100644 index 0000000..72b4b40 --- /dev/null +++ b/Data/Libraries/Penlight/docs/classes/pl.Map.html @@ -0,0 +1,454 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Penlight Documentation</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>Penlight</h1> + +<ul> + <li><a href="https://github.com/lunarmodules/Penlight">GitHub Project</a></li> + <li><a href="../index.html">Documentation</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Fields">Fields</a></li> +<li><a href="#Methods">Methods</a></li> +<li><a href="#Metamethods">Metamethods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/pl.Date.html">pl.Date</a></li> + <li><a href="../classes/pl.List.html">pl.List</a></li> + <li><strong>pl.Map</strong></li> + <li><a href="../classes/pl.MultiMap.html">pl.MultiMap</a></li> + <li><a href="../classes/pl.OrderedMap.html">pl.OrderedMap</a></li> + <li><a href="../classes/pl.Set.html">pl.Set</a></li> +</ul> +<h2>Libraries</h2> +<ul class="nowrap"> + <li><a href="../libraries/pl.html">pl</a></li> + <li><a href="../libraries/pl.app.html">pl.app</a></li> + <li><a href="../libraries/pl.array2d.html">pl.array2d</a></li> + <li><a href="../libraries/pl.class.html">pl.class</a></li> + <li><a href="../libraries/pl.compat.html">pl.compat</a></li> + <li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li> + <li><a href="../libraries/pl.config.html">pl.config</a></li> + <li><a href="../libraries/pl.data.html">pl.data</a></li> + <li><a href="../libraries/pl.dir.html">pl.dir</a></li> + <li><a href="../libraries/pl.file.html">pl.file</a></li> + <li><a href="../libraries/pl.func.html">pl.func</a></li> + <li><a href="../libraries/pl.import_into.html">pl.import_into</a></li> + <li><a href="../libraries/pl.input.html">pl.input</a></li> + <li><a href="../libraries/pl.lapp.html">pl.lapp</a></li> + <li><a href="../libraries/pl.lexer.html">pl.lexer</a></li> + <li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li> + <li><a href="../libraries/pl.operator.html">pl.operator</a></li> + <li><a href="../libraries/pl.path.html">pl.path</a></li> + <li><a href="../libraries/pl.permute.html">pl.permute</a></li> + <li><a href="../libraries/pl.pretty.html">pl.pretty</a></li> + <li><a href="../libraries/pl.seq.html">pl.seq</a></li> + <li><a href="../libraries/pl.sip.html">pl.sip</a></li> + <li><a href="../libraries/pl.strict.html">pl.strict</a></li> + <li><a href="../libraries/pl.stringio.html">pl.stringio</a></li> + <li><a href="../libraries/pl.stringx.html">pl.stringx</a></li> + <li><a href="../libraries/pl.tablex.html">pl.tablex</a></li> + <li><a href="../libraries/pl.template.html">pl.template</a></li> + <li><a href="../libraries/pl.test.html">pl.test</a></li> + <li><a href="../libraries/pl.text.html">pl.text</a></li> + <li><a href="../libraries/pl.types.html">pl.types</a></li> + <li><a href="../libraries/pl.url.html">pl.url</a></li> + <li><a href="../libraries/pl.utils.html">pl.utils</a></li> + <li><a href="../libraries/pl.xml.html">pl.xml</a></li> +</ul> +<h2>Manual</h2> +<ul class="nowrap"> + <li><a href="../manual/01-introduction.md.html">Introduction</a></li> + <li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li> + <li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li> + <li><a href="../manual/04-paths.md.html">Paths and Directories</a></li> + <li><a href="../manual/05-dates.md.html">Date and Time</a></li> + <li><a href="../manual/06-data.md.html">Data</a></li> + <li><a href="../manual/07-functional.md.html">Functional Programming</a></li> + <li><a href="../manual/08-additional.md.html">Additional Libraries</a></li> + <li><a href="../manual/09-discussion.md.html">Technical Choices</a></li> +</ul> +<h2>Examples</h2> +<ul class="nowrap"> + <li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li> + <li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li> + <li><a href="../examples/symbols.lua.html">symbols.lua</a></li> + <li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li> + <li><a href="../examples/test-data.lua.html">test-data.lua</a></li> + <li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li> + <li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li> + <li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li> + <li><a href="../examples/testclone.lua.html">testclone.lua</a></li> + <li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li> + <li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li> + <li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li> + <li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li> + <li><a href="../examples/testxml.lua.html">testxml.lua</a></li> + <li><a href="../examples/which.lua.html">which.lua</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>pl.Map</code></h1> +<p>A Map class.</p> +<p> + + + +<pre> +> Map = <span class="global">require</span> <span class="string">'pl.Map'</span> +> m = Map{one=<span class="number">1</span>,two=<span class="number">2</span>} +> m:update {three=<span class="number">3</span>,four=<span class="number">4</span>,two=<span class="number">20</span>} +> = m == M{one=<span class="number">1</span>,two=<span class="number">20</span>,three=<span class="number">3</span>,four=<span class="number">4</span>} +<span class="keyword">true</span> +</pre> + +<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.class.html#">pl.class</a>, <a href="../libraries/pl.tablex.html#">pl.tablex</a>, <a href="../libraries/pl.pretty.html#">pl.pretty</a></p> +</p> + + +<h2><a href="#Fields">Fields</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.Map.keys">pl.Map.keys</a></td> + <td class="summary">list of keys.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map.values">pl.Map.values</a></td> + <td class="summary">list of values.</td> + </tr> +</table> +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.Map:iter">pl.Map:iter ()</a></td> + <td class="summary">return an iterator over all key-value pairs.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:items">pl.Map:items ()</a></td> + <td class="summary">return a List of all key-value pairs, sorted by the keys.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:setdefault">pl.Map:setdefault (key, default)</a></td> + <td class="summary">set a value in the map if it doesn't exist yet.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:len">pl.Map:len ()</a></td> + <td class="summary">size of map.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:set">pl.Map:set (key, val)</a></td> + <td class="summary">put a value into the map.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:get">pl.Map:get (key)</a></td> + <td class="summary">get a value from the map.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:getvalues">pl.Map:getvalues (keys)</a></td> + <td class="summary">get a list of values indexed by a list of keys.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:update">pl.Map:update (table)</a></td> + <td class="summary">update the map using key/value pairs from another table.</td> + </tr> +</table> +<h2><a href="#Metamethods">Metamethods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.Map:__eq">pl.Map:__eq (m)</a></td> + <td class="summary">equality between maps.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Map:__tostring">pl.Map:__tostring ()</a></td> + <td class="summary">string representation of a map.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Fields"></a>Fields</h2> + + <dl class="function"> + <dt> + <a name = "pl.Map.keys"></a> + <strong>pl.Map.keys</strong> + </dt> + <dd> + list of keys. + + + + + + + +</dd> + <dt> + <a name = "pl.Map.values"></a> + <strong>pl.Map.values</strong> + </dt> + <dd> + list of values. + + + + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "pl.Map:iter"></a> + <strong>pl.Map:iter ()</strong> + </dt> + <dd> + return an iterator over all key-value pairs. + + + + + + + +</dd> + <dt> + <a name = "pl.Map:items"></a> + <strong>pl.Map:items ()</strong> + </dt> + <dd> + return a List of all key-value pairs, sorted by the keys. + + + + + + + +</dd> + <dt> + <a name = "pl.Map:setdefault"></a> + <strong>pl.Map:setdefault (key, default)</strong> + </dt> + <dd> + set a value in the map if it doesn't exist yet. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">key</span> + the key + </li> + <li><span class="parameter">default</span> + value to set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the value stored in the map (existing value, or the new value) + </ol> + + + + +</dd> + <dt> + <a name = "pl.Map:len"></a> + <strong>pl.Map:len ()</strong> + </dt> + <dd> + size of map. + note: this is a relatively expensive operation! + + + + + + + +</dd> + <dt> + <a name = "pl.Map:set"></a> + <strong>pl.Map:set (key, val)</strong> + </dt> + <dd> + put a value into the map. + This will remove the key if the value is <code>nil</code> + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">key</span> + the key + </li> + <li><span class="parameter">val</span> + the value + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "pl.Map:get"></a> + <strong>pl.Map:get (key)</strong> + </dt> + <dd> + get a value from the map. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">key</span> + the key + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the value, or nil if not found. + </ol> + + + + +</dd> + <dt> + <a name = "pl.Map:getvalues"></a> + <strong>pl.Map:getvalues (keys)</strong> + </dt> + <dd> + get a list of values indexed by a list of keys. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">keys</span> + a list-like table of keys + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new list + </ol> + + + + +</dd> + <dt> + <a name = "pl.Map:update"></a> + <strong>pl.Map:update (table)</strong> + </dt> + <dd> + update the map using key/value pairs from another table. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">table</span> + <span class="types"><span class="type">tab</span></span> + + + + </li> + </ul> + + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2> + + <dl class="function"> + <dt> + <a name = "pl.Map:__eq"></a> + <strong>pl.Map:__eq (m)</strong> + </dt> + <dd> + equality between maps. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">m</span> + <span class="types"><a class="type" href="../classes/pl.Map.html">Map</a></span> + another map. + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "pl.Map:__tostring"></a> + <strong>pl.Map:__tostring ()</strong> + </dt> + <dd> + string representation of a map. + + + + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/Data/Libraries/Penlight/docs/classes/pl.MultiMap.html b/Data/Libraries/Penlight/docs/classes/pl.MultiMap.html new file mode 100644 index 0000000..b711b54 --- /dev/null +++ b/Data/Libraries/Penlight/docs/classes/pl.MultiMap.html @@ -0,0 +1,207 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Penlight Documentation</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>Penlight</h1> + +<ul> + <li><a href="https://github.com/lunarmodules/Penlight">GitHub Project</a></li> + <li><a href="../index.html">Documentation</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Methods">Methods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/pl.Date.html">pl.Date</a></li> + <li><a href="../classes/pl.List.html">pl.List</a></li> + <li><a href="../classes/pl.Map.html">pl.Map</a></li> + <li><strong>pl.MultiMap</strong></li> + <li><a href="../classes/pl.OrderedMap.html">pl.OrderedMap</a></li> + <li><a href="../classes/pl.Set.html">pl.Set</a></li> +</ul> +<h2>Libraries</h2> +<ul class="nowrap"> + <li><a href="../libraries/pl.html">pl</a></li> + <li><a href="../libraries/pl.app.html">pl.app</a></li> + <li><a href="../libraries/pl.array2d.html">pl.array2d</a></li> + <li><a href="../libraries/pl.class.html">pl.class</a></li> + <li><a href="../libraries/pl.compat.html">pl.compat</a></li> + <li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li> + <li><a href="../libraries/pl.config.html">pl.config</a></li> + <li><a href="../libraries/pl.data.html">pl.data</a></li> + <li><a href="../libraries/pl.dir.html">pl.dir</a></li> + <li><a href="../libraries/pl.file.html">pl.file</a></li> + <li><a href="../libraries/pl.func.html">pl.func</a></li> + <li><a href="../libraries/pl.import_into.html">pl.import_into</a></li> + <li><a href="../libraries/pl.input.html">pl.input</a></li> + <li><a href="../libraries/pl.lapp.html">pl.lapp</a></li> + <li><a href="../libraries/pl.lexer.html">pl.lexer</a></li> + <li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li> + <li><a href="../libraries/pl.operator.html">pl.operator</a></li> + <li><a href="../libraries/pl.path.html">pl.path</a></li> + <li><a href="../libraries/pl.permute.html">pl.permute</a></li> + <li><a href="../libraries/pl.pretty.html">pl.pretty</a></li> + <li><a href="../libraries/pl.seq.html">pl.seq</a></li> + <li><a href="../libraries/pl.sip.html">pl.sip</a></li> + <li><a href="../libraries/pl.strict.html">pl.strict</a></li> + <li><a href="../libraries/pl.stringio.html">pl.stringio</a></li> + <li><a href="../libraries/pl.stringx.html">pl.stringx</a></li> + <li><a href="../libraries/pl.tablex.html">pl.tablex</a></li> + <li><a href="../libraries/pl.template.html">pl.template</a></li> + <li><a href="../libraries/pl.test.html">pl.test</a></li> + <li><a href="../libraries/pl.text.html">pl.text</a></li> + <li><a href="../libraries/pl.types.html">pl.types</a></li> + <li><a href="../libraries/pl.url.html">pl.url</a></li> + <li><a href="../libraries/pl.utils.html">pl.utils</a></li> + <li><a href="../libraries/pl.xml.html">pl.xml</a></li> +</ul> +<h2>Manual</h2> +<ul class="nowrap"> + <li><a href="../manual/01-introduction.md.html">Introduction</a></li> + <li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li> + <li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li> + <li><a href="../manual/04-paths.md.html">Paths and Directories</a></li> + <li><a href="../manual/05-dates.md.html">Date and Time</a></li> + <li><a href="../manual/06-data.md.html">Data</a></li> + <li><a href="../manual/07-functional.md.html">Functional Programming</a></li> + <li><a href="../manual/08-additional.md.html">Additional Libraries</a></li> + <li><a href="../manual/09-discussion.md.html">Technical Choices</a></li> +</ul> +<h2>Examples</h2> +<ul class="nowrap"> + <li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li> + <li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li> + <li><a href="../examples/symbols.lua.html">symbols.lua</a></li> + <li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li> + <li><a href="../examples/test-data.lua.html">test-data.lua</a></li> + <li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li> + <li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li> + <li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li> + <li><a href="../examples/testclone.lua.html">testclone.lua</a></li> + <li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li> + <li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li> + <li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li> + <li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li> + <li><a href="../examples/testxml.lua.html">testxml.lua</a></li> + <li><a href="../examples/which.lua.html">which.lua</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>pl.MultiMap</code></h1> +<p>MultiMap, a Map which has multiple values per key.</p> +<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.class.html#">pl.class</a>, <a href="../classes/pl.List.html#">pl.List</a>, <a href="../classes/pl.Map.html#">pl.Map</a></p> + + +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.MultiMap:update">pl.MultiMap:update (t)</a></td> + <td class="summary">update a MultiMap using a table.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.MultiMap:set">pl.MultiMap:set (key, val)</a></td> + <td class="summary">add a new value to a key.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "pl.MultiMap:update"></a> + <strong>pl.MultiMap:update (t)</strong> + </dt> + <dd> + update a MultiMap using a table. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + either a Multimap or a map-like table. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the map + </ol> + + + + +</dd> + <dt> + <a name = "pl.MultiMap:set"></a> + <strong>pl.MultiMap:set (key, val)</strong> + </dt> + <dd> + add a new value to a key. Setting a nil value removes the key. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">key</span> + the key + </li> + <li><span class="parameter">val</span> + the value + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the map + </ol> + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/Data/Libraries/Penlight/docs/classes/pl.OrderedMap.html b/Data/Libraries/Penlight/docs/classes/pl.OrderedMap.html new file mode 100644 index 0000000..537af37 --- /dev/null +++ b/Data/Libraries/Penlight/docs/classes/pl.OrderedMap.html @@ -0,0 +1,417 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Penlight Documentation</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>Penlight</h1> + +<ul> + <li><a href="https://github.com/lunarmodules/Penlight">GitHub Project</a></li> + <li><a href="../index.html">Documentation</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Methods">Methods</a></li> +<li><a href="#Metamethods">Metamethods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/pl.Date.html">pl.Date</a></li> + <li><a href="../classes/pl.List.html">pl.List</a></li> + <li><a href="../classes/pl.Map.html">pl.Map</a></li> + <li><a href="../classes/pl.MultiMap.html">pl.MultiMap</a></li> + <li><strong>pl.OrderedMap</strong></li> + <li><a href="../classes/pl.Set.html">pl.Set</a></li> +</ul> +<h2>Libraries</h2> +<ul class="nowrap"> + <li><a href="../libraries/pl.html">pl</a></li> + <li><a href="../libraries/pl.app.html">pl.app</a></li> + <li><a href="../libraries/pl.array2d.html">pl.array2d</a></li> + <li><a href="../libraries/pl.class.html">pl.class</a></li> + <li><a href="../libraries/pl.compat.html">pl.compat</a></li> + <li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li> + <li><a href="../libraries/pl.config.html">pl.config</a></li> + <li><a href="../libraries/pl.data.html">pl.data</a></li> + <li><a href="../libraries/pl.dir.html">pl.dir</a></li> + <li><a href="../libraries/pl.file.html">pl.file</a></li> + <li><a href="../libraries/pl.func.html">pl.func</a></li> + <li><a href="../libraries/pl.import_into.html">pl.import_into</a></li> + <li><a href="../libraries/pl.input.html">pl.input</a></li> + <li><a href="../libraries/pl.lapp.html">pl.lapp</a></li> + <li><a href="../libraries/pl.lexer.html">pl.lexer</a></li> + <li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li> + <li><a href="../libraries/pl.operator.html">pl.operator</a></li> + <li><a href="../libraries/pl.path.html">pl.path</a></li> + <li><a href="../libraries/pl.permute.html">pl.permute</a></li> + <li><a href="../libraries/pl.pretty.html">pl.pretty</a></li> + <li><a href="../libraries/pl.seq.html">pl.seq</a></li> + <li><a href="../libraries/pl.sip.html">pl.sip</a></li> + <li><a href="../libraries/pl.strict.html">pl.strict</a></li> + <li><a href="../libraries/pl.stringio.html">pl.stringio</a></li> + <li><a href="../libraries/pl.stringx.html">pl.stringx</a></li> + <li><a href="../libraries/pl.tablex.html">pl.tablex</a></li> + <li><a href="../libraries/pl.template.html">pl.template</a></li> + <li><a href="../libraries/pl.test.html">pl.test</a></li> + <li><a href="../libraries/pl.text.html">pl.text</a></li> + <li><a href="../libraries/pl.types.html">pl.types</a></li> + <li><a href="../libraries/pl.url.html">pl.url</a></li> + <li><a href="../libraries/pl.utils.html">pl.utils</a></li> + <li><a href="../libraries/pl.xml.html">pl.xml</a></li> +</ul> +<h2>Manual</h2> +<ul class="nowrap"> + <li><a href="../manual/01-introduction.md.html">Introduction</a></li> + <li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li> + <li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li> + <li><a href="../manual/04-paths.md.html">Paths and Directories</a></li> + <li><a href="../manual/05-dates.md.html">Date and Time</a></li> + <li><a href="../manual/06-data.md.html">Data</a></li> + <li><a href="../manual/07-functional.md.html">Functional Programming</a></li> + <li><a href="../manual/08-additional.md.html">Additional Libraries</a></li> + <li><a href="../manual/09-discussion.md.html">Technical Choices</a></li> +</ul> +<h2>Examples</h2> +<ul class="nowrap"> + <li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li> + <li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li> + <li><a href="../examples/symbols.lua.html">symbols.lua</a></li> + <li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li> + <li><a href="../examples/test-data.lua.html">test-data.lua</a></li> + <li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li> + <li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li> + <li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li> + <li><a href="../examples/testclone.lua.html">testclone.lua</a></li> + <li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li> + <li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li> + <li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li> + <li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li> + <li><a href="../examples/testxml.lua.html">testxml.lua</a></li> + <li><a href="../examples/which.lua.html">which.lua</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>pl.OrderedMap</code></h1> +<p>OrderedMap, a map which preserves ordering.</p> +<p> Derived from <a href="../classes/pl.Map.html#">pl.Map</a>.</p> + +<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.tablex.html#">pl.tablex</a>, <a href="../libraries/pl.class.html#">pl.class</a>, <a href="../classes/pl.List.html#">pl.List</a>, <a href="../classes/pl.Map.html#">pl.Map</a></p> + + +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:_init">pl.OrderedMap:_init (t)</a></td> + <td class="summary">construct an OrderedMap.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:update">pl.OrderedMap:update (t)</a></td> + <td class="summary">update an OrderedMap using a table.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:set">pl.OrderedMap:set (key, val)</a></td> + <td class="summary">set the key's value.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:insert">pl.OrderedMap:insert (pos, key, val)</a></td> + <td class="summary">insert a key/value pair before a given position.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:keys">pl.OrderedMap:keys ()</a></td> + <td class="summary">return the keys in order.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:values">pl.OrderedMap:values ()</a></td> + <td class="summary">return the values in order.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:sort">pl.OrderedMap:sort (cmp)</a></td> + <td class="summary">sort the keys.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:iter">pl.OrderedMap:iter ()</a></td> + <td class="summary">iterate over key-value pairs in order.</td> + </tr> +</table> +<h2><a href="#Metamethods">Metamethods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:__pairs">pl.OrderedMap:__pairs ()</a></td> + <td class="summary">iterate over an ordered map (5.2).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.OrderedMap:__tostring">pl.OrderedMap:__tostring ()</a></td> + <td class="summary">string representation of an ordered map.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "pl.OrderedMap:_init"></a> + <strong>pl.OrderedMap:_init (t)</strong> + </dt> + <dd> + construct an OrderedMap. + Will throw an error if the argument is bad. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + optional initialization table, same as for <a href="../classes/pl.OrderedMap.html#pl.OrderedMap:update">OrderedMap:update</a> + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:update"></a> + <strong>pl.OrderedMap:update (t)</strong> + </dt> + <dd> + update an OrderedMap using a table. + If the table is itself an OrderedMap, then its entries will be appended. + if it s a table of the form <code>{{key1=val1},{key2=val2},...}</code> these will be appended.</p> + +<p> Otherwise, it is assumed to be a map-like table, and order of extra entries is arbitrary. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + <span class="types"><span class="type">tab</span></span> + a table. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + <li> + the map, or nil in case of error</li> + <li> + the error message</li> + </ol> + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:set"></a> + <strong>pl.OrderedMap:set (key, val)</strong> + </dt> + <dd> + set the key's value. This key will be appended at the end of the map.</p> + +<p> If the value is nil, then the key is removed. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">key</span> + the key + </li> + <li><span class="parameter">val</span> + the value + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the map + </ol> + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:insert"></a> + <strong>pl.OrderedMap:insert (pos, key, val)</strong> + </dt> + <dd> + insert a key/value pair before a given position. + Note: if the map already contains the key, then this effectively + moves the item to the new position by first removing at the old position. + Has no effect if the key does not exist and val is nil + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">pos</span> + <span class="types"><span class="type">int</span></span> + a position starting at 1 + </li> + <li><span class="parameter">key</span> + the key + </li> + <li><span class="parameter">val</span> + the value; if nil use the old value + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:keys"></a> + <strong>pl.OrderedMap:keys ()</strong> + </dt> + <dd> + return the keys in order. + (Not a copy!) + + + + <h3>Returns:</h3> + <ol> + + List + </ol> + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:values"></a> + <strong>pl.OrderedMap:values ()</strong> + </dt> + <dd> + return the values in order. + this is relatively expensive. + + + + <h3>Returns:</h3> + <ol> + + List + </ol> + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:sort"></a> + <strong>pl.OrderedMap:sort (cmp)</strong> + </dt> + <dd> + sort the keys. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">cmp</span> + <span class="types"><span class="type">func</span></span> + a comparison function as for <a href="https://www.lua.org/manual/5.1/manual.html#pdf-table.sort">table.sort</a> + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + the map + </ol> + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:iter"></a> + <strong>pl.OrderedMap:iter ()</strong> + </dt> + <dd> + iterate over key-value pairs in order. + + + + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2> + + <dl class="function"> + <dt> + <a name = "pl.OrderedMap:__pairs"></a> + <strong>pl.OrderedMap:__pairs ()</strong> + </dt> + <dd> + iterate over an ordered map (5.2). + + + + + + + +</dd> + <dt> + <a name = "pl.OrderedMap:__tostring"></a> + <strong>pl.OrderedMap:__tostring ()</strong> + </dt> + <dd> + string representation of an ordered map. + + + + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> diff --git a/Data/Libraries/Penlight/docs/classes/pl.Set.html b/Data/Libraries/Penlight/docs/classes/pl.Set.html new file mode 100644 index 0000000..31cfcee --- /dev/null +++ b/Data/Libraries/Penlight/docs/classes/pl.Set.html @@ -0,0 +1,655 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> +<head> + <title>Penlight Documentation</title> + <link rel="stylesheet" href="../ldoc_fixed.css" type="text/css" /> +</head> +<body> + +<div id="container"> + +<div id="product"> + <div id="product_logo"></div> + <div id="product_name"><big><b></b></big></div> + <div id="product_description"></div> +</div> <!-- id="product" --> + + +<div id="main"> + + +<!-- Menu --> + +<div id="navigation"> +<br/> +<h1>Penlight</h1> + +<ul> + <li><a href="https://github.com/lunarmodules/Penlight">GitHub Project</a></li> + <li><a href="../index.html">Documentation</a></li> +</ul> + +<h2>Contents</h2> +<ul> +<li><a href="#Methods">Methods</a></li> +<li><a href="#Metamethods">Metamethods</a></li> +</ul> + + +<h2>Classes</h2> +<ul class="nowrap"> + <li><a href="../classes/pl.Date.html">pl.Date</a></li> + <li><a href="../classes/pl.List.html">pl.List</a></li> + <li><a href="../classes/pl.Map.html">pl.Map</a></li> + <li><a href="../classes/pl.MultiMap.html">pl.MultiMap</a></li> + <li><a href="../classes/pl.OrderedMap.html">pl.OrderedMap</a></li> + <li><strong>pl.Set</strong></li> +</ul> +<h2>Libraries</h2> +<ul class="nowrap"> + <li><a href="../libraries/pl.html">pl</a></li> + <li><a href="../libraries/pl.app.html">pl.app</a></li> + <li><a href="../libraries/pl.array2d.html">pl.array2d</a></li> + <li><a href="../libraries/pl.class.html">pl.class</a></li> + <li><a href="../libraries/pl.compat.html">pl.compat</a></li> + <li><a href="../libraries/pl.comprehension.html">pl.comprehension</a></li> + <li><a href="../libraries/pl.config.html">pl.config</a></li> + <li><a href="../libraries/pl.data.html">pl.data</a></li> + <li><a href="../libraries/pl.dir.html">pl.dir</a></li> + <li><a href="../libraries/pl.file.html">pl.file</a></li> + <li><a href="../libraries/pl.func.html">pl.func</a></li> + <li><a href="../libraries/pl.import_into.html">pl.import_into</a></li> + <li><a href="../libraries/pl.input.html">pl.input</a></li> + <li><a href="../libraries/pl.lapp.html">pl.lapp</a></li> + <li><a href="../libraries/pl.lexer.html">pl.lexer</a></li> + <li><a href="../libraries/pl.luabalanced.html">pl.luabalanced</a></li> + <li><a href="../libraries/pl.operator.html">pl.operator</a></li> + <li><a href="../libraries/pl.path.html">pl.path</a></li> + <li><a href="../libraries/pl.permute.html">pl.permute</a></li> + <li><a href="../libraries/pl.pretty.html">pl.pretty</a></li> + <li><a href="../libraries/pl.seq.html">pl.seq</a></li> + <li><a href="../libraries/pl.sip.html">pl.sip</a></li> + <li><a href="../libraries/pl.strict.html">pl.strict</a></li> + <li><a href="../libraries/pl.stringio.html">pl.stringio</a></li> + <li><a href="../libraries/pl.stringx.html">pl.stringx</a></li> + <li><a href="../libraries/pl.tablex.html">pl.tablex</a></li> + <li><a href="../libraries/pl.template.html">pl.template</a></li> + <li><a href="../libraries/pl.test.html">pl.test</a></li> + <li><a href="../libraries/pl.text.html">pl.text</a></li> + <li><a href="../libraries/pl.types.html">pl.types</a></li> + <li><a href="../libraries/pl.url.html">pl.url</a></li> + <li><a href="../libraries/pl.utils.html">pl.utils</a></li> + <li><a href="../libraries/pl.xml.html">pl.xml</a></li> +</ul> +<h2>Manual</h2> +<ul class="nowrap"> + <li><a href="../manual/01-introduction.md.html">Introduction</a></li> + <li><a href="../manual/02-arrays.md.html">Tables and Arrays</a></li> + <li><a href="../manual/03-strings.md.html">Strings. Higher-level operations on strings.</a></li> + <li><a href="../manual/04-paths.md.html">Paths and Directories</a></li> + <li><a href="../manual/05-dates.md.html">Date and Time</a></li> + <li><a href="../manual/06-data.md.html">Data</a></li> + <li><a href="../manual/07-functional.md.html">Functional Programming</a></li> + <li><a href="../manual/08-additional.md.html">Additional Libraries</a></li> + <li><a href="../manual/09-discussion.md.html">Technical Choices</a></li> +</ul> +<h2>Examples</h2> +<ul class="nowrap"> + <li><a href="../examples/seesubst.lua.html">seesubst.lua</a></li> + <li><a href="../examples/sipscan.lua.html">sipscan.lua</a></li> + <li><a href="../examples/symbols.lua.html">symbols.lua</a></li> + <li><a href="../examples/test-cmp.lua.html">test-cmp.lua</a></li> + <li><a href="../examples/test-data.lua.html">test-data.lua</a></li> + <li><a href="../examples/test-listcallbacks.lua.html">test-listcallbacks.lua</a></li> + <li><a href="../examples/test-pretty.lua.html">test-pretty.lua</a></li> + <li><a href="../examples/test-symbols.lua.html">test-symbols.lua</a></li> + <li><a href="../examples/testclone.lua.html">testclone.lua</a></li> + <li><a href="../examples/testconfig.lua.html">testconfig.lua</a></li> + <li><a href="../examples/testglobal.lua.html">testglobal.lua</a></li> + <li><a href="../examples/testinputfields.lua.html">testinputfields.lua</a></li> + <li><a href="../examples/testinputfields2.lua.html">testinputfields2.lua</a></li> + <li><a href="../examples/testxml.lua.html">testxml.lua</a></li> + <li><a href="../examples/which.lua.html">which.lua</a></li> +</ul> + +</div> + +<div id="content"> + +<h1>Class <code>pl.Set</code></h1> +<p>A Set class.</p> +<p> + + + +<pre> +> Set = <span class="global">require</span> <span class="string">'pl.Set'</span> +> = Set{<span class="string">'one'</span>,<span class="string">'two'</span>} == Set{<span class="string">'two'</span>,<span class="string">'one'</span>} +<span class="keyword">true</span> +> fruit = Set{<span class="string">'apple'</span>,<span class="string">'banana'</span>,<span class="string">'orange'</span>} +> = fruit[<span class="string">'banana'</span>] +<span class="keyword">true</span> +> = fruit[<span class="string">'hazelnut'</span>] +<span class="keyword">nil</span> +> colours = Set{<span class="string">'red'</span>,<span class="string">'orange'</span>,<span class="string">'green'</span>,<span class="string">'blue'</span>} +> = fruit,colours +[apple,orange,banana] [blue,green,orange,red] +> = fruit+colours +[blue,green,apple,red,orange,banana] +[orange] +> more_fruits = fruit + <span class="string">'apricot'</span> +> = fruit*colours + = more_fruits, fruit +banana,apricot,apple,orange] [banana,apple,orange] +</pre> + +<p> Dependencies: <a href="../libraries/pl.utils.html#">pl.utils</a>, <a href="../libraries/pl.tablex.html#">pl.tablex</a>, <a href="../libraries/pl.class.html#">pl.class</a>, <a href="../classes/pl.Map.html#">pl.Map</a>, (<a href="../classes/pl.List.html#">pl.List</a> if __tostring is used)</p> +</p> + + +<h2><a href="#Methods">Methods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.Set:Set">pl.Set:Set (t)</a></td> + <td class="summary">create a set.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:values">pl.Set:values (self)</a></td> + <td class="summary">get a list of the values in a set.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:map">pl.Set:map (self, fn, ...)</a></td> + <td class="summary">map a function over the values of a set.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:union">pl.Set:union (self, set)</a></td> + <td class="summary">union of two sets (also +).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:intersection">pl.Set:intersection (self, set)</a></td> + <td class="summary">intersection of two sets (also *).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:difference">pl.Set:difference (self, set)</a></td> + <td class="summary">new set with elements in the set that are not in the other (also -).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:issubset">pl.Set:issubset (self, set)</a></td> + <td class="summary">is the first set a subset of the second (also <)?.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:isempty">pl.Set:isempty (self)</a></td> + <td class="summary">is the set empty?.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:isdisjoint">pl.Set:isdisjoint (s1, s2)</a></td> + <td class="summary">are the sets disjoint?</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:len">pl.Set:len (s)</a></td> + <td class="summary">size of this set (also # for 5.2).</td> + </tr> +</table> +<h2><a href="#Metamethods">Metamethods</a></h2> +<table class="function_list"> + <tr> + <td class="name" nowrap><a href="#pl.Set:__tostring">pl.Set:__tostring ()</a></td> + <td class="summary">string representation of a set.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__add">pl.Set:__add ()</a></td> + <td class="summary">union of sets.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__mul">pl.Set:__mul ()</a></td> + <td class="summary">intersection of sets.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__sub">pl.Set:__sub ()</a></td> + <td class="summary">difference of sets.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__pow">pl.Set:__pow ()</a></td> + <td class="summary">symmetric difference of sets.</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__lt">pl.Set:__lt ()</a></td> + <td class="summary">first set subset of second?</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__len">pl.Set:__len ()</a></td> + <td class="summary">cardinality of set (5.2).</td> + </tr> + <tr> + <td class="name" nowrap><a href="#pl.Set:__eq">pl.Set:__eq (s1, s2)</a></td> + <td class="summary">equality between sets.</td> + </tr> +</table> + +<br/> +<br/> + + + <h2 class="section-header "><a name="Methods"></a>Methods</h2> + + <dl class="function"> + <dt> + <a name = "pl.Set:Set"></a> + <strong>pl.Set:Set (t)</strong> + </dt> + <dd> + create a set. <br> + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">t</span> + may be a Set, Map or list-like table. + </li> + </ul> + + + + + +</dd> + <dt> + <a name = "pl.Set:values"></a> + <strong>pl.Set:values (self)</strong> + </dt> + <dd> + get a list of the values in a set. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a list + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:map"></a> + <strong>pl.Set:map (self, fn, ...)</strong> + </dt> + <dd> + map a function over the values of a set. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + <li><span class="parameter">fn</span> + a function + </li> + <li><span class="parameter">...</span> + extra arguments to pass to the function. + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new set + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:union"></a> + <strong>pl.Set:union (self, set)</strong> + </dt> + <dd> + union of two sets (also +). + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + <li><span class="parameter">set</span> + another set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new set + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:intersection"></a> + <strong>pl.Set:intersection (self, set)</strong> + </dt> + <dd> + intersection of two sets (also *). + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + <li><span class="parameter">set</span> + another set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new set + </ol> + + + + <h3>Usage:</h3> + <ul> + <pre class="example">> s = Set{<span class="number">10</span>,<span class="number">20</span>,<span class="number">30</span>} +> t = Set{<span class="number">20</span>,<span class="number">30</span>,<span class="number">40</span>} +> = t +[<span class="number">20</span>,<span class="number">30</span>,<span class="number">40</span>] +> = Set.intersection(s,t) +[<span class="number">30</span>,<span class="number">20</span>] +> = s*t +[<span class="number">30</span>,<span class="number">20</span>]</pre> + </ul> + +</dd> + <dt> + <a name = "pl.Set:difference"></a> + <strong>pl.Set:difference (self, set)</strong> + </dt> + <dd> + new set with elements in the set that are not in the other (also -). + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + <li><span class="parameter">set</span> + another set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + a new set + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:issubset"></a> + <strong>pl.Set:issubset (self, set)</strong> + </dt> + <dd> + is the first set a subset of the second (also <)?. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + <li><span class="parameter">set</span> + another set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true or false + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:isempty"></a> + <strong>pl.Set:isempty (self)</strong> + </dt> + <dd> + is the set empty?. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">self</span> + a Set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true or false + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:isdisjoint"></a> + <strong>pl.Set:isdisjoint (s1, s2)</strong> + </dt> + <dd> + are the sets disjoint? (no elements in common). + Uses naive definition, i.e. that intersection is empty + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">s1</span> + a Set + </li> + <li><span class="parameter">s2</span> + another set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + true or false + </ol> + + + + +</dd> + <dt> + <a name = "pl.Set:len"></a> + <strong>pl.Set:len (s)</strong> + </dt> + <dd> + size of this set (also # for 5.2). + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">s</span> + a Set + </li> + </ul> + + <h3>Returns:</h3> + <ol> + + size + </ol> + + + + +</dd> +</dl> + <h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2> + + <dl class="function"> + <dt> + <a name = "pl.Set:__tostring"></a> + <strong>pl.Set:__tostring ()</strong> + </dt> + <dd> + string representation of a set. + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__add"></a> + <strong>pl.Set:__add ()</strong> + </dt> + <dd> + union of sets. + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__mul"></a> + <strong>pl.Set:__mul ()</strong> + </dt> + <dd> + intersection of sets. + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__sub"></a> + <strong>pl.Set:__sub ()</strong> + </dt> + <dd> + difference of sets. + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__pow"></a> + <strong>pl.Set:__pow ()</strong> + </dt> + <dd> + symmetric difference of sets. + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__lt"></a> + <strong>pl.Set:__lt ()</strong> + </dt> + <dd> + first set subset of second? + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__len"></a> + <strong>pl.Set:__len ()</strong> + </dt> + <dd> + cardinality of set (5.2). + + + + + + + +</dd> + <dt> + <a name = "pl.Set:__eq"></a> + <strong>pl.Set:__eq (s1, s2)</strong> + </dt> + <dd> + equality between sets. + + + <h3>Parameters:</h3> + <ul> + <li><span class="parameter">s1</span> + + + + </li> + <li><span class="parameter">s2</span> + + + + </li> + </ul> + + + + + +</dd> +</dl> + + +</div> <!-- id="content" --> +</div> <!-- id="main" --> +<div id="about"> +<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> +</div> <!-- id="about" --> +</div> <!-- id="container" --> +</body> +</html> |