Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
select_percent_matrix [2011/07/31 20:46] hermann created |
select_percent_matrix [2026/08/28 03:32] (current) hermann Sync from local documentation review |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Select Percent Matrix ====== | + | ====== Select Percent Matrix ====== |
| ===== Description ===== | ===== Description ===== | ||
| - | This container picks up a percent matrix from a series of matrices. | + | Container that picks one percent matrix out of a series connected inside it, based on the current step. Each candidate matrix must be connected through a [[Number Percent Matrix]] hook, whose number identifies the step at which that matrix takes over. A matrix begins being selected once the model step reaches its number, and remains selected until the step reaches the number of another connected matrix, allowing one matrix to be swapped for another during a model's execution. |
| ===== Inputs ===== | ===== Inputs ===== | ||
| + | |||
| + | None. | ||
| ===== Optional Inputs ===== | ===== Optional Inputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ Default Value ^ | + | ^ Name ^ Type ^ Description ^ Default Value ^ |
| - | | Step | [[Positive Int Type|Positive Int]] | Current step or model iteration. | 1 | | + | | Step | [[Positive Integer Value Type]] | Step used to pick the matrix, automatically bound to the innermost compatible container. | 1 | |
| ===== Outputs ===== | ===== Outputs ===== | ||
| - | ^ Name ^ Type ^ Description ^ | + | ^ Name ^ Type ^ Description ^ |
| - | | Percent Matrix | [[Transition Percent Matrix Type|Transition Percent Matrix]] | Matrix of percents. | | + | | Percent Matrix | [[Percent Matrix Type]] | Selected matrix of percents. | |
| ===== Group ===== | ===== Group ===== | ||
| Line 21: | Line 23: | ||
| [[Functor List#Stack | Stack]] | [[Functor List#Stack | Stack]] | ||
| - | ===== Notes ===== | + | ===== Notes ===== |
| - | This container allows the replacement of of one percent matrix with another during a model execution. Any matrix inside this container will begin to be used by a model according to its matrix number identifier and will continue to be used until the model step reaches the number identifier of another matrix inside the same container. | + | Only [[Number Percent Matrix]] hooks can be connected inside this container. |
| - | Each percent matrix inside the "Select Percent Matrix" must be provided by a corresponding [[Number Percent Matrix]]. | + | The selected matrix is the one with the greatest number identifier that is still less than or equal to Step. |
| - | ===== Internal Name ===== | + | ===== Internal Name ===== |
| SelectPercentMatrix | SelectPercentMatrix | ||