Differences

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

Link to this comparison view

Next revision 		Previous revision
number_map [2011/07/31 19:00]
hermann created 		number_map [2026/08/28 03:28] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Number Map ====== ​+====== Number Map ======
  
 ===== Description ===== ===== Description =====
  
-This hook identifies ​a map by assigning ​a number ​to it.+Placeholder used to register ​a map under a given number ​in the container ​it is placed inside. This functor produces no output itself: the enclosing container inspects its input ports and performs the actual registration. 
 + 
 +This functor can be placed inside [[Calculate Map]], [[Calculate Categorical Map]], [[Select Map]], and [[Calculate Python Expression]] (where map values are not currently supported, so connecting this hook to that container raises an error at runtime).
  
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ ^ 
-| Map  | [[Map Type|Map]]  | Any input map.  | +| Map  | [[Map Type]] ​ | Map to register in the container.  | 
-| Map Number ​ | [[Positive ​Int Type|Positive Int]]  | Map number identifier.  |+| Map Number ​ | [[Positive ​Integer Value Type]] ​ | Number under which the map will be known inside the container.  |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
 +
 +None.
  
 ===== Outputs ===== ===== Outputs =====
 +
 +None.
  
 ===== Group ===== ===== Group =====
  
-[[Functor List#Map Algebra Supplementary ​ | Map Algebra Supplementary ]]+[[Functor List#Map Algebra Supplementary | Map Algebra Supplementary]] 
 + 
 +===== Notes ===== 
 + 
 +This functor'​s banner shows "​Map"​ followed by the value of Map Number.
  
-===== Notes ===== +Reports a warning if Map Number is provided through a connection rather than as a constant.
  
-A hook is usually used to enter a type of data into a container ​that performs some operation.+Placing this functor inside ​a container ​it is not designed for reports a warning, since it has no effect there.
  
-===== Internal Name ===== +===== Internal Name =====
  
 NumberMap NumberMap