aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Set.is_subset_of.3
blob: 7c94c896157dcbd3385d59bf6cec028357596540 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
'\" t
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
.TH Set.is_subset_of 3 2025-04-21T14:54:02.049532 "Tomo man-pages"
.SH NAME
Set.is_subset_of \- check if a set is a subset
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
.BI Set.is_subset_of\ :\ func(set:\ |T|,\ other:\ |T|,\ strict:\ Bool\ =\ no\ ->\ Bool)
.fi
.SH DESCRIPTION
Checks if the set is a subset of another set.


.SH ARGUMENTS

.TS
allbox;
lb lb lbx lb
l l l l.
Name	Type	Description	Default
set	|T|	The set to check. 	-
other	|T|	The set to compare against. 	-
strict	Bool	If `yes`, checks if the set is a strict subset (does not equal the other set). 	no
.TE
.SH RETURN
`yes` if the set is a subset of the other set (strictly or not), `no` otherwise.

.SH EXAMPLES
.EX
>> |1, 2|.is_subset_of(|1, 2, 3|)
= yes
.EE