SELESwiki - User contributions [en]

Model Garden

2006-11-15T23:16:49Z

Fei:

== Basic Landscape Models and Components ==
=== Example 1 ===
=== Example 2 ===
=== Spreading methods===
====[[Spreading1]]====
====[[Spreading2]]====

=== Initiation methods ===
===[[Markov chains]]===
=== Cellular automata ===
==== [[Game of Life]] ====
=== Other ===
==== [[Convex Hull]] ====
==== [[Distance Surface]] ====
==== [[Filter Small]] ====
==== [[LSStats]] ====

===Producer Consumer===
====[[The CA model]]====
====[[The IBM model]]====
====[[The IBM2 model]]====
====[[The process model]]====

==== [[Random Walker]] ====

=== Individual based models ===

== Simple Complete Models ==
=== Simple empirical fire model ===
====[[The Fire model]]====
====[[The FireSucc model]]====
====[[gisData]]====
====[[Handout]]====
====[[The Succession model]]====
=== Semi-Markov chain succession ===
=== Basic timber harvesting ===
=== Patch analysis ===
=== Linear network processing ===

== Applied and Advanced Models ==
=== Timber Supply Models ===
=== Habitat Supply Models ===
=== Packed Territory Models ===
=== Spatial Graph Models ===
==== [[BC Timber Supply]] ====
=== Kitcisakik Landscape model (KLM)===

User talk:Fei

2006-11-15T23:12:42Z

Fei: /* The following are the examples I entered from all the lse files. I think I have completed all the ones that I can find. You may check on that */

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]

===I've also inserted a few new entries for the language reference===

1) INSERT LINK
2) GET
3) GET LINK
4) LOCATION
5) OUTPUT RECORD
6) SET
7) SET LINK

===The following are the examples I entered from all the lse files. I think I have completed all the ones that I can find. You may check on that===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:12:12Z

Fei:

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]

===I've also inserted a few new entries for the language reference===

1) INSERT LINK
2) GET
3) GET LINK
4) LOCATION
5) OUTPUT RECORD
6) SET
7) SET LINK

===The following are the examples I entered from all the lse files. I think I have completed all the ones that I can find. You may check on that===
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:11:56Z

Fei: /* a note to myself */

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]

==I've also inserted a few new entries for the language reference==

1) INSERT LINK
2) GET
3) GET LINK
4) LOCATION
5) OUTPUT RECORD
6) SET
7) SET LINK

===The following are the examples I entered from all the lse files. I think I have completed all the ones that I can find. You may check on that===
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:11:22Z

Fei: /* a note to myself */

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]
===a note to myself===
*I've also inserted a few new entries for the language reference:

1) INSERT LINK
2) GET
3) GET LINK
4) LOCATION
5) OUTPUT RECORD
6) SET
7) SET LINK

===The following are the examples I entered from all the lse files. I think I have completed all the ones that I can find. You may check on that===
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:08:54Z

Fei:

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]
===a note to myself===
*I've also inserted a few new entries for the language reference:

1) INSERT LINK
2) GET
3) GET LINK
4) LOCATION
5) OUTPUT RECORD
6) SET
7) SET LINK

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:08:02Z

Fei:

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]
===a note to myself===
*I've also inserted a few new entries for the language reference:

INSERT LINK

GET

GET LINK

LOCATION

OUTPUT RECORD

SET

SET LINK

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:07:45Z

Fei: /* a note to myself */

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]
===a note to myself===
*I've also inserted a few new entries for the language reference:
INSERT LINK

GET

GET LINK

LOCATION

OUTPUT RECORD

SET

SET LINK
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

Language Reference

2006-11-15T23:06:20Z

Fei:

:''Click on a term below for more information.''

{| style="background-color: lightblue; width: {{{width|100%}}}"

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
*GENERAL INFORMATION
**[[SELES101l02|HOW TO RUN AN EXAMPLE CODE]]

*SYMBOLS
**[[Language Reference 1#plus sign|+]]
**[[Language Reference 1#-|-]]
**[[Language Reference 1#*|*]]
**[[Language Reference 1#/|/]]
**[[Language Reference 1#^|^]]
**[[Language Reference 1#%|%]]
**[[Language Reference 1#==|==]]
**[[Language Reference 1#!=|!=]]
**[[Language Reference 1#<|<]]
**[[Language Reference 1#<=|<=]]
**[[Language Reference 1#>|>]]
**[[Language Reference 1#>=|>=]]
**[[Language Reference 1#!|!]]
* A|Aa
**[[Language Reference 1#ABS(Expr)|ABS(Expr)]]
**[[Language Reference 1#AND|AND]]
**[[Language Reference 1#ARCCOS|ARCCOS]]
**[[Language Reference 1#ARCSIN|ARCSIN]]
**[[Language Reference 1#ARCTAN(Expr)|ARCTAN(Expr)]]
**[[Language Reference 1#ARCTAN(Expr,Expr)|ARCTAN(Expr,Expr)]]
* B|Bb
**[[Language Reference 1#BITWISE AND|BITWISE AND]]
**[[Language Reference 1#BITWISE NOT|BITWISE NOT]]
**[[Language Reference 1#BITWISE OR|BITWISE OR]]
**[[Language Reference 1#BITWISE XOR|BITWISE XOR]]
* C|Cc
**[[Language Reference 1#CEILING(Expr)|CEILING(Expr)]]
**[[Language Reference 1#CLAMP|CLAMP]]
**[[Language Reference 1#CLASSIFIED_DIST|CLASSIFIED_DIST]]
**[[Language Reference 1#CLASSIFIED_DIST_M|CLASSIFIED_DIST_M]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 1#CLASSIFY|CLASSIFY]]
:*[[Language Reference 1#CONTAINS|CONTAINS]]
:*[[Language Reference 1#CONTAINS LINK|CONTAINS LINK]]
:*[[Language Reference 1#COS|COS]]
:*[[Language Reference 1#CRITICAL SECTION|CRITICAL SECTION]]
* D|Dd
:*[[Language Reference 1#DEBUG|DEBUG]]
:*[[Language Reference 1#DECISION|DECISION]]
:*[[Language Reference 1#DIRECTION|DIRECTION]]
:*[[Language Reference 1#DISTANCE|DISTANCE]]
* E|Ee
:*[[Language Reference 1#ELSE|ELSE]]
:*[[Language Reference 1#EQUAL TRUE|EQUAL TRUE]]
:*[[Language Reference 1#EXP(Expr)|EXP(Expr)]]
* F|Ff
:*[[Language Reference 1#FIND|FIND]]
:*[[Language Reference 1#FIND LINK|FIND LINK]]
:*[[Language Reference 1#FIND NEXT|FIND NEXT]]
:*[[Language Reference 1#FIND NEXT LINK|FIND NEXT LINK]]
:*[[Language Reference 1#FIRST|FIRST]]
:*[[Language Reference 1#FIRST LINK|FIRST LINK]]
:*[[Language Reference 1#FLOOR(Expr)|FLOOR(Expr)]]
* G|Gg
:*[[Language Reference 1#GEOMETRIC MEAN|GEOMETRIC MEAN]]
:*[[Language Reference 1#GET|GET]]
:*[[Language Reference 1#GET LINK|GET LINK]]
:*[[Language Reference 1#>=|GREATER OR EQUAL]]
:*[[Language Reference 1#>|GREATER THAN]]
* H|Hh
:*[[Language Reference 1#HEAD|HEAD]]
* I|Ii
:*[[Language Reference 2#IF Expr|IF Expr]]
:*[[Language Reference 2#IF Expr THEN Expr ELSE|IF Expr THEN Expr ELSE]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#INSERT|INSERT]]
:*[[Language Reference 2#INSERT HEAD|INSERT HEAD]]
:*[[Language Reference 2#INSERT LINK|INSERT LINK]]
:*[[Language Reference 2#INSERT TAIL|INSERT TAIL]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#IS EMPTY|IS EMPTY]]
:*[[Language Reference 2#IS EMPTY LINKS|IS EMPTY LINKS]]
* J|Jj
* K|Kk
* L|Ll
:*[[Language Reference 1#<=|LESS OR EQUAL]]
:*[[Language Reference 1#<|LESS THAN]]
:*[[Language Reference 2#LINKED|LINKED]]
:*[[Language Reference 2#LOCATION|LOCATION]]
:*[[Language Reference 2#LOG(Expr)|LOG(Expr)]]
:*[[Language Reference 2#LOG NORMAL CDF|LOG NORMAL CDF]]
:*[[Language Reference 2#LOG NORMAL PDF|LOG NORMAL PDF]]
:*[[Language Reference 2#LOG NORMAL TEMPORAL PDF|LOG NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#LOOKUP|LOOKUP]]
* M|Mm
:*[[Language Reference 2#MAX|MAX]]
:*[[Language Reference 2#MAX POSITION|MAX POSITION]]
:*[[Language Reference 2#MEAN|MEAN]]
:*[[Language Reference 2#MIN|MIN]]
:*[[Language Reference 2#MIN POSITION|MIN POSITION]]
* N|Nn
:*[[Language Reference 2#NEGEXP|NEGEXP]]
:*[[Language Reference 2#NEXT|NEXT]]
:*[[Language Reference 2#NEXT LINK|NEXT LINK]]
:*[[Language Reference 2#NORMAL|NORMAL]]
:*[[Language Reference 2#NORMAL CDF|NORMAL CDF]]
:*[[Language Reference 2#NORMAL PDF|NORMAL PDF]]
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]


| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]
* O|Oo
:*[[Language Reference 3#ONE|ONE]]
:*[[Language Reference 3#OR|OR]]
:*[[Language Reference 3#OUTPUT RECORD|OUTPUT RECORD]]
:*[[Language Reference 3#OVER INDEX SEQUENCE|OVER INDEX SEQUENCE]]
* P|Pp
:*[[Language Reference 3#PAUSE|PAUSE]]
:*[[Language Reference 3#PAUSE (#Value)IF|PAUSE (#Value)IF]]
:*[[Language Reference 3#PAUSE IF|PAUSE IF]]
:*[[Language Reference 3#PREV|PREV]]
:*[[Language Reference 3#PREV LINK|PREV LINK]]
* Q|Qq
* R|Rr
:*[[Language Reference 3#RECOMPUTE|RECOMPUTE]]
:*[[Language Reference 3#REGION CENTRED|REGION CENTRED]]
:*[[Language Reference 3#REGION COST SURFACE|REGION COST SURFACE]]
:*[[Language Reference 3#REGION LEAST COST PATH|REGION LEAST COST PATH]]
:*[[Language Reference 3#REGION LOCATION|REGION LOCATION]]
:*[[Language Reference 3#REGION LOCATION LIST|REGION LOCATION LIST]]
:*[[Language Reference 3#REGION RECT|REGION RECT]]
:*[[Language Reference 3#REGION VECTOR|REGION VECTOR]]
:*[[Language Reference 3#REGION WHOLE MAP|REGION WHOLE MAP]]
:*[[Language Reference 3#REMOVE|REMOVE]]
:*[[Language Reference 3#REMOVE ALL LINKS|REMOVE ALL LINKS]]
:*[[Language Reference 3#REMOVE LINK|REMOVE LINK]]
:*[[Language Reference 3#RESIZE|RESIZE]]
:*[[Language Reference 3#RESPONSE|RESPONSE]]
:*[[Language Reference 3#ROUND(Expr)|ROUND(Expr)]]
* S|Ss
:*[[Language Reference 3#SEED|SEED]]
:*[[Language Reference 3#SELECTAT|SELECTAT]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 3#SET|SET]]
:*[[Language Reference 3#SET LINK|SET LINK]]
:*[[Language Reference 3#SETAT|SETAT]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type)]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type,#Prob)]]
:*[[Language Reference 3#SHIFT LEFT|SHIFT LEFT]]
:*[[Language Reference 3#SHIFT RIGHT|SHIFT RIGHT]]
:*[[Language Reference 3#SIN|SIN]]
:*[[Language Reference 3#SIZE LINKS|SIZE LINKS]]
:*[[Language Reference 3#SKEWED NORMAL CDF|SKEWED NORMAL CDF]]
:*[[Language Reference 3#SKEWED NORMAL PDF|SKEWED NORMAL PDF]]
:*[[Language Reference 3#SKEWED NORMAL TEMPORAL PDF|SKEWED NORMAL TEMPORAL PDF]]
:*[[Language Reference 3#SORT|SORT]]
:*[[Language Reference 3#SORT LINKS|SORT LINKS]]
:*[[Language Reference 3#STRICT ORDERED|STRICT ORDERED]]
:*[[Language Reference 3#SUM|SUM]]
* T|Tt
:*[[Language Reference 3#TAIL|TAIL]]
:*[[Language Reference 3#TAN|TAN]]
* U|Uu
:*[[Language Reference 3#UNIFORM|UNIFORM]]
:*[[Language Reference 3#UNIFORM TEMPORAL PDF|UNIFORM TEMPORAL PDF]]
* V|Vv
* W|Ww
:*[[Language Reference 3#WAIT UNTIL|WAIT UNTIL]]
:*[[Language Reference 3#WHILE|WHILE]]
* X|Xx
* Y|Yy
* Z|Zz
:*[[Language Reference 3#ZERO|ZERO]]

|}

User talk:Fei

2006-11-15T23:03:47Z

Fei:

==Nov. 15 2006==
===quick link===
[[User_talk:JSH]]
===a note to myself===
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:Fei

2006-11-15T23:03:09Z

Fei:

==Nov. 15 2006==
===a note to myself===
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

User talk:JSH

2006-11-15T23:02:45Z

Fei:

==Nov. 15 2006==

Hi Josie, Please take a look at [[User_talk:Fei]] for what I've done today.
Have a nice weekend!

==Nov. 14 2006==

HI Josie, I listed what I looked thru today & some stuff that I'm unsure of, I'll ask you about them tomorrow =)
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE?
***OUTPUT RECORD?
**nn.lse
***many?
***OVER REFION VECTOR
**centroid.lse
***OVER INDEX SEQUENCE

*'''Producer Consumer'''
**IdentifyPatches.lse
***IF?
**Consumer.lse
***NOTHING
**Producer.lse
***REGION CENTRED
**update.lse
***NOTHING

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***NOTHING

Hi Josie, this is the msg i got from Charles, what do you think?--fei
"I think we'll have to re-think about the Language Reference list... I'm getting the folowing errors: "WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hello, Josie....hope you are getting it this time

== Oct 17(Tuesday),06 ==

Hi, Josie, I've done the tasks up to the Log part. Please check on what I've finished today. Question- I don't know why this page doesn't read the code i copied from wiki, please go to the Log part. We can fix that tomorrow. Thanks for the coffee :) Have a great afternoon! fei

User talk:JSH

2006-11-15T23:01:44Z

Fei:

===Nov. 15 2006===
Hi Josie, Please take a look at [[User_talk:Fei]] for what I've done today.
Have a nice weekend!

===Nov. 14 2006===
HI Josie, I listed what I looked thru today & some stuff that I'm unsure of, I'll ask you about them tomorrow =)
*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE?
***OUTPUT RECORD?
**nn.lse
***many?
***OVER REFION VECTOR
**centroid.lse
***OVER INDEX SEQUENCE

*'''Producer Consumer'''
**IdentifyPatches.lse
***IF?
**Consumer.lse
***NOTHING
**Producer.lse
***REGION CENTRED
**update.lse
***NOTHING

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***NOTHING

Hi Josie, this is the msg i got from Charles, what do you think?--fei
"I think we'll have to re-think about the Language Reference list... I'm getting the folowing errors: "WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hello, Josie....hope you are getting it this time

== Oct 17(Tuesday),06 ==

Hi, Josie, I've done the tasks up to the Log part. Please check on what I've finished today. Question- I don't know why this page doesn't read the code i copied from wiki, please go to the Log part. We can fix that tomorrow. Thanks for the coffee :) Have a great afternoon! fei

Language Reference

2006-11-15T22:58:32Z

Fei:

:''Click on a term below for more information.''

{| style="background-color: lightblue; width: {{{width|100%}}}"

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
*GENERAL INFORMATION
**[[SELES101l02|HOW TO RUN AN EXAMPLE CODE]]

*SYMBOLS
**[[Language Reference 1#plus sign|+]]
**[[Language Reference 1#-|-]]
**[[Language Reference 1#*|*]]
**[[Language Reference 1#/|/]]
**[[Language Reference 1#^|^]]
**[[Language Reference 1#%|%]]
**[[Language Reference 1#==|==]]
**[[Language Reference 1#!=|!=]]
**[[Language Reference 1#<|<]]
**[[Language Reference 1#<=|<=]]
**[[Language Reference 1#>|>]]
**[[Language Reference 1#>=|>=]]
**[[Language Reference 1#!|!]]
* A|Aa
**[[Language Reference 1#ABS(Expr)|ABS(Expr)]]
**[[Language Reference 1#AND|AND]]
**[[Language Reference 1#ARCCOS|ARCCOS]]
**[[Language Reference 1#ARCSIN|ARCSIN]]
**[[Language Reference 1#ARCTAN(Expr)|ARCTAN(Expr)]]
**[[Language Reference 1#ARCTAN(Expr,Expr)|ARCTAN(Expr,Expr)]]
* B|Bb
**[[Language Reference 1#BITWISE AND|BITWISE AND]]
**[[Language Reference 1#BITWISE NOT|BITWISE NOT]]
**[[Language Reference 1#BITWISE OR|BITWISE OR]]
**[[Language Reference 1#BITWISE XOR|BITWISE XOR]]
* C|Cc
**[[Language Reference 1#CEILING(Expr)|CEILING(Expr)]]
**[[Language Reference 1#CLAMP|CLAMP]]
**[[Language Reference 1#CLASSIFIED_DIST|CLASSIFIED_DIST]]
**[[Language Reference 1#CLASSIFIED_DIST_M|CLASSIFIED_DIST_M]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 1#CLASSIFY|CLASSIFY]]
:*[[Language Reference 1#CONTAINS|CONTAINS]]
:*[[Language Reference 1#CONTAINS LINK|CONTAINS LINK]]
:*[[Language Reference 1#COS|COS]]
:*[[Language Reference 1#CRITICAL SECTION|CRITICAL SECTION]]
* D|Dd
:*[[Language Reference 1#DEBUG|DEBUG]]
:*[[Language Reference 1#DECISION|DECISION]]
:*[[Language Reference 1#DIRECTION|DIRECTION]]
:*[[Language Reference 1#DISTANCE|DISTANCE]]
* E|Ee
:*[[Language Reference 1#ELSE|ELSE]]
:*[[Language Reference 1#EQUAL TRUE|EQUAL TRUE]]
:*[[Language Reference 1#EXP(Expr)|EXP(Expr)]]
* F|Ff
:*[[Language Reference 1#FIND|FIND]]
:*[[Language Reference 1#FIND LINK|FIND LINK]]
:*[[Language Reference 1#FIND NEXT|FIND NEXT]]
:*[[Language Reference 1#FIND NEXT LINK|FIND NEXT LINK]]
:*[[Language Reference 1#FIRST|FIRST]]
:*[[Language Reference 1#FIRST LINK|FIRST LINK]]
:*[[Language Reference 1#FLOOR(Expr)|FLOOR(Expr)]]
* G|Gg
:*[[Language Reference 1#GEOMETRIC MEAN|GEOMETRIC MEAN]]
:*[[Language Reference 1#GET|GET]]
:*[[Language Reference 1#GET LINK|GET]]
:*[[Language Reference 1#>=|GREATER OR EQUAL]]
:*[[Language Reference 1#>|GREATER THAN]]
* H|Hh
:*[[Language Reference 1#HEAD|HEAD]]
* I|Ii
:*[[Language Reference 2#IF Expr|IF Expr]]
:*[[Language Reference 2#IF Expr THEN Expr ELSE|IF Expr THEN Expr ELSE]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#INSERT|INSERT]]
:*[[Language Reference 2#INSERT HEAD|INSERT HEAD]]
:*[[Language Reference 2#INSERT LINK|INSERT LINK]]
:*[[Language Reference 2#INSERT TAIL|INSERT TAIL]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#IS EMPTY|IS EMPTY]]
:*[[Language Reference 2#IS EMPTY LINKS|IS EMPTY LINKS]]
* J|Jj
* K|Kk
* L|Ll
:*[[Language Reference 1#<=|LESS OR EQUAL]]
:*[[Language Reference 1#<|LESS THAN]]
:*[[Language Reference 2#LINKED|LINKED]]
:*[[Language Reference 2#LOCATION|LOCATION]]
:*[[Language Reference 2#LOG(Expr)|LOG(Expr)]]
:*[[Language Reference 2#LOG NORMAL CDF|LOG NORMAL CDF]]
:*[[Language Reference 2#LOG NORMAL PDF|LOG NORMAL PDF]]
:*[[Language Reference 2#LOG NORMAL TEMPORAL PDF|LOG NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#LOOKUP|LOOKUP]]
* M|Mm
:*[[Language Reference 2#MAX|MAX]]
:*[[Language Reference 2#MAX POSITION|MAX POSITION]]
:*[[Language Reference 2#MEAN|MEAN]]
:*[[Language Reference 2#MIN|MIN]]
:*[[Language Reference 2#MIN POSITION|MIN POSITION]]
* N|Nn
:*[[Language Reference 2#NEGEXP|NEGEXP]]
:*[[Language Reference 2#NEXT|NEXT]]
:*[[Language Reference 2#NEXT LINK|NEXT LINK]]
:*[[Language Reference 2#NORMAL|NORMAL]]
:*[[Language Reference 2#NORMAL CDF|NORMAL CDF]]
:*[[Language Reference 2#NORMAL PDF|NORMAL PDF]]
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]


| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]
* O|Oo
:*[[Language Reference 3#ONE|ONE]]
:*[[Language Reference 3#OR|OR]]
:*[[Language Reference 3#OUTPUT RECORD|OUTPUT RECORD]]
:*[[Language Reference 3#OVER INDEX SEQUENCE|OVER INDEX SEQUENCE]]
* P|Pp
:*[[Language Reference 3#PAUSE|PAUSE]]
:*[[Language Reference 3#PAUSE (#Value)IF|PAUSE (#Value)IF]]
:*[[Language Reference 3#PAUSE IF|PAUSE IF]]
:*[[Language Reference 3#PREV|PREV]]
:*[[Language Reference 3#PREV LINK|PREV LINK]]
* Q|Qq
* R|Rr
:*[[Language Reference 3#RECOMPUTE|RECOMPUTE]]
:*[[Language Reference 3#REGION CENTRED|REGION CENTRED]]
:*[[Language Reference 3#REGION COST SURFACE|REGION COST SURFACE]]
:*[[Language Reference 3#REGION LEAST COST PATH|REGION LEAST COST PATH]]
:*[[Language Reference 3#REGION LOCATION|REGION LOCATION]]
:*[[Language Reference 3#REGION LOCATION LIST|REGION LOCATION LIST]]
:*[[Language Reference 3#REGION RECT|REGION RECT]]
:*[[Language Reference 3#REGION VECTOR|REGION VECTOR]]
:*[[Language Reference 3#REGION WHOLE MAP|REGION WHOLE MAP]]
:*[[Language Reference 3#REMOVE|REMOVE]]
:*[[Language Reference 3#REMOVE ALL LINKS|REMOVE ALL LINKS]]
:*[[Language Reference 3#REMOVE LINK|REMOVE LINK]]
:*[[Language Reference 3#RESIZE|RESIZE]]
:*[[Language Reference 3#RESPONSE|RESPONSE]]
:*[[Language Reference 3#ROUND(Expr)|ROUND(Expr)]]
* S|Ss
:*[[Language Reference 3#SEED|SEED]]
:*[[Language Reference 3#SELECTAT|SELECTAT]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 3#SET|SET]]
:*[[Language Reference 3#SET LINK|SET LINK]]
:*[[Language Reference 3#SETAT|SETAT]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type)]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type,#Prob)]]
:*[[Language Reference 3#SHIFT LEFT|SHIFT LEFT]]
:*[[Language Reference 3#SHIFT RIGHT|SHIFT RIGHT]]
:*[[Language Reference 3#SIN|SIN]]
:*[[Language Reference 3#SIZE LINKS|SIZE LINKS]]
:*[[Language Reference 3#SKEWED NORMAL CDF|SKEWED NORMAL CDF]]
:*[[Language Reference 3#SKEWED NORMAL PDF|SKEWED NORMAL PDF]]
:*[[Language Reference 3#SKEWED NORMAL TEMPORAL PDF|SKEWED NORMAL TEMPORAL PDF]]
:*[[Language Reference 3#SORT|SORT]]
:*[[Language Reference 3#SORT LINKS|SORT LINKS]]
:*[[Language Reference 3#STRICT ORDERED|STRICT ORDERED]]
:*[[Language Reference 3#SUM|SUM]]
* T|Tt
:*[[Language Reference 3#TAIL|TAIL]]
:*[[Language Reference 3#TAN|TAN]]
* U|Uu
:*[[Language Reference 3#UNIFORM|UNIFORM]]
:*[[Language Reference 3#UNIFORM TEMPORAL PDF|UNIFORM TEMPORAL PDF]]
* V|Vv
* W|Ww
:*[[Language Reference 3#WAIT UNTIL|WAIT UNTIL]]
:*[[Language Reference 3#WHILE|WHILE]]
* X|Xx
* Y|Yy
* Z|Zz
:*[[Language Reference 3#ZERO|ZERO]]

|}

Language Reference

2006-11-15T22:51:52Z

Fei:

:''Click on a term below for more information.''

{| style="background-color: lightblue; width: {{{width|100%}}}"

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
*GENERAL INFORMATION
**[[SELES101l02|HOW TO RUN AN EXAMPLE CODE]]

*SYMBOLS
**[[Language Reference 1#plus sign|+]]
**[[Language Reference 1#-|-]]
**[[Language Reference 1#*|*]]
**[[Language Reference 1#/|/]]
**[[Language Reference 1#^|^]]
**[[Language Reference 1#%|%]]
**[[Language Reference 1#==|==]]
**[[Language Reference 1#!=|!=]]
**[[Language Reference 1#<|<]]
**[[Language Reference 1#<=|<=]]
**[[Language Reference 1#>|>]]
**[[Language Reference 1#>=|>=]]
**[[Language Reference 1#!|!]]
* A|Aa
**[[Language Reference 1#ABS(Expr)|ABS(Expr)]]
**[[Language Reference 1#AND|AND]]
**[[Language Reference 1#ARCCOS|ARCCOS]]
**[[Language Reference 1#ARCSIN|ARCSIN]]
**[[Language Reference 1#ARCTAN(Expr)|ARCTAN(Expr)]]
**[[Language Reference 1#ARCTAN(Expr,Expr)|ARCTAN(Expr,Expr)]]
* B|Bb
**[[Language Reference 1#BITWISE AND|BITWISE AND]]
**[[Language Reference 1#BITWISE NOT|BITWISE NOT]]
**[[Language Reference 1#BITWISE OR|BITWISE OR]]
**[[Language Reference 1#BITWISE XOR|BITWISE XOR]]
* C|Cc
**[[Language Reference 1#CEILING(Expr)|CEILING(Expr)]]
**[[Language Reference 1#CLAMP|CLAMP]]
**[[Language Reference 1#CLASSIFIED_DIST|CLASSIFIED_DIST]]
**[[Language Reference 1#CLASSIFIED_DIST_M|CLASSIFIED_DIST_M]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 1#CLASSIFY|CLASSIFY]]
:*[[Language Reference 1#CONTAINS|CONTAINS]]
:*[[Language Reference 1#CONTAINS LINK|CONTAINS LINK]]
:*[[Language Reference 1#COS|COS]]
:*[[Language Reference 1#CRITICAL SECTION|CRITICAL SECTION]]
* D|Dd
:*[[Language Reference 1#DEBUG|DEBUG]]
:*[[Language Reference 1#DECISION|DECISION]]
:*[[Language Reference 1#DIRECTION|DIRECTION]]
:*[[Language Reference 1#DISTANCE|DISTANCE]]
* E|Ee
:*[[Language Reference 1#ELSE|ELSE]]
:*[[Language Reference 1#EQUAL TRUE|EQUAL TRUE]]
:*[[Language Reference 1#EXP(Expr)|EXP(Expr)]]
* F|Ff
:*[[Language Reference 1#FIND|FIND]]
:*[[Language Reference 1#FIND LINK|FIND LINK]]
:*[[Language Reference 1#FIND NEXT|FIND NEXT]]
:*[[Language Reference 1#FIND NEXT LINK|FIND NEXT LINK]]
:*[[Language Reference 1#FIRST|FIRST]]
:*[[Language Reference 1#FIRST LINK|FIRST LINK]]
:*[[Language Reference 1#FLOOR(Expr)|FLOOR(Expr)]]
* G|Gg
:*[[Language Reference 1#GEOMETRIC MEAN|GEOMETRIC MEAN]]
:*[[Language Reference 1#GET|GET]]
:*[[Language Reference 1#GET LINK|GET]]
:*[[Language Reference 1#>=|GREATER OR EQUAL]]
:*[[Language Reference 1#>|GREATER THAN]]
* H|Hh
:*[[Language Reference 1#HEAD|HEAD]]
* I|Ii
:*[[Language Reference 2#IF Expr|IF Expr]]
:*[[Language Reference 2#IF Expr THEN Expr ELSE|IF Expr THEN Expr ELSE]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#INSERT|INSERT]]
:*[[Language Reference 2#INSERT HEAD|INSERT HEAD]]
:*[[Language Reference 2#INSERT LINK|INSERT LINK]]
:*[[Language Reference 2#INSERT TAIL|INSERT TAIL]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#IS EMPTY|IS EMPTY]]
:*[[Language Reference 2#IS EMPTY LINKS|IS EMPTY LINKS]]
* J|Jj
* K|Kk
* L|Ll
:*[[Language Reference 1#<=|LESS OR EQUAL]]
:*[[Language Reference 1#<|LESS THAN]]
:*[[Language Reference 2#LINKED|LINKED]]
:*[[Language Reference 2#LOCATION|LOCATION]]
:*[[Language Reference 2#LOG(Expr)|LOG(Expr)]]
:*[[Language Reference 2#LOG NORMAL CDF|LOG NORMAL CDF]]
:*[[Language Reference 2#LOG NORMAL PDF|LOG NORMAL PDF]]
:*[[Language Reference 2#LOG NORMAL TEMPORAL PDF|LOG NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#LOOKUP|LOOKUP]]
* M|Mm
:*[[Language Reference 2#MAX|MAX]]
:*[[Language Reference 2#MAX POSITION|MAX POSITION]]
:*[[Language Reference 2#MEAN|MEAN]]
:*[[Language Reference 2#MIN|MIN]]
:*[[Language Reference 2#MIN POSITION|MIN POSITION]]
* N|Nn
:*[[Language Reference 2#NEGEXP|NEGEXP]]
:*[[Language Reference 2#NEXT|NEXT]]
:*[[Language Reference 2#NEXT LINK|NEXT LINK]]
:*[[Language Reference 2#NORMAL CDF|NORMAL CDF]]
:*[[Language Reference 2#NORMAL PDF|NORMAL PDF]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]
* O|Oo
:*[[Language Reference 3#ONE|ONE]]
:*[[Language Reference 3#OR|OR]]
:*[[Language Reference 3#OVER INDEX SEQUENCE|OVER INDEX SEQUENCE]]
* P|Pp
:*[[Language Reference 3#PAUSE|PAUSE]]
:*[[Language Reference 3#PAUSE (#Value)IF|PAUSE (#Value)IF]]
:*[[Language Reference 3#PAUSE IF|PAUSE IF]]
:*[[Language Reference 3#PREV|PREV]]
:*[[Language Reference 3#PREV LINK|PREV LINK]]
* Q|Qq
* R|Rr
:*[[Language Reference 3#RECOMPUTE|RECOMPUTE]]
:*[[Language Reference 3#REGION CENTRED|REGION CENTRED]]
:*[[Language Reference 3#REGION COST SURFACE|REGION COST SURFACE]]
:*[[Language Reference 3#REGION LEAST COST PATH|REGION LEAST COST PATH]]
:*[[Language Reference 3#REGION LOCATION|REGION LOCATION]]
:*[[Language Reference 3#REGION LOCATION LIST|REGION LOCATION LIST]]
:*[[Language Reference 3#REGION RECT|REGION RECT]]
:*[[Language Reference 3#REGION WHOLE MAP|REGION WHOLE MAP]]
:*[[Language Reference 3#REMOVE|REMOVE]]
:*[[Language Reference 3#REMOVE ALL LINKS|REMOVE ALL LINKS]]
:*[[Language Reference 3#REMOVE LINK|REMOVE LINK]]
:*[[Language Reference 3#RESIZE|RESIZE]]
:*[[Language Reference 3#RESPONSE|RESPONSE]]
:*[[Language Reference 3#ROUND(Expr)|ROUND(Expr)]]
* S|Ss
:*[[Language Reference 3#SEED|SEED]]
:*[[Language Reference 3#SELECTAT|SELECTAT]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 3#SET|SET]]
:*[[Language Reference 3#SET LINK|SET LINK]]
:*[[Language Reference 3#SETAT|SETAT]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type)]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type,#Prob)]]
:*[[Language Reference 3#SHIFT LEFT|SHIFT LEFT]]
:*[[Language Reference 3#SHIFT RIGHT|SHIFT RIGHT]]
:*[[Language Reference 3#SIN|SIN]]
:*[[Language Reference 3#SIZE LINKS|SIZE LINKS]]
:*[[Language Reference 3#SKEWED NORMAL CDF|SKEWED NORMAL CDF]]
:*[[Language Reference 3#SKEWED NORMAL PDF|SKEWED NORMAL PDF]]
:*[[Language Reference 3#SKEWED NORMAL TEMPORAL PDF|SKEWED NORMAL TEMPORAL PDF]]
:*[[Language Reference 3#SORT|SORT]]
:*[[Language Reference 3#SORT LINKS|SORT LINKS]]
:*[[Language Reference 3#STRICT ORDERED|STRICT ORDERED]]
:*[[Language Reference 3#SUM|SUM]]
* T|Tt
:*[[Language Reference 3#TAIL|TAIL]]
:*[[Language Reference 3#TAN|TAN]]
* U|Uu
:*[[Language Reference 3#UNIFORM|UNIFORM]]
:*[[Language Reference 3#UNIFORM TEMPORAL PDF|UNIFORM TEMPORAL PDF]]
* V|Vv
* W|Ww
:*[[Language Reference 3#WAIT UNTIL|WAIT UNTIL]]
:*[[Language Reference 3#WHILE|WHILE]]
* X|Xx
* Y|Yy
* Z|Zz
:*[[Language Reference 3#ZERO|ZERO]]

|}

Language Reference 2

2006-11-15T22:50:51Z

Fei: /* LINKED */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
INSERT(nnGraph[currType], patchVar)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
INSERT LINK(nnGraph[currType], patchPos, nPos2, edgeVar)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(patchList[currType], patchVar)

Example 2:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(coreAreaList[PatchLayer], patchVar)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOCATION==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
EdgeLocation = LOCATION(EdgeRow, EdgeCol)
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT(nnGraph[pType], pos)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

Language Reference 1

2006-11-15T22:41:45Z

Fei: /* HEAD */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area1 = GET(nnGraph[currType], patchPos, rArea)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area2 = GET(nnGraph[currType], nPos2, rArea)

SAMPLE MODELS:
<links to sample models where this function is used>

==GET LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgeVar [=] GET LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
pos = HEAD(coreAreaList[i])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 1

2006-11-15T22:41:07Z

Fei: /* HEAD */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area1 = GET(nnGraph[currType], patchPos, rArea)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area2 = GET(nnGraph[currType], nPos2, rArea)

SAMPLE MODELS:
<links to sample models where this function is used>

==GET LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgeVar [=] GET LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats# stats.lse|stats.lse]] for the working example.
pos = HEAD(coreAreaList[i])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference

2006-11-15T22:34:31Z

Fei:

:''Click on a term below for more information.''

{| style="background-color: lightblue; width: {{{width|100%}}}"

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
*GENERAL INFORMATION
**[[SELES101l02|HOW TO RUN AN EXAMPLE CODE]]

*SYMBOLS
**[[Language Reference 1#plus sign|+]]
**[[Language Reference 1#-|-]]
**[[Language Reference 1#*|*]]
**[[Language Reference 1#/|/]]
**[[Language Reference 1#^|^]]
**[[Language Reference 1#%|%]]
**[[Language Reference 1#==|==]]
**[[Language Reference 1#!=|!=]]
**[[Language Reference 1#<|<]]
**[[Language Reference 1#<=|<=]]
**[[Language Reference 1#>|>]]
**[[Language Reference 1#>=|>=]]
**[[Language Reference 1#!|!]]
* A|Aa
**[[Language Reference 1#ABS(Expr)|ABS(Expr)]]
**[[Language Reference 1#AND|AND]]
**[[Language Reference 1#ARCCOS|ARCCOS]]
**[[Language Reference 1#ARCSIN|ARCSIN]]
**[[Language Reference 1#ARCTAN(Expr)|ARCTAN(Expr)]]
**[[Language Reference 1#ARCTAN(Expr,Expr)|ARCTAN(Expr,Expr)]]
* B|Bb
**[[Language Reference 1#BITWISE AND|BITWISE AND]]
**[[Language Reference 1#BITWISE NOT|BITWISE NOT]]
**[[Language Reference 1#BITWISE OR|BITWISE OR]]
**[[Language Reference 1#BITWISE XOR|BITWISE XOR]]
* C|Cc
**[[Language Reference 1#CEILING(Expr)|CEILING(Expr)]]
**[[Language Reference 1#CLAMP|CLAMP]]
**[[Language Reference 1#CLASSIFIED_DIST|CLASSIFIED_DIST]]
**[[Language Reference 1#CLASSIFIED_DIST_M|CLASSIFIED_DIST_M]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 1#CLASSIFY|CLASSIFY]]
:*[[Language Reference 1#CONTAINS|CONTAINS]]
:*[[Language Reference 1#CONTAINS LINK|CONTAINS LINK]]
:*[[Language Reference 1#COS|COS]]
:*[[Language Reference 1#CRITICAL SECTION|CRITICAL SECTION]]
* D|Dd
:*[[Language Reference 1#DEBUG|DEBUG]]
:*[[Language Reference 1#DECISION|DECISION]]
:*[[Language Reference 1#DIRECTION|DIRECTION]]
:*[[Language Reference 1#DISTANCE|DISTANCE]]
* E|Ee
:*[[Language Reference 1#ELSE|ELSE]]
:*[[Language Reference 1#EQUAL TRUE|EQUAL TRUE]]
:*[[Language Reference 1#EXP(Expr)|EXP(Expr)]]
* F|Ff
:*[[Language Reference 1#FIND|FIND]]
:*[[Language Reference 1#FIND LINK|FIND LINK]]
:*[[Language Reference 1#FIND NEXT|FIND NEXT]]
:*[[Language Reference 1#FIND NEXT LINK|FIND NEXT LINK]]
:*[[Language Reference 1#FIRST|FIRST]]
:*[[Language Reference 1#FIRST LINK|FIRST LINK]]
:*[[Language Reference 1#FLOOR(Expr)|FLOOR(Expr)]]
* G|Gg
:*[[Language Reference 1#GEOMETRIC MEAN|GEOMETRIC MEAN]]
:*[[Language Reference 1#GET|GET]]
:*[[Language Reference 1#GET LINK|GET]]
:*[[Language Reference 1#>=|GREATER OR EQUAL]]
:*[[Language Reference 1#>|GREATER THAN]]
* H|Hh
:*[[Language Reference 1#HEAD|HEAD]]
* I|Ii
:*[[Language Reference 2#IF Expr|IF Expr]]
:*[[Language Reference 2#IF Expr THEN Expr ELSE|IF Expr THEN Expr ELSE]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#INSERT|INSERT]]
:*[[Language Reference 2#INSERT HEAD|INSERT HEAD]]
:*[[Language Reference 2#INSERT LINK|INSERT LINK]]
:*[[Language Reference 2#INSERT TAIL|INSERT TAIL]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#IS EMPTY|IS EMPTY]]
:*[[Language Reference 2#IS EMPTY LINKS|IS EMPTY LINKS]]
* J|Jj
* K|Kk
* L|Ll
:*[[Language Reference 1#<=|LESS OR EQUAL]]
:*[[Language Reference 1#<|LESS THAN]]
:*[[Language Reference 2#LINKED|LINKED]]
:*[[Language Reference 2#LOG(Expr)|LOG(Expr)]]
:*[[Language Reference 2#LOG NORMAL CDF|LOG NORMAL CDF]]
:*[[Language Reference 2#LOG NORMAL PDF|LOG NORMAL PDF]]
:*[[Language Reference 2#LOG NORMAL TEMPORAL PDF|LOG NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#LOOKUP|LOOKUP]]
* M|Mm
:*[[Language Reference 2#MAX|MAX]]
:*[[Language Reference 2#MAX POSITION|MAX POSITION]]
:*[[Language Reference 2#MEAN|MEAN]]
:*[[Language Reference 2#MIN|MIN]]
:*[[Language Reference 2#MIN POSITION|MIN POSITION]]
* N|Nn
:*[[Language Reference 2#NEGEXP|NEGEXP]]
:*[[Language Reference 2#NEXT|NEXT]]
:*[[Language Reference 2#NEXT LINK|NEXT LINK]]
:*[[Language Reference 2#NORMAL CDF|NORMAL CDF]]
:*[[Language Reference 2#NORMAL PDF|NORMAL PDF]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]
* O|Oo
:*[[Language Reference 3#ONE|ONE]]
:*[[Language Reference 3#OR|OR]]
:*[[Language Reference 3#OVER INDEX SEQUENCE|OVER INDEX SEQUENCE]]
* P|Pp
:*[[Language Reference 3#PAUSE|PAUSE]]
:*[[Language Reference 3#PAUSE (#Value)IF|PAUSE (#Value)IF]]
:*[[Language Reference 3#PAUSE IF|PAUSE IF]]
:*[[Language Reference 3#PREV|PREV]]
:*[[Language Reference 3#PREV LINK|PREV LINK]]
* Q|Qq
* R|Rr
:*[[Language Reference 3#RECOMPUTE|RECOMPUTE]]
:*[[Language Reference 3#REGION CENTRED|REGION CENTRED]]
:*[[Language Reference 3#REGION COST SURFACE|REGION COST SURFACE]]
:*[[Language Reference 3#REGION LEAST COST PATH|REGION LEAST COST PATH]]
:*[[Language Reference 3#REGION LOCATION|REGION LOCATION]]
:*[[Language Reference 3#REGION LOCATION LIST|REGION LOCATION LIST]]
:*[[Language Reference 3#REGION RECT|REGION RECT]]
:*[[Language Reference 3#REGION WHOLE MAP|REGION WHOLE MAP]]
:*[[Language Reference 3#REMOVE|REMOVE]]
:*[[Language Reference 3#REMOVE ALL LINKS|REMOVE ALL LINKS]]
:*[[Language Reference 3#REMOVE LINK|REMOVE LINK]]
:*[[Language Reference 3#RESIZE|RESIZE]]
:*[[Language Reference 3#RESPONSE|RESPONSE]]
:*[[Language Reference 3#ROUND(Expr)|ROUND(Expr)]]
* S|Ss
:*[[Language Reference 3#SEED|SEED]]
:*[[Language Reference 3#SELECTAT|SELECTAT]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 3#SET|SET]]
:*[[Language Reference 3#SET LINK|SET LINK]]
:*[[Language Reference 3#SETAT|SETAT]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type)]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type,#Prob)]]
:*[[Language Reference 3#SHIFT LEFT|SHIFT LEFT]]
:*[[Language Reference 3#SHIFT RIGHT|SHIFT RIGHT]]
:*[[Language Reference 3#SIN|SIN]]
:*[[Language Reference 3#SIZE LINKS|SIZE LINKS]]
:*[[Language Reference 3#SKEWED NORMAL CDF|SKEWED NORMAL CDF]]
:*[[Language Reference 3#SKEWED NORMAL PDF|SKEWED NORMAL PDF]]
:*[[Language Reference 3#SKEWED NORMAL TEMPORAL PDF|SKEWED NORMAL TEMPORAL PDF]]
:*[[Language Reference 3#SORT|SORT]]
:*[[Language Reference 3#SORT LINKS|SORT LINKS]]
:*[[Language Reference 3#STRICT ORDERED|STRICT ORDERED]]
:*[[Language Reference 3#SUM|SUM]]
* T|Tt
:*[[Language Reference 3#TAIL|TAIL]]
:*[[Language Reference 3#TAN|TAN]]
* U|Uu
:*[[Language Reference 3#UNIFORM|UNIFORM]]
:*[[Language Reference 3#UNIFORM TEMPORAL PDF|UNIFORM TEMPORAL PDF]]
* V|Vv
* W|Ww
:*[[Language Reference 3#WAIT UNTIL|WAIT UNTIL]]
:*[[Language Reference 3#WHILE|WHILE]]
* X|Xx
* Y|Yy
* Z|Zz
:*[[Language Reference 3#ZERO|ZERO]]

|}

User talk:Fei

2006-11-15T22:23:40Z

Fei: /* Nov. 15 2006-a note to myself */

===Nov. 15 2006-a note to myself===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***GET
***GET LINK
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
***INSERT LINK
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

Language Reference 2

2006-11-15T22:23:18Z

Fei: /* INSERT HEAD */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
INSERT(nnGraph[currType], patchVar)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
INSERT LINK(nnGraph[currType], patchPos, nPos2, edgeVar)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(patchList[currType], patchVar)

Example 2:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(coreAreaList[PatchLayer], patchVar)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT(nnGraph[pType], pos)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

Language Reference 1

2006-11-15T22:20:19Z

Fei: /* GET LINK */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area1 = GET(nnGraph[currType], patchPos, rArea)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area2 = GET(nnGraph[currType], nPos2, rArea)

SAMPLE MODELS:
<links to sample models where this function is used>

==GET LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgeVar [=] GET LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 1

2006-11-15T22:17:40Z

Fei: /* GET */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area1 = GET(nnGraph[currType], patchPos, rArea)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working model.
Area2 = GET(nnGraph[currType], nPos2, rArea)

SAMPLE MODELS:
<links to sample models where this function is used>

==GET LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 1

2006-11-15T22:16:31Z

Fei: /* GET LINK */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET LINK==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 1

2006-11-15T22:16:15Z

Fei: /* GET */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET LINK==

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 1

2006-11-15T22:15:30Z

Fei:

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GET==

==GET LINK==

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference

2006-11-15T22:14:44Z

Fei:

:''Click on a term below for more information.''

{| style="background-color: lightblue; width: {{{width|100%}}}"

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
*GENERAL INFORMATION
**[[SELES101l02|HOW TO RUN AN EXAMPLE CODE]]

*SYMBOLS
**[[Language Reference 1#plus sign|+]]
**[[Language Reference 1#-|-]]
**[[Language Reference 1#*|*]]
**[[Language Reference 1#/|/]]
**[[Language Reference 1#^|^]]
**[[Language Reference 1#%|%]]
**[[Language Reference 1#==|==]]
**[[Language Reference 1#!=|!=]]
**[[Language Reference 1#<|<]]
**[[Language Reference 1#<=|<=]]
**[[Language Reference 1#>|>]]
**[[Language Reference 1#>=|>=]]
**[[Language Reference 1#!|!]]
* A|Aa
**[[Language Reference 1#ABS(Expr)|ABS(Expr)]]
**[[Language Reference 1#AND|AND]]
**[[Language Reference 1#ARCCOS|ARCCOS]]
**[[Language Reference 1#ARCSIN|ARCSIN]]
**[[Language Reference 1#ARCTAN(Expr)|ARCTAN(Expr)]]
**[[Language Reference 1#ARCTAN(Expr,Expr)|ARCTAN(Expr,Expr)]]
* B|Bb
**[[Language Reference 1#BITWISE AND|BITWISE AND]]
**[[Language Reference 1#BITWISE NOT|BITWISE NOT]]
**[[Language Reference 1#BITWISE OR|BITWISE OR]]
**[[Language Reference 1#BITWISE XOR|BITWISE XOR]]
* C|Cc
**[[Language Reference 1#CEILING(Expr)|CEILING(Expr)]]
**[[Language Reference 1#CLAMP|CLAMP]]
**[[Language Reference 1#CLASSIFIED_DIST|CLASSIFIED_DIST]]
**[[Language Reference 1#CLASSIFIED_DIST_M|CLASSIFIED_DIST_M]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 1#CLASSIFY|CLASSIFY]]
:*[[Language Reference 1#CONTAINS|CONTAINS]]
:*[[Language Reference 1#CONTAINS LINK|CONTAINS LINK]]
:*[[Language Reference 1#COS|COS]]
:*[[Language Reference 1#CRITICAL SECTION|CRITICAL SECTION]]
* D|Dd
:*[[Language Reference 1#DEBUG|DEBUG]]
:*[[Language Reference 1#DECISION|DECISION]]
:*[[Language Reference 1#DIRECTION|DIRECTION]]
:*[[Language Reference 1#DISTANCE|DISTANCE]]
* E|Ee
:*[[Language Reference 1#ELSE|ELSE]]
:*[[Language Reference 1#EQUAL TRUE|EQUAL TRUE]]
:*[[Language Reference 1#EXP(Expr)|EXP(Expr)]]
* F|Ff
:*[[Language Reference 1#FIND|FIND]]
:*[[Language Reference 1#FIND LINK|FIND LINK]]
:*[[Language Reference 1#FIND NEXT|FIND NEXT]]
:*[[Language Reference 1#FIND NEXT LINK|FIND NEXT LINK]]
:*[[Language Reference 1#FIRST|FIRST]]
:*[[Language Reference 1#FIRST LINK|FIRST LINK]]
:*[[Language Reference 1#FLOOR(Expr)|FLOOR(Expr)]]
* G|Gg
:*[[Language Reference 1#GEOMETRIC MEAN|GEOMETRIC MEAN]]
:*[[Language Reference 1#GET|GET]]
:*[[Language Reference 1#GET LINK|GET]]
:*[[Language Reference 1#>=|GREATER OR EQUAL]]
:*[[Language Reference 1#>|GREATER THAN]]
* H|Hh
:*[[Language Reference 1#HEAD|HEAD]]
* I|Ii
:*[[Language Reference 2#IF Expr|IF Expr]]
:*[[Language Reference 2#IF Expr THEN Expr ELSE|IF Expr THEN Expr ELSE]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#INSERT|INSERT]]
:*[[Language Reference 2#INSERT HEAD|INSERT HEAD]]
:*[[Language Reference 2#INSERT TAIL|INSERT TAIL]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#INTERPOLATE|INTERPOLATE]]
:*[[Language Reference 2#IS EMPTY|IS EMPTY]]
:*[[Language Reference 2#IS EMPTY LINKS|IS EMPTY LINKS]]
* J|Jj
* K|Kk
* L|Ll
:*[[Language Reference 1#<=|LESS OR EQUAL]]
:*[[Language Reference 1#<|LESS THAN]]
:*[[Language Reference 2#LINKED|LINKED]]
:*[[Language Reference 2#LOG(Expr)|LOG(Expr)]]
:*[[Language Reference 2#LOG NORMAL CDF|LOG NORMAL CDF]]
:*[[Language Reference 2#LOG NORMAL PDF|LOG NORMAL PDF]]
:*[[Language Reference 2#LOG NORMAL TEMPORAL PDF|LOG NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#LOOKUP|LOOKUP]]
* M|Mm
:*[[Language Reference 2#MAX|MAX]]
:*[[Language Reference 2#MAX POSITION|MAX POSITION]]
:*[[Language Reference 2#MEAN|MEAN]]
:*[[Language Reference 2#MIN|MIN]]
:*[[Language Reference 2#MIN POSITION|MIN POSITION]]
* N|Nn
:*[[Language Reference 2#NEGEXP|NEGEXP]]
:*[[Language Reference 2#NEXT|NEXT]]
:*[[Language Reference 2#NEXT LINK|NEXT LINK]]
:*[[Language Reference 2#NORMAL CDF|NORMAL CDF]]
:*[[Language Reference 2#NORMAL PDF|NORMAL PDF]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 2#NORMAL TEMPORAL PDF|NORMAL TEMPORAL PDF]]
:*[[Language Reference 2#NOT EQUAL|NOT EQUAL]]
* O|Oo
:*[[Language Reference 3#ONE|ONE]]
:*[[Language Reference 3#OR|OR]]
:*[[Language Reference 3#OVER INDEX SEQUENCE|OVER INDEX SEQUENCE]]
* P|Pp
:*[[Language Reference 3#PAUSE|PAUSE]]
:*[[Language Reference 3#PAUSE (#Value)IF|PAUSE (#Value)IF]]
:*[[Language Reference 3#PAUSE IF|PAUSE IF]]
:*[[Language Reference 3#PREV|PREV]]
:*[[Language Reference 3#PREV LINK|PREV LINK]]
* Q|Qq
* R|Rr
:*[[Language Reference 3#RECOMPUTE|RECOMPUTE]]
:*[[Language Reference 3#REGION CENTRED|REGION CENTRED]]
:*[[Language Reference 3#REGION COST SURFACE|REGION COST SURFACE]]
:*[[Language Reference 3#REGION LEAST COST PATH|REGION LEAST COST PATH]]
:*[[Language Reference 3#REGION LOCATION|REGION LOCATION]]
:*[[Language Reference 3#REGION LOCATION LIST|REGION LOCATION LIST]]
:*[[Language Reference 3#REGION RECT|REGION RECT]]
:*[[Language Reference 3#REGION WHOLE MAP|REGION WHOLE MAP]]
:*[[Language Reference 3#REMOVE|REMOVE]]
:*[[Language Reference 3#REMOVE ALL LINKS|REMOVE ALL LINKS]]
:*[[Language Reference 3#REMOVE LINK|REMOVE LINK]]
:*[[Language Reference 3#RESIZE|RESIZE]]
:*[[Language Reference 3#RESPONSE|RESPONSE]]
:*[[Language Reference 3#ROUND(Expr)|ROUND(Expr)]]
* S|Ss
:*[[Language Reference 3#SEED|SEED]]
:*[[Language Reference 3#SELECTAT|SELECTAT]]

| width="20%" align="{{{align|left}}}" valign="{{{valign|top}}}" |
:*[[Language Reference 3#SET|SET]]
:*[[Language Reference 3#SET LINK|SET LINK]]
:*[[Language Reference 3#SETAT|SETAT]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type)]]
:*[[Language Reference 3#SETAT(Expr,PositionList,#Type)|SETAT(Expr,PositionList,#Type,#Prob)]]
:*[[Language Reference 3#SHIFT LEFT|SHIFT LEFT]]
:*[[Language Reference 3#SHIFT RIGHT|SHIFT RIGHT]]
:*[[Language Reference 3#SIN|SIN]]
:*[[Language Reference 3#SIZE LINKS|SIZE LINKS]]
:*[[Language Reference 3#SKEWED NORMAL CDF|SKEWED NORMAL CDF]]
:*[[Language Reference 3#SKEWED NORMAL PDF|SKEWED NORMAL PDF]]
:*[[Language Reference 3#SKEWED NORMAL TEMPORAL PDF|SKEWED NORMAL TEMPORAL PDF]]
:*[[Language Reference 3#SORT|SORT]]
:*[[Language Reference 3#SORT LINKS|SORT LINKS]]
:*[[Language Reference 3#STRICT ORDERED|STRICT ORDERED]]
:*[[Language Reference 3#SUM|SUM]]
* T|Tt
:*[[Language Reference 3#TAIL|TAIL]]
:*[[Language Reference 3#TAN|TAN]]
* U|Uu
:*[[Language Reference 3#UNIFORM|UNIFORM]]
:*[[Language Reference 3#UNIFORM TEMPORAL PDF|UNIFORM TEMPORAL PDF]]
* V|Vv
* W|Ww
:*[[Language Reference 3#WAIT UNTIL|WAIT UNTIL]]
:*[[Language Reference 3#WHILE|WHILE]]
* X|Xx
* Y|Yy
* Z|Zz
:*[[Language Reference 3#ZERO|ZERO]]

|}

User talk:Fei

2006-11-15T22:10:16Z

Fei: /* Nov. 15 2006-a note to myself */

===Nov. 15 2006-a note to myself===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***OUTPUT RECORD
***RESIZE
***FIND
***FIND LINK
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
***INSERT
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

Language Reference 3

2006-11-15T22:09:26Z

Fei: /* REGION VECTOR */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[currType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: currType
CCE: MeanCCE[currType]
MaxCCE: MaxCCE[currType]
CD: MeanCD[currType]
ENDFN

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#nn.lse|nn.lse]] for the working example.
OVER REGION VECTOR(startLocation,NNLoc)
PatchLinks = edgeVar[rEdgeType]+1
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
SET(patchList[i], pos1, rMaxCCE, maxCCE1)
MaxCCE[currType] = MaxCCE[currType] + maxCCE1
pos1 = nextPos
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#consumeCA.lse|consumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

Language Reference 2

2006-11-15T22:06:08Z

Fei: /* INSERT */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
INSERT(nnGraph[currType], patchVar)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(patchList[currType], patchVar)

Example 2:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(coreAreaList[PatchLayer], patchVar)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT(nnGraph[pType], pos)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

Language Reference 1

2006-11-15T22:04:22Z

Fei: /* FIND LINK */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
edgePos = FIND LINK(nnGraph[currType]
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 1

2006-11-15T22:02:09Z

Fei: /* FIND */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIND(patchList[currType], patchVar, patchVar[rId] EQ currPatchId)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

User talk:Fei

2006-11-15T22:00:06Z

Fei: /* Nov. 15 2006-a note to myself */

===Nov. 15 2006-a note to myself===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***OUTPUT RECORD
***RESIZE
***FIRST
***FIRST LINK
***NEXT
***NEXT LINK
***OVER REGION VECTOR
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

Language Reference 1

2006-11-15T21:59:42Z

Fei: /* FIRST LINK */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = FIRST LINK(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 2

2006-11-15T21:58:43Z

Fei: /* NEXT LINK */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(patchList[currType], patchVar)

Example 2:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(coreAreaList[PatchLayer], patchVar)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT(nnGraph[pType], pos)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT LINK(nnGraph[pType], pos)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

Language Reference 2

2006-11-15T21:57:16Z

Fei: /* NEXT */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(patchList[currType], patchVar)

Example 2:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(coreAreaList[PatchLayer], patchVar)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
pos = NEXT(nnGraph[pType], pos)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

Language Reference 1

2006-11-15T21:55:27Z

Fei: /* FIRST */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example
pos = FIRST(nnGraph[pType])

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

User talk:Fei

2006-11-15T21:53:28Z

Fei: /* Nov. 15 2006-a note to myself */

===Nov. 15 2006-a note to myself===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***OUTPUT RECORD
***RESIZE
***OVER REGION VECTOR
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
***OUTPUT RECORD
**IdentifyPatches.lse
***IF
***ELSE
***INSERT TAIL
*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

Language Reference 2

2006-11-15T21:52:55Z

Fei: /* INSERT TAIL */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(patchList[currType], patchVar)

Example 2:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example
INSERT TAIL(coreAreaList[PatchLayer], patchVar)

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

Language Reference 3

2006-11-15T21:49:54Z

Fei: /* OUTPUT RECORD */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[currType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: currType
CCE: MeanCCE[currType]
MaxCCE: MaxCCE[currType]
CD: MeanCD[currType]
ENDFN

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
SET(patchList[i], pos1, rMaxCCE, maxCCE1)
MaxCCE[currType] = MaxCCE[currType] + maxCCE1
pos1 = nextPos
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#consumeCA.lse|consumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

Language Reference 3

2006-11-15T21:49:16Z

Fei: /* OUTPUT RECORD */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[currType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: currType
CCE: MeanCCE[currType]
MaxCCE: MaxCCE[currType]
CD: MeanCD[currType]
ENDFN

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
SET(patchList[i], pos1, rMaxCCE, maxCCE1)
MaxCCE[currType] = MaxCCE[currType] + maxCCE1
pos1 = nextPos
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#consumeCA.lse|consumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

Language Reference 3

2006-11-15T21:47:51Z

Fei: /* SET */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
SET(patchList[i], pos1, rMaxCCE, maxCCE1)
MaxCCE[currType] = MaxCCE[currType] + maxCCE1
pos1 = nextPos
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#consumeCA.lse|consumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

Language Reference 3

2006-11-15T21:47:24Z

Fei: /* SET */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSSats#centroid.lse|centroid.lse]] for the working example.
SET(patchList[i], pos1, rMaxCCE, maxCCE1)
MaxCCE[currType] = MaxCCE[currType] + maxCCE1

pos1 = nextPos
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#consumeCA.lse|consumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

User talk:Fei

2006-11-15T21:45:55Z

Fei: /* Nov. 15 2006-a note to myself */

===Nov. 15 2006-a note to myself===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***OUTPUT RECORD
***RESIZE
***OVER REGION VECTOR
**centroid.lse
***OVER INDEX SEQUENCE
***NEXT
***DISTANCE
***SET
**IdentifyPatches.lse
***IF
***ELSE

*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

Language Reference 1

2006-11-15T21:44:52Z

Fei: /* DISTANCE */

==+==
DESCRIPTION:
The addition operator, "+"

USAGE:
x=Expr+Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the expression is the sum of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions) ]]

Example 1:
x=1+2
(the result for x will be 3)

SAMPLE MODELS:
<links to sample models where this function is used>

==-==
DESCRIPTION:
The subtraction operator

USAGE:
x=Expr-Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression minus the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=15-2
(the result for x will be 13)

SAMPLE MODELS:
<links to sample models where this function is used>

==*==
DESCRIPTION:
The multiplication operator

USAGE:
x=Expr*Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value is the product of two expressions

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=5*4
(the result for x will be 20)

SAMPLE MODELS:
<links to sample models where this function is used>

==/==
DESCRIPTION:
The division operator

USAGE:
x=Expr/Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression divided by value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=60/6
(the result for x will be 10)

SAMPLE MODELS:
<links to sample models where this function is used>

==^==
DESCRIPTION:
The power operator

USAGE:
x=Expr^Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
The first expression to the power of the value of the second expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=7^3
(the result for x will be 343)

SAMPLE MODELS:
<links to sample models where this function is used>

==%==
DESCRIPTION:
The percentage operator

USAGE:
x=Expr % Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value of the first expression modulo the value of the second expression(assumes that the values of the expression are integers

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=19 % 12
(the result for x will be 7)

Example 2:
x=10 % 20
(the result for x will be 10)

Example 3:
x=10 % 10
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

======
DESCRIPTION:
The EQ operator or the alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment). This is a Boolean function operator.

USAGE:
x=(Expr)==(Expr)=(Expr)EQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the == or the EQ sign must equal to the value on the right of the == or the EQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)==(9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)==(4*4) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*0)==(-1) //(FALSE)
(the result for x will be 0)

Example 4:
x=(|-9|)EQ(9) //(TRUE)
(the result for x will be 1)

Example 5:
x=(2*6)EQ(4*4) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!===
DESCRIPTION:
The not equal operator or the alternate form of NOT EQUAL comparison. This is a Boolean function operator.

USAGE:
x=(Expr)!=(Expr)=(Expr)NEQ(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the != or NEQ sign does not equal to the value on the right of the != or NEQ sign.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(|-9|)!=(-9) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8)!=(4*3) //(TRUE)
(the result for x will be 1)

Example 3:
x=(2*8)!=(2*8) //(FALSE)
(the result for x will be 0)

Example 4:
x=(1+7)NEQ(8) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<(Expr)=(Expr)LESS THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the < or the LESS THAN is less than the value on the right of the < or LESS THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(17)<(21) //(TRUE)
(the result for x will be 1)
Example 2:
x=(-17)LESS THAN(-17) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==<===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is less than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)<=(Expr)=(Expr)LESS OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the <= or LESS OR EQUAL sign is less or equal to the value on the right of the <= or LESS OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=17<=21 //(TRUE)
(the result for x will be 1)

Example 2:
x=(-17)LESS OR EQUAL(|-17|) //(TRUE)
(the result for x will be 1)

Example 3:
x=-17<=-18 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>(Expr)=(Expr)GREATER THAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the > or GREATER THAN sign is greater than the value on the right of the > or GREATER THAN sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions ]]

Example 1:
x=5>2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER THAN(5) //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==>===
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if the value of the first expression is greater than or equal to the value of the second expression; otherwise FALSE(0).

USAGE:
x=(Expr)>=(Expr)=(Expr)GREATER OR EQUAL(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Value on the left of the >= or GREATER OR EQUAL sign is greater or equal to the value on the right of the >= or GREATER OR EQUAL sign

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=5>=2 //(TRUE)
(the result for x will be 1)

Example 2:
x=(5)GREATER OR EQUAL(5) //(TRUE)
(the result for x will be 1)

Example 3:
x=5>=6 //(FALSE)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==!==
DESCRIPTION:
A Boolean function operator that negates the expression Boolean value.

USAGE:
x=!Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Negates the expression Boolean value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
y = TRUE x=IF !y THEN 3 ELSE 4
(the result for x will be 4)

SAMPLE MODELS:
<links to sample models where this function is used>

==ABS(Expr)==
DESCRIPTION:
The absolute value operator

USAGE:
x=ABS(Expr)=|Expr|=ABSOLUTE(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Absolute value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ABS(-12)
(the result for x will be 12)

Example 2:
x=|-12|
(the result for x will be 12)

Example 3:
x=ABSOLUTE(-12)
(the result for x will be 12)

SAMPLE MODELS:
<links to sample models where this function is used>

==AND==
DESCRIPTION:
A boolean operator that returns TRUE if two expressions are both TRUE, and FALSE otherwise.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:
The AND operation is equivalent to the multiplication operator. For example: if A is TRUE, which can also be represented by 1 and B is FALSE, which can be represented by 0, then A AND B means that A is multiplied by B, ie: 1*0, which gives FALSE (0).

SEE ALSO:
[[Model Builder's Guide Chapter 9#Boolean Functions]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCCOS==
DESCRIPTION:
The arccos function operator

USAGE:
x=ARCCOS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCCOS(0.5)
(the result for x will be 59.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCSIN==
DESCRIPTION:
The arcsin function operator

USAGE:
x=ARCSIN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse sine of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCSIN(1)
(the result for x will be 89.9999999999998)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr)==
DESCRIPTION:
The arctan function operator

USAGE:
x=ARCTAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(1)
(the result for x will be 44.9999999999999)

SAMPLE MODELS:
<links to sample models where this function is used>

==ARCTAN(Expr,Expr)==
DESCRIPTION:
The arcsin quadrant function operator

USAGE:
x=ARCTAN(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse tan where first expression is x offset and second is y offset. Provideing two expressions gives more infomation about the quadrant

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=ARCTAN(5,9)
(the result for x will be 60.9453959009227)

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE OR==
(Expr, Expr) Bitwise OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE AND==
(Expr, Expr) Bitwise AND of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE XOR==
(Expr, Expr) Bitwise exclusive-OR of two values[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==BITWISE NOT==
Expr Bitwise NOT of a value[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CEILING(Expr)==
DESCRIPTION:
The ceiling operator

USAGE:
x=CEILING(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Smallest integer larger than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=CEILING(0.01)
(the result for x will be 1)

SAMPLE MODELS:
<links to sample models where this function is used>

==CLAMP==
(Expr, MinExpr, MaxExpr)

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFY==
(X) if the value of the variable X is equal to one of
CLASS Number: Expr the classes listed, then return the result of the.
: associated expression. Otherwise return 0.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Markov chains#MarkovChain.lse|MarkovChain.lse]] for the working example.
CellState = CLASSIFY(currState)
0: 0
1: CLASSIFIED_DIST
1:1 - pChange
2:pChange
ENDFN
2: CLASSIFIED_DIST
2:1 - pChange
3:pChange
ENDFN
3: CLASSIFIED_DIST
3:1 - pChange
4:pChange
ENDFN
4: CLASSIFIED_DIST
0: pChange
4:1 - pChange
ENDFN
ENDFN
ENDTR

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

:***
(X) return the result of the kth expression in the list,
Expr where k = X – minimum value of the variables
: (this may be non-0 only for layers)
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) return the kth number in the list, where
k = X – minimum value of the variable (this
may be non-0 only for layers)[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***

(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs. Rarely
used.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file. Rarely used.

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.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CLASSIFIED_DIST==
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.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
( Number+) in this form, the classes are assumed to start at zero. Only constant probabilities can be given.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
in this form, the classes are assumed to start at Expr zero :
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
[M]
In this form, the classes in a one-dimensional
array M, and so start at zero.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==CONTAINS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==CONTAINS LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==COS==
DESCRIPTION:
The cos function operator

USAGE:
x=COS(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Inverse cos of the value of the expression

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

Example 1:
x=COS(0.5)
(the result for x will be 0.99996192306417)

SAMPLE MODELS:
<links to sample models where this function is used>

==CRITICAL SECTION==
(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
synchronizing access to shared variables
(i.e. shared with another application).[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DEBUG==
Update the simulation probe, if it is loaded and
The event is selected. Used to debug/verify
event behaviour.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr known location indices. If there is a decision expression, then only those cells for which this
expression returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location indices stored in one-dimensional X.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr location index. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DECISION==
Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:
Defines a region centred on the current cell. If there is a decision expression, then only those cells for which this expression returns TRUE will be included.

USAGE:
x= Expr AND Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
TRUE (1) if all sub-expressions evaluate to TRUE and FALSE (0) otherwise

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Expressions:]]

Example 1:
x=(3>6) AND (14>9)
(the result for x will be FALSE(0))

Example 2:
x=(6>3) AND (14>9)
(the result for x will be TRUE(1))

Example 3:
x=10 AND (9<14)
(the result for x will be 10)

Example 4:
x=10 AND -5
(the result for x will be -50)

SAMPLE MODELS:
<links to sample models where this function is used>

==DIRECTION==
(Expr, Expr) angle in degrees between two location indices
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Display on the screen the labelled Label: Expr values computed with the expressions listed.
…. If no label is given, the expression must
ENDFN be a variable, and this is used for the label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
DESCRIPTION:
The clamp operator

DESCRIPTION:
The clamp operator

USAGE:
x=(Expr, MinExpr, MaxExpr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Clamp the value X of the expression to the range [Min, Max]: if X<Min then return Min; if X<Max return Max. Otherwise return X.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISPLAY==
Same as above, but only display if the DECISION Expr decision expression evaluates to TRUE
Label: Expr The keyword DECISION can be replaced by
…. a “?”
ENDFN
[[Model Builder's Guide Chapter 9#Output Expressions]]
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
…. Expression must be a variable and this is
ENDFN used as label.
[[Model Builder's Guide Chapter 9#Output Expressions]]
OUTPUT RECORD(OutputVar) Same as above, but only output if the DECISION Expr decision expression evaluates to TRUE
Label: Expr
….
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==DISTANCE==
(Expr, Expr) distance between two location indices (normally
obtained using the Location variable). Thus,
DISTANCE(loc1, loc2) is
sqrt(sqr(loc1.x – loc2.x) + sqr(loc1.y – loc2.y))
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example
d = DISTANCE(centroid1, centroid2)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ELSE==
DESCRIPTION:
A control expression that evaluates to TRUE and the set of sub-expressions after the ELSE otherwise.

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression evaluates to TRUE and the set of sub-expressions after the ELSE otherwise. Note that "ELSE IF expr" forms can be strung together.

SEE ALSO:
[[Model Builder's Guide Chapter 9#Control Expressions]]

Example 1:
//Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working examples.
// For the core areas ...
ELSE
coreId = coreId + (CoreAreaId EQ 0)
NumCA[PatchLayer] = NumCA[PatchLayer] + (CoreAreaId EQ 0)
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==EQUAL==
TRUE(1) if the sub-expressions all evaluate to
the same value and FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==EXP(Expr)==
DESCRIPTION:
(Expr) base of the natural logarithm (e) to the power of
the expression

USAGE:
x=EXP(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Base of the natural logarithm (e) to the power of the expression

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=EXP(3)
(the result for x will be 20.08553692)

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

==FIND==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIND NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIND NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FIRST==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==FIRST LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==FLOOR(Expr)==
DESCRIPTION:
The flooring operator

USAGE:
x=FLOOR(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Largest integer smaller than the expression value

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=FLOOR(0.99)
(the result for x will be 0)

SAMPLE MODELS:
<links to sample models where this function is used>

==GEOMETRIC MEAN==
geometric mean of the sub-expressions (nth
root of the product for n expressions)

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER OR EQUAL==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >=, and
FALSE (0) otherwise
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==GREATER THAN==
TRUE (1) if the sub-expression evaluations are
all ordered according to the relation >, and
FALSE (0) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

The '''logarithm''' is the [[mathematics|mathematical]] operation that is the [[inverse function|inverse]] of [[exponentiation]] (raising a constant, the ''base'', to a power). The logarithm of a number ''x'' in base ''b'' is the number ''n'' such that ''x'' = ''b''''n''. It is usually written as
: <math> \log_b(x) = n . \,\! </math>

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

Language Reference 2

2006-11-15T21:41:27Z

Fei: /* NEXT */

==IF Expr==

DESCRIPTION:
Procedural IF statement to process the first set
of sub-expressions denoted by “…”if the

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1://Note this example is out of context. //See [[LSStats#identifyPatches.lse|identifyPatches.lse]] for the working example.
IF (PatchId EQ 0) // not visited...
pId = pId + 1
NumPatches[PatchLayer] = NumPatches[PatchLayer] + 1
ENDFN

Example 2://Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]] for the working example.
IF pos
MaxPS[i] = patchVar[rArea]
MinPS[i] = patchVar[rArea]
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==IF Expr THEN Expr ELSE==
Expr if value of the IF expression is TRUE (>= 1), then return the value of the THEN expression,
otherwise return value of the ELSE expression

(Expr ? Expr : Expr) Same as above, but this form can be used as an
embedded sub-expression
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example.
distInc = IF SpreadType EQ 0 THEN 1 ELSE MAX(0,d - SOURCE d)

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==INSERT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Set Functions]]

==INSERT HEAD==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INSERT TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#List Functions]]

==INTERPOLATE==
(X)
return an interpolated value where the value of
CLASS Number: Number variable X is placed between two classes or at
: either end of the table.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file.
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==IS EMPTY==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==IS EMPTY LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==LINKED==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG(Expr)==

DESCRIPTION:
The logarithm operator

USAGE:
x=LOG(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
<math>\alpha\,</math>
:<math>3^4 = 3 \times 3 \times 3 \times 3 = 81 . \,\!</math>

Natural logarithm of the value of the expression. This is a mathematical operation that is the inverse of exponentiation(raising a constant, the base, to a power)
Ex:
:<math> \log_3(81)=4,\,\! </math>
:<math> \4^3=81\,\! </math>

In this program, it is assumed that the base is 10,
ie:
:<math> \log(10)=log_10(10)\,\! </math>

Note that the natural Logarithm is the inverse of the natural exponential function,
ie:
(x), which is the same as In(x) for all positive x and
:<math> \In(e^x)=x \,\! </math>
for all real x. The only difference between Log and natural Log is their bases that Log uses 10 and natural Log uses e. For convenience,
:<math> \log_e(x) \,\! </math>
is usually written in a different notation: In(x).
SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=LOG(0.773)
=-0.111820506

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL CDF==
(Expr, Expr, Expr) log normal cumulative density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL PDF==
(Expr, Expr, Expr) log normal probability density function, where
the first expression specifies the value, the
second is the mean and the third is the standard
deviation
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==LOG NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal log normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

==LOOKUP==
(X): ( Number+) same as above, except the classes are
implicitly 0, …. k-1
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the values in the
CLASS Number: Expr table are obtained by evaluating expressions
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X) same as above, except the classes are
Expr implicitly 0, …, k-1
:
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]
ENDFN
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename uses the table in the named file, which is
assumed to consist of class:value pairs
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(X): Filename Key uses the table in the named file, which is
assumed to consist of class:value pairs. The key
is used to specify a sub-table in a multi-table
file
[[Model Builder's Guide Chapter 9#Classified and Discrete Functions]]

Expr EQ Expr TRUE if the values of the two expressions are
equal; otherwise FALSE [[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr == Expr alternate form of EQ comparison (Note: two equal signs distinguish this from an assignment)[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr NEQ Expr TRUE if the values are not equal; otherwise
FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr != Expr alternate form of NOT EQUAL comparison[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr < Expr TRUE if the value of the first expression is less
than the value of the second expression;
otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr <= Expr TRUE if the value of the first expression is less
than or equal to the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr > Expr TRUE if the value of the first expression is
greater than the value of the second
expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]
Expr >= Expr TRUE if the value of the first expression is
greater than or equal to the value of the
second expression; otherwise FALSE[[Model Builder's Guide Chapter 9#Boolean Functions]]

!Expr Negates the expression Boolean value[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr AND Expr TRUE if values of both expressions are
TRUE and FALSE otherwise[[Model Builder's Guide Chapter 9#Boolean Functions]]

Expr OR Expr TRUE if value of at least one expression is
TRUE and FALSE otherwise

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX==
maximum of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MAX POSITION==
DESCRIPTION:
A Bit-Vector function that returns the maximun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MAX POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MAX POSITION(12)

SAMPLE MODELS:
<links to sample models where this function is used>

==MEAN==
average of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==MIN==
minimum of the sub-expressions

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context.//See [[Spreading2#Spreading.lse|Spreading.lse]] for the working example
TimeSinceFire = MIN(TimeSinceFire+1, MaxTSF)
Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Composite Functions]]

==MIN POSITION==
DESCRIPTION:
A Bit-Vector function that returns the minimun 0-based bit position that is set to one in the expression value(interpreted as a bit-vector),or-1 if no bits are set

USAGE:
MIN POSITION(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
?????

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
MIN POSITION(12)

<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NEGEXP==
(Expr) draw a value from a negative exponential distribution, where the expression specifies the
mean
POISSION(Expr) draw a value from a Poisson distribution

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Probability Distributions]]

==NEXT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#centroid.lse|centroid.lse]] for the working example.
nextPos = NEXT(patchList[i], pos1)

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==NEXT LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==NORMAL==
DESCRIPTION:
draw a value from a normal distribution

USAGE:
x=NORMAL(Expr1,Expr2)

REQUIRED ARGUMENTS:
Expr1 is the mean, and Expr2 is the variance.

VALUE:
A single value sampled from a normal distribution.

NOTES:
<define gaussian distribution, web refs?, etc>

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

EXAMPLES: <add carriage return here>
Example 1:
x = NORMAL(10,5)
<figure out an end example indicator. For example, ***>

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL CDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL PDF==
(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
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NORMAL TEMPORAL PDF==
(Expr, Expr, Expr) temporal normal probability density function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==NOT EQUAL==
FALSE (0) if the sub-expressions all evaluate to
the same value and TRUE (1) otherwise

[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

User talk:Fei

2006-11-15T21:35:28Z

Fei: /* Nov. 15 2006-a note to myself */

===Nov. 15 2006-a note to myself===

*'''Convex Hull'''
**ConvexHull.lse
***OVER REGION WHOLE MAP
***OVER REGION VECTOR

*'''Distance Surface'''
**Distance.lse
***REGION CENTRED

*'''Filter Small'''
**FilterSmall.lse
***REGION CENTRED

*'''LSStats'''
**Stats.lse
***OVER REGION WHOLE MAP
***OVER INDEX SEQUENCE
***OUTPUT RECORD--too long though
***WHILE
**nn.lse
***OUTPUT RECORD
***RESIZE
***OVER REGION VECTOR
**centroid.lse
***OVER INDEX SEQUENCE
**IdentifyPatches.lse
***IF
***ELSE

*'''Producer Consumer'''
**'''The process model'''
***Consumer.lse
****NOTHING
***Producer.lse
****REGION CENTRED
***update.lse
****NOTHING
**'''The CA model'''
***consumeCA.lse
****UNIFORM

*'''Random Walker'''
**RandomWalker.lse
***N

*'''Game of Life'''
**GameOfLife.lse
***OVER REGION CENTRED

*'''Markov chains'''
**MarkovChain.lse
***OVER REGION CENTRED
***CLASSIFY

*'''Spreading2'''
**spreading.lse
***IF Expr THEN Expr ELSE
***MIN--too commonly explained(but since we don't have any example for MIN, I added it from spreading.lse)

*'''Spreading1'''
**Spreading.lse
***REGION LOCATION
***REGION CENTRED

== plus sign problems==
Hi Fei, Here's some info.
[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions_(technical_restrictions)#Plus]

I used a work-around which is not elegant, substituting "plus sign" for "+" in the code and title...
I'll look into this further,
[[User:Charles | Charles]]

== language reference first page ==

Thursday afternoon...
Hi Fei,
I tried skyping at 430-530. No worries. I have changed your [[Language Reference]] front page, adding a 5 column alphabetical list. These point to 3 pages; [[Language Reference 1]], [[Language Reference 2]], [[Language Reference 3]]. What do you think?

Your original page is now stored at [[Language Reference Original]].

==OLDER==

I think we'll have to re-think about the [[Language Reference]] list... I'm getting the folowing errors:
"WARNING: This page is 39 kilobytes long; some browsers may have problems editing pages approaching or longer than 32kb. Please consider breaking the page into smaller sections."

Hi Fei. I got the note this time, thanks. I was intending that we break the language reference into separate pages for each letter -- I guess we should do that tuesday.
Have a good weekend. [[User:JSH | Josie]]

05.10.2005 Take a look at [[Language Reference2]] or [[Language Reference3]] as an example of a list that links to 3 more pages... I used Excel to make this file, you can find the file here: [[Image:Lang_ref2.zip]].

Unzip this file: it should end up with the name "Lang_ref2.csv". Open it in Excel or OpenOffice Calc to change the columns. Or, open it in Notepad and replace all commas with nothing. I.e. search for "," and replace with "". This will create a nice set of wiki text which you can cut and paste into your Language Reference page. Charles

== foreign ip's ==

04.10.2006 Hi Fei, (I am 'watching' [[User_talk:Charles]], so I get an email from the system when people edit it - a good way to listen for comments by people) Thanks for that note about the foreign IP addresses. The language reference looks good.
Did you notice my changes to "News!!"? What's your next plan? I'm trying to make time to get my SELES 101 tutorials updated and uploaded... [[User:Charles | Charles]]

== first notes ==

hello, Josie, all the figures in the documentary have been uploaded, :)
cya tuesday

hi fei, nice work. did you use MWsnap? i made you a sysop. could you do me a favour and subscribe to the newsletter (under Support page) ciao, charles

28.09.2006 nice home page! lol
hi fei, i see you have copied and pasted text into your user page: fun!
you can post a picture by typing: <nowiki>[[Image:Jie04.jpg]] </nowiki> [[Image:Jie04.jpg]]

hi charles, thanks for the comment, lol, i've subscribed to the newsletter... have a nice weekend!
hi again, i'm getting a little addicted to updating my profile..lol, please let me know if it looks too inappropriate/unprofessional, i'll delete them. is there anything that i need to think/read/learn about seles over this weekend? thx, fei

29.09 hi fei, it's your page, and a community project so its nice to see some ''personal'' material: modelling can be dry at times. i deleted the subscribe to newsletter part at the top of your user page (if you want it back tell me). i won't usually monitor this page (user_talk:fei), so if you want to 'talk' to me, leave a message at [[User_talk:Charles]] or email me or skype 'mapswest'. have a great weekend and thx for doing all those graphics - it looks good! charles

[[User_talk:JSH]]

== checking messages ==

I found you by searching under user contributions. Do you get this message? (and lovely pictures you have)

I think the pages are case sensitive. Try User_talk:JSH.

== wow... ==

it looks good....

The CA model

2006-11-15T21:35:11Z

Fei: /* consumerCA.lse */

==Summary==

==Screenshot==

[[Image:Consumer.gif]]

==Download Model==

Download the .scn, .sel and .lse files by clicking on the following link: [[Image:ProducerConsumer.zip]]

==Model Code Exploration==

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.

===Consume.scn===
Seles Scenario
Model.sel
SimPriority Low Priority

===Model.sel===
Seles Model
Time Units: Step kiloStep 1000 1000
Landscape Events:
ConsumeCA.lse DEBUG
Spatial Variables:
LSState[3]
PrevLSState[3]
Legends:
LSStateTypes = {0:Uncolonised, 1:Producer, 2:Consumer}
Global Variables:
pInitialProducer = 0.01
pInitialConsumer = 0.01
pSpreadProducer = 0.1
pSpreadConsumer = 0.2
pDeathProducer = 0.01
pDeathConsumer = 0.05
Output Frequency: 1

===consumeCA.lse===
// Producer/Consumer conceptual model implemented as a cellular automata
// updating everything in a single event
LSEVENT: ConsumeCA
DEFINITIONS
LAYER: LSState, PrevLSState
GLOBAL CONSTANT: Uncolonised, Producer, Consumer
GLOBAL VARIABLE: pInitialProducer, pInitialConsumer
GLOBAL VARIABLE: pSpreadProducer, pDeathProducer, pSpreadConsumer, pDeathConsumer
ENDDEF
INITIALSTATE
LSState = IF (UNIFORM(0,1) < pInitialConsumer) THEN Consumer
ELSE IF (UNIFORM(0,1) < pInitialProducer) THEN Producer
ELSE Uncolonised
INITIALSTATE = 1
ENDIS
RETURNTIME
RETURNTIME = 1
PrevLSState = LSState
ENDRT
// Cellular automata: visit every cell and change state based on current state
// and neighbourhood
TRANSITIONS
// An empty cell can possibly be colonised by a producer
// if it is next to at least one producer
IF PrevLSState EQ Uncolonised
OVER REGION CENTRED(1,1, WRAPPED)
DECISION (PrevLSState EQ Producer) AND (UNIFORM(0,1) < pSpreadProducer)
SOURCE LSState = Producer
ENDFN
// A producer can possibly die, or be eaten by a consumer
ELSE IF PrevLSState EQ Producer
IF (UNIFORM(0,1) < pDeathProducer) // mortality
LSState = Uncolonised
ELSE
OVER REGION CENTRED(1,1, WRAPPED)
DECISION (PrevLSState EQ Consumer) AND (UNIFORM(0,1) < pSpreadConsumer)
SOURCE LSState = Consumer
ENDFN
ENDFN
// A consumer may die
ELSE // PrevLSState EQ Consumer
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN
ENDFN
TRANSITIONS = FALSE
ENDTR

==Suggested Experiments==

To explore this cellular automata model further, try the following:

Language Reference 3

2006-11-15T21:34:07Z

Fei: /* UNIFORM */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#consumeCA.lse|consumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

Language Reference 3

2006-11-15T21:33:40Z

Fei: /* UNIFORM */

==ONE==
return 1.0
#Number return value of the number specified
<Constant> return value of a named constant
<Constant>[Expr] return value of a named vector constant
<Constant>[Expr, Expr] return value of a named array constant
<Macro>[Expr] return value of expression at specified index
in macro

(Expr, Expr) draw a value from a normal distribution, where
the first expression specifies the mean and
the second specifies the standard deviation

(Expr, Expr, Expr) draw a value from a skewed normal distribution, where the first expression specifies the mode
and the second and third specify the standard
deviations to the left and right of the mode
(Expr, Expr) draw a value from a log normal distribution,
where the first expression specifies the mean
and the second specifies the standard deviation
of the underlying normal distribution

(Expr, Expr) draw a value from a Weibull distribution, where
the first expression specifies the beta and the
second specifies alpha (Note:terminology varies
between sources. The version here is equivalent
to that in Excel, with reversal of parameters).
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]

==OR==
DESCRIPTION:
A Boolean function operator that returns TRUE(1) if value of at least one expression is TRUE(1) and FALSE(0) otherwise.

USAGE:
x=Expr OR Expr

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Either TRUE(1) or FALSE(0)

NOTES:
The OR operator is equivalent to the addition operator. For example: if A is TRUE(1) and B FALSE(0), then A OR B means that A+B, which is 1+0 and is equal to 1(TRUE). If both A and B are TRUE(1), then A OR B becomes 1+1, the result will be greater than 0 and 1. In this case, the result for x will still be evaluated to 1(TRUE)

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
x=(2*8==16) OR (2>5) //(TRUE)
(the result for x will be 1)

Example 2:
x=(2*8!=4*4) OR (2>5) //(FALSE)
(the result for x will be 0)
SAMPLE MODELS:
<links to sample models where this function is used>

==OUTPUT RECORD==
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:

NOTES:

SEE ALSO:
[[Model Builder's Guide Chapter 9#Composite Functions]]

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
OUTPUT RECORD(ClassStatsFile)
DECISION Area[pType] > 0
LandscapeId: LandscapeId
Replicate: Replicate
pType: pType
MNN: CellWidth * MeanNN[pType]
MNN2: CellWidth * MeanNN2[pType]
MinNN: CellWidth * MinNN[pType]
MaxNN: CellWidth * MaxNN[pType]
NNSD: CellWidth * NNSD[pType]
NNCV: 100 * NNSD[pType] / MeanNN[pType]
Dispersion: 2 * (NumPatches[pType] / Area[pType])^(1/2) * MeanNN[pType]
meanMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * meanMST[pType]
tMST: IF (NNType EQ rNN) THEN 0 ELSE CellWidth * MST[pType]
meanMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanMPG[pType]
tMPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * MPG[pType]
nMPG: nMPG[pType]
meanAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * meanAW_MPG[pType]
tAW_MPG: IF (NNType EQ rNN) OR (NNType EQ rMST) THEN 0 ELSE CellWidth * AW_MPG[pType]
nAW_MPG: nMPG[pType]
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==OVER INDEX SEQUENCE==
(Expr, Expr) defines linear sequence of location indices.
DECISION Expr
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included. The system variable
Index holds the value of the index at each value
in the sequence

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).
[[Model Builder's Guide Chapter 9#Region Functions]]
OVER RegionFunction Apply a set of sub-expressions at all spatial
Expression locations specified by a region function
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]
AT LOCATION #Expr Apply a set of state-changes at a specified
Expression location
:
ENDFN
[[Model Builder's Guide Chapter 9#Region Functions]]

Matrix assignment is indicated using “[=]” instead of “=”. The proper dimensions of the component arrays must be met.

Variable [=] Variable assign variable of same dimension, or a
single value to all entries
Variable [=] Variable + Variable sum variables of same dimension (or with a
constant)
Variable [=] Variable - Variable subtract variables of same dimension (or
with a constant)
Variable [=] Variable * Variable matrix or scalar multiplication.

Variable [=] TRANSPOSE(Variable) matrix transposition
Variable [=] Variable^-1 invert a matrix
Variable = SUM(Variable) sum all entries in a matrix
Variable [=] SUM ROWS (Variable) sum all rows of a matrix (result has one
value per column)
Variable [=] SUM COLS(Variable) sum all columns of a matrix

Variables [=] SORT(Variable, Expr) sort rows of an input matrix where rank is
given by Expr. The system variable “Index”
can appear in the expression and will take on
the range of indices in the input array. The
resulting sorted matrix will be assigned.

Variable [=] MPM_MULT(Variable, Variable) Performs a “matrix population model”
(MPM) integer-based multiplication.
Assumes that first matrix is two-dimensional
and that second is a vector. The result is
two-dimensional, where entries above
diagonal represent "offspring", entries on the
diagonal represent "survivors" and entries
below the diagonal represent "succeeders"

Variable [=] CONTAG(Variable, Variable) Creates a “temporal contagion” matrix.
Given probabilities (first parameter) for a set
of states and a two-dimensional contagion
array (values –1 to 1 indicating affinity),
generates a matrix where each row is a prob.
dist. For transitions given the row value, and
the overall target dist. will be met.
[[Model Builder's Guide Chapter 9#Matrix Functions]]
DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(pType + 1, NumPTypes - 1)
pType2 = Index
x = IF (tTE > 0) THEN Eik[pType, pType2] / tTE ELSE 0
tIJI = tIJI + x * LOG(x)
ENDFN

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[LSStats#stats.lse|stats.lse]] for the working example.
OVER INDEX SEQUENCE(0, NumPTypes-1)
pType2 = Index + MinPType
AMik = IF (TotalEdge[pType] > 0) THEN Eik[pType, pType2] / TotalEdge[pType] ELSE 0
IJI[pType] = IJI[pType] + AMik * LOG(AMik)
x = IF ((TotalEdge[pType] > 0) AND (Pi > 0)) THEN Pi * Eik[pType, pType2] / TotalEdge[pType] ELSE 0
tContag = tContag + x * LOG(x)
measuredDiversity = measuredDiversity - AMik * LOG(AMik)
measuredDiversity2 = IF(pType NEQ pType2) THEN measuredDiversity2 - AMik * LOG(AMik) ELSE measuredDiversity2
asm = asm + AMik^2
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE==
Halts the simulation and displays a dialog
box to which the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(#Value) Pauses the simulation for the specified number
of milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE IF==
Expr If the expression evaluates to TRUE, halts the
simulation and displays a dialog box to which
the user must respond to continue[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PAUSE (#Value)IF==
Expr If the expression evaluates to TRUE, Pauses the
simulation for the specified number of
milliseconds and then continues[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==PREV==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==PREV LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RECOMPUTE==
Only valid in consequent expressions of
ProbInit and also when ProbInit recompute flag
has been set. Causes prob. surface to be
recomputed before next selection
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION CENTRED==
(Expr, Expr [,DistanceType][,WRAPPED])
DECISION Expr defines a region centred on the current cell.
If there is a decision expression, then only
those cells for which this expression returns
TRUE will be included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note This exacmple is out of context. It will not run in the value model
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example
REGION CENTRED(1, 1)
DECISION (StudyArea > 0) AND (SrcLayer <= 0) AND (DistanceFromSrc > (CellWidth * DISTANCE(StartLocation, Location)))
ENDSL

Example 2:
//Note This exacmple is out of context. It will not run in the value model
//See [[Filter Small#FilterSmall.lse|FilterSmall.lse]] for the working example
REGION CENTRED(1, 1.5)
DECISION (Visited EQ 0) AND (FilteredPatchLayer EQ 1)
ENDSL

Example 3:
//Note This exacmple is out of context. It will not run in the value model
//See [[The process model#producer.lse|producer.lse]] for the working example
REGION CENTRED(0, 1, WRAPPED)
DECISION notEaten // don't spread if eaten (i.e. stop process)
ENDSL

Example 4:
//Note This exacmple is out of context. It will not run in the value model
//See [[Game of Life#GameOfLife.lse|GameOfLife.lse]] for the working example
OVER REGION CENTRED(1,1.5)
DECISION PrevCellState EQ 1
numNeighbs = numNeighbs + 1
ENDFN

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION COST SURFACE==
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(EndLocation, MaxCost, CostSurface, LeastCostNeighbs, AnchorLoc)
DECISION Expr
COST Expr
Defines a region surrounding a cell with
cumulative costs less than MaxCost. Stops
growing when EndLocation is reached or all
costs are greater than MaxCost. Second form
also records gradient and anchor location
layers. The CostSurface layer records the
cumulative cost from the cost function
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation)
DECISION Expr
COST Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LEAST COST PATH==
(StartLocation, EndLocation, LeastCostNeighbs)
DECISION Expr[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(StartLocation, EndLocation, LeastCostNeighbs, AnchorLoc)
DECISION Expr
Defines a region with cells that approximate
the least-cost path between two cells. The
first generates the cost function internally.
The latter two use input information from a
pre-computed cost surface region. Providing
both the gradient and anchor location layers
provides the most accurate approximation.

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.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION==
(Expr)
DECISION Expr
defines the region consisting of a of a single
location index. If there is a decision
expression, then only those cells for which
this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[Spreading1#Spreading.lse|Spreading.lse]] for the working example.
REGION LOCATION(LOCATION(NUMROWS/2, NUMCOLS/2))
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION LOCATION LIST==
(Number+)
DECISION Expr
defines the region consisting of a set of a set
of known location indices. If there is a
decision expression, then only those cells for
which this expression returns TRUE will be
included.

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]
***
(X,n)
defines the region consisting of a set of n
location indices stored in one-dimensional X.

==REGION RECT==
(Expr, Expr, Expr, Expr) defines a rectangular region. If there is a
DECISION Expr decision expression defined, then only those
cells for which this expression returns
TRUE will be included
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REGION VECTOR==
(StartLocation, EndLocation) defines region consisting of cells along an

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION VECTOR(EdgeLocation, PivotLocation)
DECISION !hitPivot
IF (StudyArea > 0) // hit new vertex
hitPivot = TRUE
IF (EndingPivotLoc EQ -1) AND (Location NEQ PivotLocation)
EndingPivotLoc = PivotLocation
ENDFN
PivotLocation = Location
ELSE
ConvexHull = 0 // erase
ENDFN
ENDFN

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Region Functions]]

==REGION WHOLE MAP==
DECISION Expr
defines the region consisting of the entire
landscape. If there is a decision expression,
then only those cells for which this expression
returns TRUE will be included.
[[Model Builder's Guide Chapter 9#Region Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. It will not run in the value model.
//See [[Distance Surface#Distance.lse|Distance.lse]] for the working example.
REGION WHOLE MAP
DECISION (StudyArea > 0) AND (SrcLayer > 0)
ENDEL

Example 2:
//Note this example is out of context. It will not run in the value model.
//See [[Convex Hull#ConvexHull.lse|ConvexHull.lse]] for the working example.
OVER REGION WHOLE MAP
DECISION StudyArea > 0
TRLoc = MAX(TRLoc, Location)
ENDFN
Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==REMOVE==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==REMOVE ALL LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==REMOVE LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==RESIZE==
(Variable, Expr) Changes size (number of entries) in a global
variable. Values are not maintained. Useful for
when size is not known prior to simulation.
[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(effectivePatchId, NP+1)

Example 2:
//Note this example is out of context. //See [[LSStats#nn.lse|nn.lse]] for the working example.
RESIZE(PosList, NP+1)

SAMPLE MODELS:
<links to sample models where this function is used>

==RESPONSE==
(Expr, #A, #B, #C) two-sided version of a standard response
function for the value X of the first expression:
if (X < A) return e^(-(X-A)^2/(2*(C^2))
else if (X > B) return e^(-(X-B)^2/(2*(C^2))
else return 1
[[Model Builder's Guide Chapter 9#Continuous Functions (Miscellaneous)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==ROUND(Expr)==
DESCRIPTION:
The rounding operator

USAGE:
x=ROUND(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Expression value rounded to the nearest integer

SEE ALSO:
[[Model Builder's Guide Chapter 9#Continuous Functions (Arithmetic Functions)]]

Example 1:
x=ROUND(0.773)
=1

SAMPLE MODELS:
<links to sample models where this function is used>

==SEED==
(Expr) Sets the random number seed. Value returned is
next seed.[[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SELECTAT==

DESCRIPTION:
A Bit-Vector function that returns FALSE(0) if none of the bits in PositionList are set in the specified expression value and
TRUE(1) otherwise

USAGE:
(Expr,PositionList)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Either FALSE(0) or TRUE(1)

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
yet to be determined

SAMPLE MODELS:
<links to sample models where this function is used>

==SET==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SET LINK==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SETAT==
***
(Expr,PositionList,#Type)
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1, and flip the bits if Type=2.

USAGE:
(Expr,PositionList,#Type)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27 indicates bits at positions 1,4,5,6 and 27.

SAMPLE MODELS:
<links to sample models where this function is used>
***
(Expr,PositionList,#Type,#Prob)
(Expr, PositionList,#Type,#Prob) Same as above, except each position is set
with probability #Prob
[[Model Builder's Guide Chapter 9#Bit-Vector Functions]]
DESCRIPTION:
A Bit-Vector function that sets the value specified by the expression, at the positions in PositionList to: FALSE(0) if Type is 0, TRUE(1) if Type is 1; flip the bits if Type=2; note that each position is set with probability #Prob.

USAGE:
(Expr,PositionList,#Type,#Prob)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value
PositionList is a semi-colon separated sequence of integer or ranges (lower-upper) indicating positions in the integer (0-31).

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
The PositionList 1;4-6;27;30 indicates bits at positions 1,4,5,6 and 27, each associated with probability 30%.

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT LEFT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the left by number of bits specified by second expression

USAGE:
SHIFT LEFT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT LEFT(7,5) means that position 7 will be shifted to position 2

SAMPLE MODELS:
<links to sample models where this function is used>

==SHIFT RIGHT==
DESCRIPTION:
A Bit-Vector function that shifts value of first expression to the right by number of bits specified by second expression

USAGE:
SHIFT RIGHT(Expr,Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value

VALUE:
Any integer value

SEE ALSO: [[Model Builder's Guide Chapter 9#Bit-Vector Functions]]

Example 1:
SHIFT RIGHT(7,5) means that position 7 will be shifted to position 12

SAMPLE MODELS:
<links to sample models where this function is used>

==SIN==
(Expr) interpret the value of the expression as an angle
theta in degrees, and return sin(theta) [[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SIZE LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Graph Functions]]

==SKEWED NORMAL==
***
(CDF)(Expr, Expr, Expr, Expr) skewed normal cumulative density function, where the first expression specifies the value,
the second is the mode, and the third and fourth are the left and right standard deviations
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>
***
(PDF)(Expr, Expr, Expr, Expr) skewed normal probability density function,
where the first expression specifies the value,
the second is the mode and the third and fourth are the standard deviations to the left and right
of the mode.
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SKEWED NORMAL TEMPORAL PDF==
(Expr, Expr, Expr, Expr)
temporal skewed normal probability density
function
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SORT==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#General Set, List and Graph Functions]]

==SORT LINKS==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==STRICT ORDERED==
same as LESS THAN
[[Model Builder's Guide Chapter 9#Composite Functions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==SUM==
DESCRIPTION:
Returns the number that is the sum of all the expressions.

USAGE:
x=SUM
Expr
...
ENDFN

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
the sum of all the arguments.

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

EXAMPLES: <add carriage return here>
Example 1:
y = 3
x = SUM
y
y+2
5
ENDFN

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Composite Functions]]

DIVIDE successive division of the sub-expressions

[[Model Builder's Guide Chapter 9#Composite Functions]]

==TAIL==

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==TAN==
DESCRIPTION:
The tan function operator

USAGE:
x=TAN(Expr)

REQUIRED ARGUMENTS:
Expr is any expression that evaluates to single numeric value.

VALUE:
Interpret the value of the expression as an angle theta in degrees, and return cos(theta)

SEE ALSO:
<a link to the composite functions section of seles modellers guide>

Example 1:
x=TAN(90)
=-286411217403671.25

SAMPLE MODELS:
<links to sample models where this function is used>
[[Model Builder's Guide Chapter 9#Continuous Functions (Trigonometric Functions)]]

==UNIFORM==
(Expr, Expr) draw a value from a uniform distribution, where the first expression determines the minimum value and the second determines the maximum

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:
//Note this example is out of context. //See [[The CA model#ConsumeCA.lse|ConsumeCA.lse]] for the working example.
IF UNIFORM(0,1) < pDeathConsumer
LSState = Uncolonised
ENDFN

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==UNIFORM TEMPORAL PDF==
(Expr, Expr, Expr) temporal uniform probability density expression
[[Model Builder's Guide Chapter 9#Probability Density and Cumulative Density Functions]]

<Variable> value of an independent variable <Variable>[Expr] value of a vector global variable
<Variable>[Expr, Expr] value of an array global variable

(Expr) value of the expression Expr + Expr sum of two expressions Expr - Expr value of the first expression minus the value
of the second expression Expr * Expr product of two expressions Expr / Expr value of the first expression divided by value
of the second expression Expr ^ Expr value of the first expression to the power of
the value of the second expression. An nth
root can be computed with1/n as the power.
| Expr | absolute value of the expression

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WAIT UNTIL==
Expr Suspend execution until the expression returns TRUE (1). This is intended for controlling
communication and synchronization with
an external application. [[Model Builder's Guide Chapter 9#Control Expressions]]

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
<links to sample models where this function is used>

==WHILE==
Expr
While loop: process sub-expressions denoted by “…” while the expression evaluates to TRUE
ENDFN

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1: //Note this example is out of context. //See [[LSStats#stats.lse|stats.lse]]
WHILE (pos)
patchVar [=] GET(coreAreaList[i], pos)
pos = NEXT(coreAreaList[i], pos)
// i = patchVar[rType]
patchSize = patchVar[rArea]
patchCoreSize = patchVar[rCoreArea]
patchPerim = patchVar[rPerim]
CASD2[i] = CASD2[i] + (patchCoreSize - MCA2[i])^2
tCASD2 = tCASD2 + (patchCoreSize - tMCA2)^2
ENDFN

Example 2:

SAMPLE MODELS: [[Model Builder's Guide Chapter 9#Control Expressions]]

==ZERO==
return 0.0

DESCRIPTION:

USAGE:

REQUIRED ARGUMENTS:

VALUE:

SEE ALSO:

Example 1:

Example 2:

SAMPLE MODELS:
[[Model Builder's Guide Chapter 9#Constants]]