Differences

This shows you the differences between two versions of the page.

--- calc_lookup_table_difference [2013/07/18 19:59]
admin [Optional Inputs]
+++ calc_lookup_table_difference [2026/08/28 03:11] (current)
hermann Sync from local documentation review
@@ Line 1: / Line 1: @@
-====== Calc Lookup Table Union ======
+====== Calc Lookup Table Difference ======
 ===== Description =====
-This functor calculates a lookup table that corresponds to the difference between two lookup tables.
+Calculates the difference between two lookup tables.
 ===== Inputs =====
-^ Name          ^ Type                                  ^ Description               ^
+^ Name  ^ Type  ^ Description  ^
-| First Table   | [[Lookup Table Type|Lookup Table  ]]  | The first lookup table.   |
+| First Table  | [[Lookup Table Type]]  | The first lookup table.  |
-| Second Table  | [[Lookup Table Type|Lookup Table  ]]  | The second lookup table.  |
+| Second Table  | [[Lookup Table Type]]  | The second lookup table.  |
 ===== Optional Inputs =====
-^ Name  ^ Type  ^ Description  ^ Default Value ^
+^ Name  ^ Type  ^ Description  ^ Default Value  ^
-| use Symmetrical Difference  | [[Bool Type|Bool]  | If true, the symmetrical difference between two lookup tables is calculated; otherwise, the relative complement is used.  | True  |
+| Use Symmetrical Difference  | [[Boolean Value Type]]  | If true, the symmetrical difference between First Table and Second Table is calculated, keeping the keys present in only one of the two tables; if false, the relative complement is calculated instead, keeping only the keys of First Table that do not occur in Second Table.  | False  |
-===== Output =====
+===== Outputs =====
-^ Name     ^ Type                                  ^ Description                  ^
+^ Name  ^ Type  ^ Description  ^
-| result   | [[Lookup Table Type|Lookup Table  ]]  | The resulting lookup table.  |
+| Result  | [[Lookup Table Type]]  | The resulting lookup table.  |
 ===== Group =====
-[[Functor List#Table | Table]]
+[[Functor List#Lookup Table | Lookup Table]]
 ===== Notes =====
-The column names from the first input table are assigned to the output table.
+The key and value column names of Result are inherited from First Table.
+For background on the two set operations this functor can compute, see [[https://en.wikipedia.org/wiki/Complement_(set_theory)#Relative_complement|relative complement]] and [[https://en.wikipedia.org/wiki/Symmetric_difference|symmetric difference]].
-For further information about difference between two sets, see [[wp>Difference_(set_theory)]] and [[wp>Symmetric_difference]].
 ===== Internal Name =====
 CalcLookupTableDifference