aboutsummaryrefslogtreecommitdiff
path: root/man/man3/tomo-Table.difference.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/tomo-Table.difference.3')
-rw-r--r--man/man3/tomo-Table.difference.336
1 files changed, 36 insertions, 0 deletions
diff --git a/man/man3/tomo-Table.difference.3 b/man/man3/tomo-Table.difference.3
new file mode 100644
index 00000000..8f123834
--- /dev/null
+++ b/man/man3/tomo-Table.difference.3
@@ -0,0 +1,36 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Table.difference 3 2025-09-21 "Tomo man-pages"
+.SH NAME
+Table.difference \- return a table using keys not present in both tables
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI Table.difference\ :\ func(t:\ {K:V},\ other:\ {K:V}\ ->\ {K:V})
+.fi
+.SH DESCRIPTION
+Return a table whose key/value pairs correspond to keys only present in one table, but not the other.
+
+
+.SH ARGUMENTS
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+t {K:V} The base table. -
+other {K:V} The other table. -
+.TE
+.SH RETURN
+A table containing the common key/value pairs whose keys only appear in one table.
+
+.SH EXAMPLES
+.EX
+t1 := {"A": 1; "B": 2, "C": 3}
+t2 := {"B": 2, "C":30, "D": 40}
+assert t1.difference(t2) == {"A": 1, "D": 40}
+.EE