https://seles.info/api.php?action=feedcontributions&feedformat=atom&user=128.100.72.37SELESwiki - User contributions [en]2026-05-30T02:52:00ZUser contributionsMediaWiki 1.45.3https://seles.info/index.php?title=Simple_empirical_fire_model&diff=3053Simple empirical fire model2006-11-14T15:18:50Z<p>128.100.72.37: </p>
<hr />
<div>==Summary==<br />
<br />
<br />
==Screenshot==<br />
<br />
[[Image:Consumer.gif]]<br />
<br />
==Download Model==<br />
<br />
Download the .scn, .sel and .lse files by clicking on the following link: [[Image:ProducerConsumer.zip]]<br />
<br />
==Model Code Exploration==<br />
<br />
In the following sections we will examine all of the model files for this model. Note that instead of downloading the zip file above, you could just copy the text in the boxes below into a text editor and save it with the appropriate name (Section title). Opening the resulting .scn file in the SELES simulator would run this model.<br />
<br />
===Consume.scn===<br />
Seles Scenario<br />
Model.sel<br />
SimPriority Low Priority<br />
<br />
===Model.sel===<br />
Seles Model<br />
Time Units: Step kiloStep 1000 1000<br />
Landscape Events:<br />
Producer.lse DEBUG<br />
Consumer.lse DEBUG<br />
Update.lse DEBUG<br />
Spatial Variables:<br />
LSState[3]<br />
PrevLSState[3]<br />
Legends:<br />
LSStateTypes = {0:Uncolonised, 1:Producer, 2:Consumer}<br />
Global Variables:<br />
pInitialProducer = 0.01<br />
pInitialConsumer = 0.01<br />
pSpreadProducer = 0.1<br />
pSpreadConsumer = 0.2<br />
pDeathProducer = 0.01<br />
pDeathConsumer = 0.05<br />
// SpreadRateProducer = 1<br />
// SpreadRateConsumer = 1<br />
Output Frequency: 1<br />
<br />
===consumer.lse===<br />
// Process based definition for consumber behaviour in producer/consumer model<br />
LSEVENT: Consumder<br />
DEFINITIONS<br />
LAYER: LSState, PrevLSState<br />
GLOBAL CONSTANT: Uncolonised, Producer, Consumer<br />
GLOBAL VARIABLE: pInitialConsumer, pSpreadConsumer, pDeathConsumer //, SpreadRateConsumer<br />
ENDDEF<br />
// Just start once<br />
RETURNTIME = 0<br />
// Initialize in an empty cell<br />
PROBINIT = IF LSState EQ Uncolonised THEN pInitialConsumer ELSE 0<br />
TRANSITIONS<br />
// Decide if this cell survives<br />
Dies = UNIFORM(0,1) < pDeathConsumer<br />
// If the consumer is dying<br />
IF Dies<br />
LSState = Uncolonised<br />
ENDFN<br />
TRANSITIONS = !Dies<br />
LSState = Consumer<br />
ENDTR<br />
SPREADTIMESTEP = 1 //SpreadRateConsumer<br />
SPREADLOCATION<br />
REGION CENTRED(0,1, WRAPPED)<br />
ENDSL<br />
SPREADPROB<br />
// Always spread to the same cell (self), and spread probabilistical to neighbouring producer cells<br />
SPREADPROB = IF Location EQ (SOURCE Location) THEN 1<br />
ELSE IF PrevLSState EQ Producer THEN pSpreadConsumer<br />
ELSE 0<br />
ENDSP<br />
<br />
===producer.lse===<br />
// Process based definiton of producer behaviour in producer/consumer model<br />
LSEVENT: Producer<br />
DEFINITIONS<br />
LAYER: LSState, PrevLSState<br />
GLOBAL CONSTANT: Uncolonised, Producer, Consumer<br />
GLOBAL VARIABLE: pInitialProducer, pSpreadProducer, pDeathProducer //, SpreadRateProducer<br />
ENDDEF<br />
// Just start once<br />
RETURNTIME = 0<br />
// Initialize in an empty cell<br />
PROBINIT = IF LSState EQ Uncolonised THEN pInitialProducer ELSE 0<br />
TRANSITIONS<br />
// Decide if this cell survives<br />
Dies = UNIFORM(0,1) < pDeathProducer<br />
// If the producer is dying<br />
IF Dies<br />
LSState = Uncolonised<br />
ENDFN<br />
TRANSITIONS = (!Dies)<br />
LSState = Producer<br />
ENDTR<br />
SPREADTIMESTEP = 1 //SpreadRateProducer <br />
SPREADLOCATION<br />
notEaten = PrevLSState EQ Producer // check that the producer wasn't eaten during the last step<br />
REGION CENTRED(0, 1, WRAPPED)<br />
DECISION notEaten // don't spread if eaten (i.e. stop process)<br />
ENDSL<br />
SPREADPROB<br />
// Always spread to the same cell (self), and spread probabilistically to empty neighbouring cells<br />
SPREADPROB = IF Location EQ (SOURCE Location) THEN 1 // spread to same cell<br />
ELSE IF PrevLSState EQ Uncolonised THEN pSpreadProducer<br />
ELSE 0<br />
ENDSP<br />
<br />
===update.lse===<br />
// Event to update time step<br />
LSEVENT: Update<br />
DEFINITIONS<br />
LAYER: LSState, PrevLSState<br />
ENDDEF<br />
RETURNTIME<br />
RETURNTIME = 1<br />
PrevLSState = LSState<br />
ENDRT<br />
NUMCLUSTERS = 0<br />
<br />
==Suggested Experiments==<br />
<br />
To explore this cellular automata model further, try the following:</div>128.100.72.37https://seles.info/index.php?title=Model_Garden&diff=3052Model Garden2006-11-14T15:18:11Z<p>128.100.72.37: </p>
<hr />
<div>== Basic Landscape Models and Components ==<br />
=== Example 1 ===<br />
=== Example 2 ===<br />
=== Spreading methods===<br />
====[[Spreading1]]====<br />
====[[Spreading2]]====<br />
<br />
=== Initiation methods ===<br />
===[[Markov chains]]===<br />
=== Cellular automata ===<br />
==== [[Game of Life]] ====<br />
=== Other ===<br />
==== [[Convex Hull]] ====<br />
==== [[Distance Surface]] ====<br />
==== [[Filter Small]] ====<br />
<br />
<br />
==== [[LSStats]] ====<br />
==== [[Producer Consumer]] ====<br />
==== [[Random Walker]] ====<br />
<br />
=== Individual based models ===<br />
<br />
== Simple Complete Models ==<br />
==== [[Simple empirical fire model]] ====<br />
=== Semi-Markov chain succession ===<br />
=== Basic timber harvesting ===<br />
=== Patch analysis ===<br />
=== Linear network processing ===<br />
<br />
== Applied and Advanced Models ==<br />
=== Timber Supply Models ===<br />
=== Habitat Supply Models ===<br />
=== Packed Territory Models ===<br />
=== Spatial Graph Models ===<br />
==== [[BC Timber Supply]] ====<br />
=== Kitcisakik Landscape model (KLM)===</div>128.100.72.37https://seles.info/index.php?title=User_talk:Charles&diff=2159User talk:Charles2006-10-04T21:54:54Z<p>128.100.72.37: </p>
<hr />
<div>Please place notes to Charles here...<br />
<br />
Hi, Charles, I edited the language reference page while not logged in, the "foreign" ip address is just me..<br />
oh, there's sth that i don't quite get--how come some of the explaination under the title show up in a grey box,some don't? what's the code that makes it appear in the box? (the DECISION Expr??) fei</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2144Language Reference2006-10-04T21:37:45Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED==<br />
(Expr, Expr [,DistanceType][,WRAPPED]) <br />
DECISION Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION LOCATION==<br />
(Expr)<br />
DECISION Expr <br />
defines the region consisting of a of a single<br />
location index. If there is a decision <br />
expression, then only those cells for which <br />
this expression returns TRUE will be <br />
included.<br />
<br />
==REGION LOCATION LIST==<br />
(Number+)<br />
DECISION Expr <br />
defines the region consisting of a set of a set <br />
of known location indices. If there is a <br />
decision expression, then only those cells for<br />
which this expression returns TRUE will be<br />
included. <br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2143Language Reference2006-10-04T21:36:43Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED==<br />
(Expr, Expr [,DistanceType][,WRAPPED]) <br />
DECISION Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION LOCATION==<br />
(Expr)<br />
DECISION Expr defines the region consisting of a of a single<br />
location index. If there is a decision <br />
expression, then only those cells for which <br />
this expression returns TRUE will be <br />
included.<br />
<br />
==REGION LOCATION LIST==<br />
(Number+)<br />
DECISION Expr defines the region consisting of a set of a set <br />
of known location indices. If there is a <br />
decision expression, then only those cells for<br />
which this expression returns TRUE will be<br />
included. <br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2142Language Reference2006-10-04T21:33:23Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED==<br />
(Expr, Expr [,DistanceType][,WRAPPED]) <br />
DECISION Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION LOCATION==<br />
(Expr)<br />
DECISION Expr defines the region consisting of a of a single<br />
location index. If there is a decision <br />
expression, then only those cells for which <br />
this expression returns TRUE will be <br />
included.<br />
<br />
==REGION LOCATION LIST==<br />
(Number+) defines the region consisting of a set of ????<br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2141Language Reference2006-10-04T21:32:17Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED==<br />
(Expr, Expr [,DistanceType][,WRAPPED]) <br />
DECISION Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION LOCATION==(Expr)<br />
DECISION Expr defines the region consisting of a of a single<br />
location index. If there is a decision <br />
expression, then only those cells for which <br />
this expression returns TRUE will be <br />
included.<br />
<br />
==REGION LOCATION LIST==<br />
(Number+) defines the region consisting of a set of ????<br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2140Language Reference2006-10-04T21:30:21Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED==<br />
(Expr, Expr [,DistanceType][,WRAPPED]) <br />
DECISION Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION LOCATION==<br />
(Expr) defines the region consisting of a of a single<br />
<br />
==REGION LOCATION LIST==<br />
(Number+) defines the region consisting of a set of ????<br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2139Language Reference2006-10-04T21:29:11Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED==(Expr, Expr [,DistanceType][,WRAPPED]) <br />
DECISION Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION LOCATION==<br />
(Expr) defines the region consisting of a of a single<br />
<br />
==REGION LOCATION LIST==<br />
(Number+) defines the region consisting of a set of ????<br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr <br />
COST Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=Language_Reference&diff=2137Language Reference2006-10-04T19:59:07Z<p>128.100.72.37: </p>
<hr />
<div>==ABS==<br />
(Expr) absolute value of the expression <br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==ABSOLUTE==<br />
(Expr) absolute value of the expression <br />
==Expr % Expr==<br />
value of the first expression modulo the value of<br />
the second expression (assumes that the values<br />
of the expressions are integers)<br />
<br />
==AND== <br />
TRUE (1) if all sub-expressions evaluate to<br />
TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ARCCOS==(Expr) inverse cos of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCSIN==<br />
(Expr) inverse sine of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr) inverse tan of the value of the expression [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==ARCTAN==<br />
(Expr, Expr) inverse tan where first expression is x offset<br />
and second is y offset. Providing two <br />
expressions gives more information about the <br />
quadrant.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==BITWISE OR==<br />
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE AND==<br />
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE XOR==<br />
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==BITWISE NOT==<br />
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==EXP==<br />
(Expr) base of the natural logarithm (e) to the power of<br />
the expression<br />
<br />
<br />
==CEILING==<br />
(Expr) smallest integer larger than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLAMP==<br />
(Expr, MinExpr, MaxExpr) clamp the value X of the expression to the range<br />
[Min, Max]: if X < Min then return Min; if X < Max return Max. Otherwise return X.<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==CLASSIFY==<br />
(X) if the value of the variable X is equal to one of <br />
CLASS Number: Expr the classes listed, then return the result of the.<br />
: associated expression. Otherwise return 0.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X) return the result of the kth expression in the list,<br />
Expr where k = X – minimum value of the variables<br />
: (this may be non-0 only for layers)<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
<br />
==CLASSIFY==<br />
(X): ( Number+) return the kth number in the list, where <br />
k = X – minimum value of the variable (this<br />
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs. Rarely<br />
used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFY==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file. Rarely used.<br />
<br />
Classified functions use the variable as an index into the list of numbers or expressions that follow. The “CLASS” keyword is optional. This variable must be non-negative. If “CLASS # :” is used, then the number refers to the value of the indexing variable. If a class is not specified for a given value, its expression is implicitly ZERO. Interpolation tables are very similar except that the variable is assumed to be continuous instead of classified. An interpolated value between classes is returned. Lookup tables are also similar, except that both the variable and classes are assumed to be continuous values. An interpolated value between classes is also returned. Rarely used.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==CLASSIFIED_DIST==<br />
draw a value from a discrete distribution, where CLASS Number: Expr each expression determines the relative : probability of its associated class being drawn. ENDFN The CLASS keyword is optional.<br />
<br />
==CLASSIFIED_DIST==<br />
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.<br />
==CLASSIFIED_DIST== <br />
in this form, the classes are assumed to start at Expr zero :<br />
ENDFN<br />
<br />
==CLASSIFIED_DIST[M]==<br />
In this form, the classes in a one-dimensional<br />
array M, and so start at zero.<br />
==COS==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return cos(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==CRITICAL SECTION==<br />
(Flag) Enter (if Flag is TRUE) or exit (if Flag is FALSE) a critical section. A critical section gives priority to this application, and is used for<br />
synchronizing access to shared variables<br />
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
<br />
==DEBUG==<br />
Update the simulation probe, if it is loaded and<br />
The event is selected. Used to debug/verify<br />
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==DECISION== <br />
Expr known location indices. If there is a decision expression, then only those cells for which this <br />
expression returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== Expr location indices stored in one-dimensional X. <br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DECISION== <br />
Expr defines a region centred on the current cell.<br />
If there is a decision expression, then only <br />
those cells for which this expression returns<br />
TRUE will be included.<br />
<br />
DistanceType is either CARDINAL or EUCLIDEAN (the default). Cardinal distance between two cells is the minimum number of cardinal steps (up, down, left, right) to reach one cell from the other. Euclidean distance is the straight-line distance between two points. The WRAPPED flag, if present indicates that the region wraps around the sides (vertically and horizontally) of the landscape (e.g. a location x positions beyond the right-hand side of a raster will be mapped to x positions in from the left-hand side of the raster). If not present, the landscape does not wrap.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==DIRECTION==<br />
(Expr, Expr) angle in degrees between two location indices<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==DISPLAY== Display on the screen the labelled Label: Expr values computed with the expressions listed.<br />
…. If no label is given, the expression must<br />
ENDFN be a variable, and this is used for the label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
==DISPLAY== Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr The keyword DECISION can be replaced by<br />
…. a “?”<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Output to the record file of output variable the labelled values computed with the Label: Expr expressions listed. If no label is given, the<br />
…. Expression must be a variable and this is<br />
ENDFN used as label.<br />
[[Model Builder's Guide Chapter 9#Output Expressions]]<br />
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE<br />
Label: Expr <br />
…. <br />
ENDFN <br />
<br />
==DISTANCE==<br />
(Expr, Expr) distance between two location indices (normally<br />
obtained using the Location variable). Thus,<br />
DISTANCE(loc1, loc2) is <br />
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ELSE==<br />
expression evaluates to TRUE and the set of<br />
… sub-expressions after the ELSE otherwise. Note <br />
ENDFN that “ELSE IF expr” forms can be strung<br />
together[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==EQUAL TRUE== <br />
(1) if the sub-expressions all evaluate to<br />
the same value and FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==FLOOR==<br />
(Expr) largest integer smaller than the expression value[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==GEOMETRIC MEAN== <br />
geometric mean of the sub-expressions (nth <br />
root of the product for n expressions)<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >=, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==GREATER THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation >, and<br />
FALSE (0) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process<br />
… sub-expressions denoted by “…” only if the <br />
ENDFN expression evaluates to TRUE[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==IF Expr==<br />
Procedural IF statement to process the first set<br />
… of sub-expressions denoted by “…”if the <br />
==IF Expr THEN Expr ELSE==<br />
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,<br />
otherwise return value of the ELSE expression<br />
<br />
(Expr ? Expr : Expr) Same as above, but this form can be used as an<br />
embedded sub-expression.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==INTERPOLATE==(X) return an interpolated value where the value of<br />
CLASS Number: Number variable X is placed between two classes or at<br />
: either end of the table.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
:<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==INTERPOLATE==(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==INTERPOLATE==(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table <br />
file.<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
==LESS OR EQUAL== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <=, and<br />
FALSE (0) otherwise<br />
<br />
ORDERED same as LESS OR EQUAL<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LESS THAN== <br />
TRUE (1) if the sub-expression evaluations are<br />
all ordered according to the relation <, and<br />
FALSE (0) otherwise<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==LOG==<br />
(Expr) natural logarithm of the value of the expression.<br />
Logarithms in other bases can be computed as<br />
logb(x) = ln(x) / ln(b)<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==LOG NORMAL CDF==<br />
(Expr, Expr, Expr) log normal cumulative density function, where<br />
the first expression specifies the value, the <br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
==LOG NORMAL PDF==<br />
(Expr, Expr, Expr) log normal probability density function, where<br />
the first expression specifies the value, the<br />
second is the mean and the third is the standard <br />
deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOG NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal log normal probability density<br />
function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==LOOKUP==<br />
(X): ( Number+) same as above, except the classes are<br />
implicitly 0, …. k-1<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the values in the<br />
CLASS Number: Expr table are obtained by evaluating expressions<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X) same as above, except the classes are <br />
Expr implicitly 0, …, k-1<br />
: <br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]] <br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename uses the table in the named file, which is <br />
assumed to consist of class:value pairs<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
==LOOKUP==<br />
(X): Filename Key uses the table in the named file, which is <br />
assumed to consist of class:value pairs. The key <br />
is used to specify a sub-table in a multi-table<br />
file<br />
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]<br />
<br />
Expr EQ Expr TRUE if the values of the two expressions are<br />
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr NEQ Expr TRUE if the values are not equal; otherwise<br />
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr < Expr TRUE if the value of the first expression is less<br />
than the value of the second expression;<br />
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr <= Expr TRUE if the value of the first expression is less<br />
than or equal to the value of the second<br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr > Expr TRUE if the value of the first expression is<br />
greater than the value of the second <br />
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
Expr >= Expr TRUE if the value of the first expression is<br />
greater than or equal to the value of the <br />
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr AND Expr TRUE if values of both expressions are<br />
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]<br />
<br />
Expr OR Expr TRUE if value of at least one expression is<br />
TRUE and FALSE otherwise<br />
<br />
==MAX POSITION==<br />
(Expr) Return the maximum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==MEAN== <br />
average of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
==MAX== <br />
maximum of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN== <br />
minimum of the sub-expressions <br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==MIN POSITION==<br />
(Expr) Return the minimum 0-based bit position that is <br />
set to one in the expression value (interpreted <br />
as a bit-vector), or –1 if no bits are set<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==NEGEXP==<br />
(Expr) draw a value from a negative exponential distribution, where the expression specifies the<br />
mean<br />
POISSION(Expr) draw a value from a Poisson distribution<br />
<br />
==NORMAL CDF==<br />
(Expr, Expr, Expr) normal cumulative density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL PDF==<br />
(Expr, Expr, Expr) normal probability density function, where the first expression is the value, the second is the mean and the third is the standard deviation <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal normal probability density function <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==NOT EQUAL== <br />
FALSE (0) if the sub-expressions all evaluate to<br />
the same value and TRUE (1) otherwise<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==ONE==<br />
return 1.0<br />
#Number return value of the number specified<br />
<Constant> return value of a named constant<br />
<Constant>[Expr] return value of a named vector constant<br />
<Constant>[Expr, Expr] return value of a named array constant<br />
<Macro>[Expr] return value of expression at specified index<br />
in macro<br />
<br />
<br />
<br />
(Expr, Expr) draw a value from a normal distribution, where<br />
the first expression specifies the mean and<br />
the second specifies the standard deviation<br />
<br />
(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode <br />
and the second and third specify the standard <br />
deviations to the left and right of the mode <br />
(Expr, Expr) draw a value from a log normal distribution,<br />
where the first expression specifies the mean<br />
and the second specifies the standard deviation <br />
of the underlying normal distribution<br />
<br />
(Expr, Expr) draw a value from a Weibull distribution, where<br />
the first expression specifies the beta and the<br />
second specifies alpha (Note:terminology varies<br />
between sources. The version here is equivalent<br />
to that in Excel, with reversal of parameters).<br />
<br />
==OR== <br />
TRUE (1) if at least one sub-expression<br />
evaluates to TRUE and FALSE (0) otherwise <br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==PAUSE==<br />
Halts the simulation and displays a dialog<br />
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE IF==<br />
Expr If the expression evaluates to TRUE, halts the <br />
simulation and displays a dialog box to which <br />
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE==<br />
(#Value) Pauses the simulation for the specified number<br />
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==PAUSE (#Value)IF== <br />
Expr If the expression evaluates to TRUE, Pauses the <br />
simulation for the specified number of <br />
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SKEWED NORMAL CDF==<br />
(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value, <br />
the second is the mode, and the third and fourth are the left and right standard deviations<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL PDF==<br />
(Expr, Expr, Expr, Expr) skewed normal probability density function,<br />
where the first expression specifies the value,<br />
the second is the mode and the third and fourth are the standard deviations to the left and right<br />
of the mode. <br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==SKEWED NORMAL TEMPORAL PDF==<br />
(Expr, Expr, Expr, Expr)<br />
temporal skewed normal probability density <br />
function<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
==RECOMPUTE== <br />
Only valid in consequent expressions of <br />
ProbInit and also when ProbInit recompute flag<br />
has been set. Causes prob. surface to be<br />
recomputed before next selection<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==REGION CENTRED== <br />
(Expr, Expr [, DistanceType][, WRAPPED])<br />
<br />
==REGION LOCATION==<br />
(Expr) defines the region consisting of a of a single<br />
<br />
==REGION LOCATION LIST==<br />
(Number+) defines the region consisting of a set of ????<br />
<br />
==REGION LOCATION LIST==(X,n) defines the region consisting of a set of n<br />
<br />
==REGION RECT== <br />
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a<br />
DECISION Expr decision expression defined, then only those<br />
cells for which this expression returns<br />
TRUE will be included<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==REGION WHOLE MAP== <br />
defines the region consisting of the entire<br />
DECISION Expr landscape. If there is a decision expression, <br />
then only those cells for which this expression <br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
==RESIZE==<br />
(Variable, Expr) Changes size (number of entries) in a global<br />
variable. Values are not maintained. Useful for <br />
when size is not known prior to simulation.<br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==RESPONSE==<br />
(Expr, #A, #B, #C) two-sided version of a standard response <br />
function for the value X of the first expression: <br />
if (X < A) return e^(-(X-A)^2/(2*(C^2))<br />
else if (X > B) return e^(-(X-B)^2/(2*(C^2))<br />
else return 1<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]<br />
<br />
==ROUND==<br />
(Expr) expression value rounded to the nearest integer[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
==SEED()==<br />
Gets the random number seed[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
==SEED==<br />
(Expr) Sets the random number seed. Value returned is <br />
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==SETAT==<br />
(Expr, PositionList, #Type) Set the value specified by the expression, at <br />
the positions in PositionList to: FALSE (0) <br />
if Type is 0, TRUE (1) if Type is 1,<br />
and flip the bits if Type = 2<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SETAT==<br />
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set<br />
with probability #Prob<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SELECTAT==<br />
(Expr, PositionList) FALSE(0) if none of the bits in PositionList are<br />
set in the specified expression value and<br />
TRUE(1) otherwise<br />
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SHIFT LEFT==<br />
(Expr, Expr) Shifts value of first expression to the left by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
==SHIFT RIGHT==<br />
(Expr, Expr) Shifts value of first expression to the right by <br />
number of bits specified by second expression[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]<br />
<br />
==SIN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==SUM==<br />
DESCRIPTION: <br />
Returns the number that is the sum of all the expressions.<br />
<br />
USAGE: <br />
x=SUM <br />
Expr<br />
... <br />
ENDFN<br />
<br />
REQUIRED ARGUMENTS:<br />
Expr is any expression that evaluates to single numeric value.<br />
<br />
VALUE: <br />
the sum of all the arguments.<br />
<br />
SEE ALSO: <br />
<a link to the composite functions section of seles modellers guide><br />
<br />
EXAMPLES: <add carriage return here><br />
Example 1:<br />
y = 3<br />
x = SUM <br />
y <br />
y+2 <br />
5 <br />
ENDFN <br />
<figure out an end example indicator. For example, ***><br />
<br />
SAMPLE MODELS: <br />
<links to sample models where this function is used><br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
DIVIDE successive division of the sub-expressions<br />
<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==STRICT ORDERED== <br />
same as LESS THAN<br />
[[Model Builder's Guide Chapter 9#Composite Functions]]<br />
<br />
==TAN==<br />
(Expr) interpret the value of the expression as an angle <br />
theta in degrees, and return tan(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]<br />
<br />
==UNIFORM==<br />
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum<br />
<br />
==UNIFORM TEMPORAL PDF==<br />
(Expr, Expr, Expr) temporal uniform probability density expression<br />
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]<br />
<br />
<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable<br />
<Variable>[Expr, Expr] value of an array global variable<br />
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]<br />
<br />
(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value<br />
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value<br />
of the second expression Expr ^ Expr value of the first expression to the power of<br />
the value of the second expression. An nth<br />
root can be computed with1/n as the power.<br />
| Expr | absolute value of the expression <br />
<br />
==WAIT UNTIL==<br />
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling<br />
communication and synchronization with<br />
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==WHILE==<br />
Expr While loop: process sub-expressions denoted by<br />
… “…” while the expression evaluates to TRUE<br />
ENDFN <br />
[[Model Builder's Guide Chapter 9#Control Expressions]]<br />
<br />
==ZERO==<br />
return 0.0<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
<br />
==DECISION== Expr location index. If there is a decision expression,<br />
then only those cells for which this expression<br />
returns TRUE will be included.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION VECTOR== (StartLocation, EndLocation) defines region consisting of cells along an<br />
==DECISION==<br />
Expr approximation of line between end cells<br />
<br />
Cost surface and least-cost path regions are advanced features that are best understood with an example model.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION COST SURFACE==<br />
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)<br />
==DECISION==<br />
Expr <br />
==COST==<br />
Expr<br />
Defines a region surrounding a cell with <br />
cumulative costs less than MaxCost. Stops<br />
growing when EndLocation is reached or all<br />
costs are greater than MaxCost. Second form <br />
also records gradient and anchor location<br />
layers. The CostSurface layer records the<br />
cumulative cost from the cost function<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==<br />
(StartLocation, EndLocation)<br />
DECISION Expr<br />
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs)<br />
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==REGION LEAST COST PATH==(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)<br />
DECISION Expr<br />
Defines a region with cells that approximate<br />
the least-cost path between two cells. The<br />
first generates the cost function internally.<br />
The latter two use input information from a<br />
pre-computed cost surface region. Providing <br />
both the gradient and anchor location layers <br />
provides the most accurate approximation.<br />
<br />
Iteration is a common aspect of models (even if it is very procedural). Most programming languages offer a “for-loop” of some kind. SELES presently provides “over index sequence” expressions as a slightly more declarative (although also more cumbersome) expression for iterating. While-loops can also be used.<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
==OVER INDEX SEQUENCE==<br />
(Expr, Expr) defines linear sequence of location indices. <br />
==DECISION==<br />
Expr If there is a decision expression, then only <br />
those cells for which this expression returns <br />
TRUE will be included. The system variable <br />
Index holds the value of the index at each value <br />
in the sequence<br />
<br />
Over region expressions are very frequently used to visit all cells in a landscape that meet some condition (e.g. to compute the size of the forest at initiation).<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
OVER RegionFunction Apply a set of sub-expressions at all spatial<br />
Expression locations specified by a region function<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
AT LOCATION #Expr Apply a set of state-changes at a specified<br />
Expression location<br />
:<br />
ENDFN<br />
[[Model Builder's Guide Chapter 9#Region Functions]]<br />
<br />
Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.<br />
<br />
Variable [=] Variable assign variable of same dimension, or a <br />
single value to all entries<br />
Variable [=] Variable + Variable sum variables of same dimension (or with a <br />
constant)<br />
Variable [=] Variable - Variable subtract variables of same dimension (or<br />
with a constant)<br />
Variable [=] Variable * Variable matrix or scalar multiplication. <br />
<br />
Variable [=] TRANSPOSE(Variable) matrix transposition<br />
Variable [=] Variable^-1 invert a matrix<br />
Variable = SUM(Variable) sum all entries in a matrix<br />
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one<br />
value per column)<br />
Variable [=] SUM COLS(Variable) sum all columns of a matrix<br />
<br />
Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is <br />
given by Expr. The system variable “Index” <br />
can appear in the expression and will take on<br />
the range of indices in the input array. The <br />
resulting sorted matrix will be assigned.<br />
<br />
Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model” <br />
(MPM) integer-based multiplication. <br />
Assumes that first matrix is two-dimensional <br />
and that second is a vector. The result is <br />
two-dimensional, where entries above <br />
diagonal represent "offspring", entries on the<br />
diagonal represent "survivors" and entries <br />
below the diagonal represent "succeeders"<br />
<br />
Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix. <br />
Given probabilities (first parameter) for a set<br />
of states and a two-dimensional contagion <br />
array (values –1 to 1 indicating affinity), <br />
generates a matrix where each row is a prob. <br />
dist. For transitions given the row value, and <br />
the overall target dist. will be met.<br />
[[Model Builder's Guide Chapter 9#Matrix Functions]]<br />
<br />
==REMOVE== <br />
ALL(LinkedVariable) clears variable. No return value<br />
SIZE(LinkedVariable) number of elements, entries or nodes<br />
==IS EMPTY==<br />
(LinkedVariable) TRUE if and only if variable has 0 elements<br />
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIRST==<br />
(LinkedVariable) returns position of first element, entry or<br />
node[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==NEXT==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
following position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==PREV==<br />
(LinkedVariable, PosVariable) returns position of element, entry or node <br />
preceding position provided[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==REMOVE==<br />
(LinkedVariable, PosVariable) remove and deletes element, entry or node <br />
at position<br />
<br />
Variable [=] GET(LinkedVariable, PosVariable) get element, entry or node at position<br />
X [=] GET(LinkedVariable, PosVariable, Index) get single value in a given index<br />
==SET==<br />
(LinkedVariable, PosVariable, Variable) set element, entry or node at position<br />
==SET==<br />
(LinkedVariable, PosVariable, entryIndex, Value)<br />
set value at specified index of element,<br />
entry or node at position[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND==<br />
(LinkedVariable, , TmpVariable Condition) return first position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==FIND NEXT==<br />
(LinkedVariable, PosVariable, TmpVariable, Condition) <br />
return next position of an element, entry or<br />
node that satisfies the condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
==SORT==<br />
(LinkedVariable, TmpVariable1, TmpVariable2, Condition)<br />
sort elements, entries or nodes according to <br />
condition[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]<br />
<br />
==CONTAINS==<br />
(SetVariable, ElementVariable) TRUE if and only if set variable “contains” <br />
variable provided, where two elements are <br />
identical if they have identical values[[Model Builder's Guide Chapter 9#Set Functions]]<br />
==INSERT==<br />
(SetVariable, ElementVariable) add element to set. Only changes set if it <br />
doesn’t already contain the element<br />
SetVariable = UNION(Set1, Set2) take union of two set variables<br />
SetVariable = INTERSECTION(Sete1, Set2) take intersection of two set variables<br />
SetVariable = SUBTRACT(Sete1, Set2) subtract second set variable from first<br />
[[Model Builder's Guide Chapter 9#Set Functions]]<br />
<br />
==HEAD==<br />
(ListVariable) returns position of first entry [[Model Builder's Guide Chapter 9#List Functions]]<br />
==TAIL==<br />
(ListVariable) returns position of last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT HEAD==<br />
(ListVariable, EntryElement) add an entry to front of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT TAIL==<br />
(ListVariable, EntryElement) add an entry to end of list[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT BEFORE==(ListVariable, Index, EntryElement)<br />
add an entry before given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AFTER==(ListVariable, Index, EntryElement)<br />
add an entry after given index[[Model Builder's Guide Chapter 9#List Functions]]<br />
==INSERT AT==(ListVariable, Index, EntryElement) add an entry at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE HEAD==(ListVariable) removes and deletes first entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE TAIL== (ListVariable) removes and deletes last entry[[Model Builder's Guide Chapter 9#List Functions]]<br />
==REMOVE AT INDEX==(ListVariable, Index) removes and deletes entry at given index<br />
<br />
Variable [=] GET HEAD(ListVariable) returns first entry<br />
Variable [=] GET TAIL(ListVariable) returns first entry<br />
Variable [=] GET AT INDEX(ListVariable, Index) returns entry at given index<br />
Pos = POS AT INDEX(ListVariable, Index) returns position at given index<br />
[[Model Builder's Guide Chapter 9#List Functions]]<br />
<br />
==ADD ROOT==(TreeVariable, EntryElement) add root element of a tree<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT LEFT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the left of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT RIGHT CHILD==(TreeVariable, PosVariable, EntryElement)<br />
add child to a node on the right of current<br />
children[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
==INSERT CHILD==(TreeVariable, PosVariable, EntryElement, Index)<br />
add child to a node at given index (from<br />
left)<br />
<br />
n = CHILDREN(TreeVariable, PosVariable) number of children at a given position<br />
Pos = PARENT(TreeVariable, PosVariable) Position of parent of a node<br />
Pos = LEFT CHILD(TreeVariable, PosVariable) Position of leftmost child of a node<br />
Pos = RIGHT CHILD(TreeVariable, PosVariable) Position of rightmost child of a node<br />
Pos = CHILD(TreeVariable, PosVariable, Index) Position of indexed (from left) child of a <br />
node<br />
Pos = NEXT SIBLING(TreeVariable, PosVariable) Position of next sibling to right of a node<br />
Pos = PREV SIBLING(TreeVariable, PosVariable) Position of previous sibling to right of a <br />
node<br />
<br />
Pos = NEXT DFS(TreeVariable, PosVariable) Position of next node in depth-first<br />
pre-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Pos = NEXT POSTORDER DFS(TreeVariable, PosVariable)<br />
Position of next node in depth-first<br />
post-order traversal of a tree. If the position<br />
variable is NULL, then the root is returned<br />
Variable [=] GET LEFT CHILD(TreeVariable, PosVariable)<br />
returns entry of leftmost child for a given<br />
node<br />
Variable [=] GET RIGHT CHILD(TreeVariable, PosVariable)<br />
returns entry of rightmost child for a given<br />
node<br />
Variable [=] GET CHILD(TreeVariable, PosVariable, Index)<br />
returns entry of child with given index<br />
(from left) for a given node<br />
[[Model Builder's Guide Chapter 9#Tree Functions]]<br />
<br />
==REMOVE ALL LINKS==<br />
(GraphVariable) clears links of a graph variable<br />
==SIZE LINKS==<br />
(GraphVariable) number of links in graph<br />
==IS EMPTY LINKS==<br />
(GraphVariable) TRUE if and only if graph has 0 links<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIRST LINK==<br />
(GraphVariable) returns position of first link[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==NEXT LINK==<br />
(GraphVariable, PosVariable) returns position of link following position<br />
provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==PREV LINK== <br />
(GraphVariable, PosVariable) returns position of link preceding position<br />
provided<br />
Variable [=] GET LINK(GraphVariable, PosVariable)<br />
get link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==CONTAINS LINK==<br />
(GraphVariable, LinkVariable) TRUE if and only if graph variable contains <br />
variable provided[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==REMOVE LINK==<br />
(GraphVariable, PosVariable) remove and deletes link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, LinkVariable)<br />
Set link at position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SET LINK==<br />
(GraphVariable, PosVariable, entryIndex, Value)<br />
Set value at specified index of link at<br />
position[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND LINK==<br />
(GraphVariable, TmpVariable, Condition)<br />
Return first position of link that satisfies the<br />
condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==FIND NEXT LINK==<br />
(GraphVariable, PosVariable, TmpVariable, Condition)<br />
Return next position of a link that satisfies <br />
the condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==SORT LINKS==<br />
(GraphVariable, TmpVariable1, TmpVariable2, Condition)<br />
Sort links according to condition[[Model Builder's Guide Chapter 9#Graph Functions]]<br />
==LINKED==<br />
(GraphVariable, NodeVariable1, NodeVariable2, LinkType)<br />
TRUE if the nodes are linked. Set LinkType <br />
to 0 for direct links and 1 for indirect<br />
[[Model Builder's Guide Chapter 9#Graph Functions]]</div>128.100.72.37https://seles.info/index.php?title=User_talk:JSH&diff=2136User talk:JSH2006-10-04T19:46:45Z<p>128.100.72.37: </p>
<hr />
<div>Hello, Josie....hope you are getting it this time</div>128.100.72.37https://seles.info/index.php?title=BCMPB_Provincial_Scale_Mountian_Pine_Beetle_Projection&diff=1868BCMPB Provincial Scale Mountian Pine Beetle Projection2006-09-25T22:30:36Z<p>128.100.72.37: /* Comments */</p>
<hr />
<div>SELES was used to implement a provincial scale mountain pine beetle model (BCMPB).<br />
Marvin Eng(1) Andrew Fall(2) Josie Hughes(3) Terry Shore(4) Bill Riel(4) Peter Hall(5)<br />
Adrian Walton(1)<br />
<br />
(1) [http://www.for.gov.bc.ca/hre/ Research Branch, BC Forest Service]<br />
(2) [http://www.gowlland.ca/ Gowlland Technologies Ltd.]<br />
(3) [http://www.zoo.utoronto.ca/fortin/people.htm Landscape Ecology Lab, University of Toronto]<br />
(4) [http://www.pfc.cfs.nrcan.gc.ca/ Pacific Forestry Centre, Canadian Forest Service]<br />
(5) [http://www.for.gov.bc.ca/hfp/index.htm Forest Practices Branch, BC Forest Service]<br />
<br />
=== Objective ===<br />
To provide a spatially and temporally explicit projection of the current MPB outbreak at a provincial scale. The purpose of providing the projection was to give senior managers and scientists information, at a provincial scale, which could be used in their decision-making processes.<br />
<br />
=== Models Built ===<br />
*Mountain pine beetle projection model - discrete state transition model parameterized with 1999-2005 survey data.<br />
*Provincial-scale forest management model<br />
<br />
=== Comments ===<br />
This is an interesting example the management and beetle submodels were built by different developers working in parallel. This required a degree of cooperation and collaboration we had not tried before. I think the result was a better model.<br />
<br />
=== More Information ===<br />
All the reports and results from the project can be found at http://www.for.gov.bc.ca/HRE/bcmpb/</div>128.100.72.37https://seles.info/index.php?title=BCMPB_Provincial_Scale_Mountian_Pine_Beetle_Projection&diff=1867BCMPB Provincial Scale Mountian Pine Beetle Projection2006-09-25T22:29:59Z<p>128.100.72.37: /* More Information */</p>
<hr />
<div>SELES was used to implement a provincial scale mountain pine beetle model (BCMPB).<br />
Marvin Eng(1) Andrew Fall(2) Josie Hughes(3) Terry Shore(4) Bill Riel(4) Peter Hall(5)<br />
Adrian Walton(1)<br />
<br />
(1) [http://www.for.gov.bc.ca/hre/ Research Branch, BC Forest Service]<br />
(2) [http://www.gowlland.ca/ Gowlland Technologies Ltd.]<br />
(3) [http://www.zoo.utoronto.ca/fortin/people.htm Landscape Ecology Lab, University of Toronto]<br />
(4) [http://www.pfc.cfs.nrcan.gc.ca/ Pacific Forestry Centre, Canadian Forest Service]<br />
(5) [http://www.for.gov.bc.ca/hfp/index.htm Forest Practices Branch, BC Forest Service]<br />
<br />
=== Objective ===<br />
To provide a spatially and temporally explicit projection of the current MPB outbreak at a provincial scale. The purpose of providing the projection was to give senior managers and scientists information, at a provincial scale, which could be used in their decision-making processes.<br />
<br />
=== Models Built ===<br />
*Mountain pine beetle projection model - discrete state transition model parameterized with 1999-2005 survey data.<br />
*Provincial-scale forest management model<br />
<br />
=== Comments ===<br />
This is an interesting example the management and beetle submodels were built by different developers working in parallel. This required a degree of cooperation and collaboration we had not tried before. I think the result is a better model.<br />
<br />
=== More Information ===<br />
All the reports and results from the project can be found at http://www.for.gov.bc.ca/HRE/bcmpb/</div>128.100.72.37https://seles.info/index.php?title=BCMPB_Provincial_Scale_Mountian_Pine_Beetle_Projection&diff=1866BCMPB Provincial Scale Mountian Pine Beetle Projection2006-09-25T22:27:30Z<p>128.100.72.37: /* Comments */</p>
<hr />
<div>SELES was used to implement a provincial scale mountain pine beetle model (BCMPB).<br />
Marvin Eng(1) Andrew Fall(2) Josie Hughes(3) Terry Shore(4) Bill Riel(4) Peter Hall(5)<br />
Adrian Walton(1)<br />
<br />
(1) [http://www.for.gov.bc.ca/hre/ Research Branch, BC Forest Service]<br />
(2) [http://www.gowlland.ca/ Gowlland Technologies Ltd.]<br />
(3) [http://www.zoo.utoronto.ca/fortin/people.htm Landscape Ecology Lab, University of Toronto]<br />
(4) [http://www.pfc.cfs.nrcan.gc.ca/ Pacific Forestry Centre, Canadian Forest Service]<br />
(5) [http://www.for.gov.bc.ca/hfp/index.htm Forest Practices Branch, BC Forest Service]<br />
<br />
=== Objective ===<br />
To provide a spatially and temporally explicit projection of the current MPB outbreak at a provincial scale. The purpose of providing the projection was to give senior managers and scientists information, at a provincial scale, which could be used in their decision-making processes.<br />
<br />
=== Models Built ===<br />
*Mountain pine beetle projection model - discrete state transition model parameterized with 1999-2005 survey data.<br />
*Provincial-scale forest management model<br />
<br />
=== Comments ===<br />
This is an interesting example the management and beetle submodels were built by different developers working in parallel. This required a degree of cooperation and collaboration we had not tried before. I think the result is a better model.<br />
<br />
=== More Information ===<br />
See http://www.for.gov.bc.ca/HRE/bcmpb/</div>128.100.72.37https://seles.info/index.php?title=Case_Studies&diff=1838Case Studies2006-09-14T15:18:07Z<p>128.100.72.37: /* North America */</p>
<hr />
<div><h2> Navigate By Map </h2><br />
<googlemap width ="550" height="300" lat="30" lon="-50" zoom="1" type="hybrid"><br />
64.54844014422517,30.322265625,[[Karelia|Karelia(Russia)]]<br />
53.21919081798935,-132.12158203125,[[Haida Gwaii|Haida Gwaii]]<br />
54.62297813269033,-123.3544921875,[[BC MPB | BC Provincial Scale MPB Projection]]<br />
<br />
</googlemap><br />
<br />
<h2> Navigate By List </h2><br />
=== North America ===<br />
==== British Columbia ====<br />
::[[Caribou]]<br />
<br />
::[[North Coast LRMP]]<br />
<br />
::[[Spotted Owl]]<br />
<br />
::[[Haida Gwaii]]<br />
<br />
::[[BCMPB Provincial Scale Mountian Pine Beetle Projection]]<br />
<br />
=== South America ===<br />
<br />
=== Europe ===<br />
::[[Karelia | Karelia (Russia)]]</div>128.100.72.37