Differences

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

--- map_indexer [2012/10/26 14:32]
127.0.0.1 external edit
+++ map_indexer [2026/08/28 03:27] (current)
hermann Sync from local documentation review
@@ Line 3: / Line 3: @@
 ===== Description =====
-This functor index the values of a map using values from another as indices resulting in a lookup table where keys are the values from the first map and table values are the values from the second map.
+Builds a lookup table by pairing, cell by cell, the values of two maps: the values of one map become the table's keys, and the values of the other, at the same coordinates, become the corresponding values.
 ===== Inputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| Key Map  | [[Map Type|Map]]  | The input map with the keys.  |
+| Key Map  | [[Map Type]]  | Map whose values become the keys of the resulting table.  |
-| Value Map  | [[Map Type|Map]]  | The input map with the values.  |
+| Value Map  | [[Map Type]]  | Map whose values become the values of the resulting table.  |
+===== Optional Inputs =====
+None.
 ===== Outputs =====
-^ Name ^ Type ^ Description ^
+^ Name  ^ Type  ^ Description  ^
-| table | [[Lookup Table Type|Lookup Table]]  | The resulting table containing the "Key Map" values as keys and "Value Map" values as values. |
+| Key Value Table  | [[Lookup Table Type]]  | Table pairing each non-null cell value of Key Map with the value found at the same coordinates in Value Map.  |
 ===== Group =====
-[[Functor List#Map Algebra|Map Algebra]]
+[[Functor List#Map Algebra | Map Algebra]]
 ===== Notes =====
+A cell whose value in Key Map is null is skipped.
+The topmost line and leftmost column of a map both have coordinate 1.
 ===== Internal Name =====