Module:Set/doc - Revision history

Uzume: /* top */ +Template:Lua

2021-11-16T03:03:12Z

← Previous revision		Revision as of 03:03, 16 November 2021
Line 1:		Line 1:
	{{module rating\|alpha}}		{{module rating\|alpha}}
			{{Lua\|Module:TableTools}}

	This module includes a number of set operations for Lua tables. It currently has [[Union (set theory)\|union]], [[Intersection (set theory)\|intersection]] and [[Complement (set theory)\|complement]] functions for both key/value pairs and for values only. It is a meta-module, meant to be called from other Lua modules, and should not be called directly from #invoke.		This module includes a number of set operations for Lua tables. It currently has [[Union (set theory)\|union]], [[Intersection (set theory)\|intersection]] and [[Complement (set theory)\|complement]] functions for both key/value pairs and for values only. It is a meta-module, meant to be called from other Lua modules, and should not be called directly from #invoke.

Dinoguy1000: /* valueComplement */ match sample "complement" function call

2021-10-06T04:56:22Z

valueComplement: match sample "complement" function call

← Previous revision		Revision as of 04:56, 6 October 2021
Line 54:		Line 54:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	set.valueComplement(t1, t2, ...)		set.valueComplement(t1, t2, ..., tn)
	</syntaxhighlight>		</syntaxhighlight>

WOSlinker: change source to syntaxhighlight

2020-08-21T07:41:12Z

change source to syntaxhighlight

← Previous revision		Revision as of 07:41, 21 August 2020
Line 7:		Line 7:
	To use any of the functions, first you must load the module.		To use any of the functions, first you must load the module.

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local set = require('Module:Set')		local set = require('Module:Set')
			</syntaxhighlight>
	</source>

	== union ==		== union ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	set.union(t1, t2, ...)		set.union(t1, t2, ...)
			</syntaxhighlight>
	</source>

	Returns the union of the key/value pairs of n tables. If any of the tables contain different values for the same table key, the table value is converted to an array holding all of the different values. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, union will return <code style="white-space: nowrap;">{foo = "foo", bar = {"bar", "baz"}, qux = "qux"}</code>. An error is raised if the function receives less than two tables as arguments.		Returns the union of the key/value pairs of n tables. If any of the tables contain different values for the same table key, the table value is converted to an array holding all of the different values. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, union will return <code style="white-space: nowrap;">{foo = "foo", bar = {"bar", "baz"}, qux = "qux"}</code>. An error is raised if the function receives less than two tables as arguments.
Line 21:		Line 21:
	== valueUnion ==		== valueUnion ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	set.valueUnion(t1, t2, ...)		set.valueUnion(t1, t2, ...)
			</syntaxhighlight>
	</source>

	Returns the union of the values of n tables, as an array. For example, for the tables <code style="white-space: nowrap;">{1, 3, 4, 5, foo = 7}</code> and <code style="white-space: nowrap;">{2, bar = 3, 5, 6}</code>, valueUnion will return <code style="white-space: nowrap;">{1, 2, 3, 4, 5, 6, 7}</code>. An error is raised if the function receives less than two tables as arguments.		Returns the union of the values of n tables, as an array. For example, for the tables <code style="white-space: nowrap;">{1, 3, 4, 5, foo = 7}</code> and <code style="white-space: nowrap;">{2, bar = 3, 5, 6}</code>, valueUnion will return <code style="white-space: nowrap;">{1, 2, 3, 4, 5, 6, 7}</code>. An error is raised if the function receives less than two tables as arguments.
Line 29:		Line 29:
	== intersection ==		== intersection ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	set.intersection(t1, t2, ...)		set.intersection(t1, t2, ...)
			</syntaxhighlight>
	</source>

	Returns the intersection of the key/value pairs of n tables. Both the key and the value must match to be included in the resulting table. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, intersection will return <code style="white-space: nowrap;">{foo = "foo"}</code>. An error is raised if the function receives less than two tables as arguments.		Returns the intersection of the key/value pairs of n tables. Both the key and the value must match to be included in the resulting table. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, intersection will return <code style="white-space: nowrap;">{foo = "foo"}</code>. An error is raised if the function receives less than two tables as arguments.
Line 37:		Line 37:
	== valueIntersection ==		== valueIntersection ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	set.valueIntersection(t1, t2, ...)		set.valueIntersection(t1, t2, ...)
			</syntaxhighlight>
	</source>

	Returns the intersection of the values of n tables, as an array. For example, for the tables <code style="white-space: nowrap;">{1, 3, 4, 5, foo = 7}</code> and <code style="white-space: nowrap;">{2, bar = 3, 5, 6}</code>, valueIntersection will return <code style="white-space: nowrap;">{3, 5}</code>. An error is raised if the function receives less than two tables as arguments.		Returns the intersection of the values of n tables, as an array. For example, for the tables <code style="white-space: nowrap;">{1, 3, 4, 5, foo = 7}</code> and <code style="white-space: nowrap;">{2, bar = 3, 5, 6}</code>, valueIntersection will return <code style="white-space: nowrap;">{3, 5}</code>. An error is raised if the function receives less than two tables as arguments.
Line 45:		Line 45:
	== complement ==		== complement ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	set.complement(t1, t2, ..., tn)		set.complement(t1, t2, ..., tn)
			</syntaxhighlight>
	</source>

	Returns the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of key/value pairs. This is equivalent to all the key/value pairs that are in <code>''tn''</code> but are not in any of <code>''t1''</code>, <code>''t2''</code>, ... <code>''tn-1''</code>. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar", baz = "baz"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, complement would return <code style="white-space: nowrap;">{bar = "baz", qux = "qux"}</code>. An error is raised if the function receives less than two tables as arguments.		Returns the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of key/value pairs. This is equivalent to all the key/value pairs that are in <code>''tn''</code> but are not in any of <code>''t1''</code>, <code>''t2''</code>, ... <code>''tn-1''</code>. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar", baz = "baz"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, complement would return <code style="white-space: nowrap;">{bar = "baz", qux = "qux"}</code>. An error is raised if the function receives less than two tables as arguments.
Line 53:		Line 53:
	== valueComplement ==		== valueComplement ==

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	set.valueComplement(t1, t2, ...)		set.valueComplement(t1, t2, ...)
			</syntaxhighlight>
	</source>

	This returns an array containing the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of values only. This is equivalent to all the values that are in tn but are not in t1, t2, ... tn-1. For example, for the tables <code style="white-space: nowrap;">{1, 2}</code>, <code style="white-space: nowrap;">{1, 2, 3}</code> and <code style="white-space: nowrap;">{1, 2, 3, 4, 5}</code>, valueComplement would return <code style="white-space: nowrap;">{4, 5}</code>. An error is raised if the function receives less than two tables as arguments.		This returns an array containing the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of values only. This is equivalent to all the values that are in tn but are not in t1, t2, ... tn-1. For example, for the tables <code style="white-space: nowrap;">{1, 2}</code>, <code style="white-space: nowrap;">{1, 2, 3}</code> and <code style="white-space: nowrap;">{1, 2, 3, 4, 5}</code>, valueComplement would return <code style="white-space: nowrap;">{4, 5}</code>. An error is raised if the function receives less than two tables as arguments.

Graeme Bartlett: remove tfd

2020-08-02T23:46:43Z

remove tfd

← Previous revision		Revision as of 23:46, 2 August 2020
Line 1:		Line 1:
	{{Template for discussion/dated\|action=\|page=Set/doc\|link=Wikipedia:Templates for discussion/Log/2020 June 22#Module:Set\|type=module\|bigbox=yes}}
	{{module rating\|alpha}}		{{module rating\|alpha}}

Pppery: Tfd

2020-06-22T21:49:07Z

Tfd

← Previous revision		Revision as of 21:49, 22 June 2020
Line 1:		Line 1:
			{{Template for discussion/dated\|action=\|page=Set/doc\|link=Wikipedia:Templates for discussion/Log/2020 June 22#Module:Set\|type=module\|bigbox=yes}}
	{{module rating\|alpha}}		{{module rating\|alpha}}

Eric Wieser at 11:54, 7 June 2015

2015-06-07T11:54:14Z

← Previous revision		Revision as of 11:54, 7 June 2015
Line 58:		Line 58:

	This returns an array containing the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of values only. This is equivalent to all the values that are in tn but are not in t1, t2, ... tn-1. For example, for the tables <code style="white-space: nowrap;">{1, 2}</code>, <code style="white-space: nowrap;">{1, 2, 3}</code> and <code style="white-space: nowrap;">{1, 2, 3, 4, 5}</code>, valueComplement would return <code style="white-space: nowrap;">{4, 5}</code>. An error is raised if the function receives less than two tables as arguments.		This returns an array containing the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of values only. This is equivalent to all the values that are in tn but are not in t1, t2, ... tn-1. For example, for the tables <code style="white-space: nowrap;">{1, 2}</code>, <code style="white-space: nowrap;">{1, 2, 3}</code> and <code style="white-space: nowrap;">{1, 2, 3, 4, 5}</code>, valueComplement would return <code style="white-space: nowrap;">{4, 5}</code>. An error is raised if the function receives less than two tables as arguments.

			<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|{{#ifeq:{{SUBPAGENAME}}\|testcases\|\|
			<!--Categories below here, please; interwikis to Wikidata.-->
			[[Category:Lua metamodules]]
			}}}}</includeonly>

Mr. Stradivarius: copy documentation from Module:TableTools/doc and modify slightly

2013-12-20T05:45:18Z

copy documentation from Module:TableTools/doc and modify slightly

New page

{{module rating|alpha}}

This module includes a number of set operations for Lua tables. It currently has [[Union (set theory)|union]], [[Intersection (set theory)|intersection]] and [[Complement (set theory)|complement]] functions for both key/value pairs and for values only. It is a meta-module, meant to be called from other Lua modules, and should not be called directly from #invoke.

== Loading the module ==

To use any of the functions, first you must load the module.

<source lang="lua">
local set = require('Module:Set')
</source>

== union ==

<source lang="lua">
set.union(t1, t2, ...)
</source>

Returns the union of the key/value pairs of n tables. If any of the tables contain different values for the same table key, the table value is converted to an array holding all of the different values. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, union will return <code style="white-space: nowrap;">{foo = "foo", bar = {"bar", "baz"}, qux = "qux"}</code>. An error is raised if the function receives less than two tables as arguments.

== valueUnion ==

<source lang="lua">
set.valueUnion(t1, t2, ...)
</source>

Returns the union of the values of n tables, as an array. For example, for the tables <code style="white-space: nowrap;">{1, 3, 4, 5, foo = 7}</code> and <code style="white-space: nowrap;">{2, bar = 3, 5, 6}</code>, valueUnion will return <code style="white-space: nowrap;">{1, 2, 3, 4, 5, 6, 7}</code>. An error is raised if the function receives less than two tables as arguments.

== intersection ==

<source lang="lua">
set.intersection(t1, t2, ...)
</source>

Returns the intersection of the key/value pairs of n tables. Both the key and the value must match to be included in the resulting table. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, intersection will return <code style="white-space: nowrap;">{foo = "foo"}</code>. An error is raised if the function receives less than two tables as arguments.

== valueIntersection ==

<source lang="lua">
set.valueIntersection(t1, t2, ...)
</source>

Returns the intersection of the values of n tables, as an array. For example, for the tables <code style="white-space: nowrap;">{1, 3, 4, 5, foo = 7}</code> and <code style="white-space: nowrap;">{2, bar = 3, 5, 6}</code>, valueIntersection will return <code style="white-space: nowrap;">{3, 5}</code>. An error is raised if the function receives less than two tables as arguments.

== complement ==

<source lang="lua">
set.complement(t1, t2, ..., tn)
</source>

Returns the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of key/value pairs. This is equivalent to all the key/value pairs that are in <code>''tn''</code> but are not in any of <code>''t1''</code>, <code>''t2''</code>, ... <code>''tn-1''</code>. For example, for the tables <code style="white-space: nowrap;">{foo = "foo", bar = "bar", baz = "baz"}</code> and <code style="white-space: nowrap;">{foo = "foo", bar = "baz", qux = "qux"}</code>, complement would return <code style="white-space: nowrap;">{bar = "baz", qux = "qux"}</code>. An error is raised if the function receives less than two tables as arguments.

== valueComplement ==

<source lang="lua">
set.valueComplement(t1, t2, ...)
</source>

This returns an array containing the [[relative complement]] of <code>''t1''</code>, <code>''t2''</code>, ..., in <code>''tn''</code>. The complement is of values only. This is equivalent to all the values that are in tn but are not in t1, t2, ... tn-1. For example, for the tables <code style="white-space: nowrap;">{1, 2}</code>, <code style="white-space: nowrap;">{1, 2, 3}</code> and <code style="white-space: nowrap;">{1, 2, 3, 4, 5}</code>, valueComplement would return <code style="white-space: nowrap;">{4, 5}</code>. An error is raised if the function receives less than two tables as arguments.