Differences

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

Link to this comparison view

Next revision
Previous revision
modulate_change_matrix [2011/07/31 18:47]
hermann created
modulate_change_matrix [2026/08/28 03:27] (current)
hermann Sync from local documentation review
Line 1: Line 1:
-====== Modulate Change Matrix ====== ​+====== Modulate Change Matrix ======
  
 ===== Description ===== ===== Description =====
Line 7: Line 7:
 ===== Inputs ===== ===== Inputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ 
-| Changes ​ | [[ Change Matrix Type|Change Matrix  ​]]  | Matrix of quantity of changes. ​ | +| Changes ​ | [[Change Matrix Type]] ​ | Matrix of quantity of changes. ​ | 
-| Modulation Rates  | [[Transition ​Percent Matrix Type|Transition Percent Matrix  ​]]  | Matrix setting the percents of changes for a set of transitions. ​ |+| Modulation Rates  | [[Percent Matrix Type]] ​ | Matrix setting the percents of changes for a set of transitions. ​ |
  
 ===== Optional Inputs ===== ===== Optional Inputs =====
 +
 +None.
  
 ===== Outputs ===== ===== Outputs =====
  
-^ Name ^ Type ^ Description ^ +^ Name  ^ Type  ^ Description ​ 
-| Modulated Changes ​ | [[ Change Matrix Type|Change Matrix  ​]]  | Matrix of current quantity of changes as set by the matrix of percents. ​ | +| Modulated Changes ​ | [[Change Matrix Type]] ​ | Matrix of current quantity of changes as set by the matrix of percents. ​ | 
-| Complementary Changes ​ | [[Change Matrix Type|Change Matrix  ​]]  | Matrix of complementary quantity of changes. Input matrix of changes minus the matrix of current quantity of changes. ​ |+| Complementary Changes ​ | [[Change Matrix Type]] ​ | Matrix of complementary quantity of changes. Input matrix of changes minus the matrix of current quantity of changes. ​ |
  
 ===== Group ===== ===== Group =====
Line 23: Line 25:
 [[Functor List#​Simulation | Simulation]] [[Functor List#​Simulation | Simulation]]
  
-===== Notes ===== +===== Notes =====
  
-This functor ​is employed in order to split the quantity of changes between different types of transition ​functions, i.e. [[Expander]] versus [[Patcher]].+This functor ​reports an error if a transition ​present in Changes has no corresponding rate in Modulation Rates.
  
-===== Internal Name ===== +===== Internal Name =====
  
 ModulateChangeMatrix ModulateChangeMatrix
 +
 +===== Usage examples =====
 +
 +See practical examples of this functor in [[lesson_18|Lesson 18: Building a land-use and land-cover change simulation model]]