mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
---
|
|
layout: default
|
|
---
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
|
|
|
<h1 id="function-setissubset">Function setIsSubset <a href="#function-setissubset" title="Permalink">#</a></h1>
|
|
|
|
Check whether a (multi)set is a subset of another (multi)set. (Every element of set1 is the element of set2.)
|
|
Multi-dimension arrays will be converted to single-dimension arrays before the operation.
|
|
|
|
|
|
<h2 id="syntax">Syntax <a href="#syntax" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
math.setIsSubset(set1, set2)
|
|
```
|
|
|
|
<h3 id="parameters">Parameters <a href="#parameters" title="Permalink">#</a></h3>
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`a1` | Array | Matrix | A (multi)set
|
|
`a2` | Array | Matrix | A (multi)set
|
|
|
|
<h3 id="returns">Returns <a href="#returns" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
boolean | Returns true when a1 is a subset of a2, returns false otherwise
|
|
|
|
|
|
<h3 id="throws">Throws <a href="#throws" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
|
|
|
|
<h2 id="examples">Examples <a href="#examples" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
math.setIsSubset([1, 2], [3, 4, 5, 6]) // returns false
|
|
math.setIsSubset([3, 4], [3, 4, 5, 6]) // returns true
|
|
```
|
|
|
|
|
|
<h2 id="see-also">See also <a href="#see-also" title="Permalink">#</a></h2>
|
|
|
|
[setUnion](setUnion.html),
|
|
[setIntersect](setIntersect.html),
|
|
[setDifference](setDifference.html)
|