Quick Programming References - Revision history

Rsalter: /* Introduction */

2022-06-07T15:11:59Z

Introduction

← Older revision		Revision as of 15:11, 7 June 2022
Line 78:		Line 78:
	''Designer'' provides a rich set of ''Primitive Operators'' or ''primops'' for computational purposes and to manipulate Component state. A complete list of primops appears [[Designer Primitive Operator Guide \| here]].		''Designer'' provides a rich set of ''Primitive Operators'' or ''primops'' for computational purposes and to manipulate Component state. A complete list of primops appears [[Designer Primitive Operator Guide \| here]].

	Java is statically typed language and so proper typing rules must be adhered to. ''Designer'' uses only familiar base types (integers, reals, strings) and their arrays, plus a few simple internally-defined types to specify coordinates. The types used in ''Designer'' are as follows<ref>Primitive versions of these (byte, short, int, long, float, double) can be used, however all primitive operators are typed using the equivalent Wrapper classes Byte, Short, Integer, etc.)</ref>:		Java is statically typed language and so proper typing rules must be adhered to. ''Designer'' uses only familiar base types (integers, reals, strings) and their arrays, plus a few simple internally-defined types to specify coordinates. The types used in ''Designer'' are as follows<ref>Primitive versions of these (byte, short, int, long, float, double) can be used, however all primitive operators are typed using the equivalent Wrapper classes Byte, Short, Integer, etc.</ref>:

	:;'''Byte''', '''Short''', '''Integer''', '''Long'''		:;'''Byte''', '''Short''', '''Integer''', '''Long'''

Rsalter: /* Function */

2022-06-07T15:11:14Z

Function

← Older revision		Revision as of 15:11, 7 June 2022
Line 114:		Line 114:
	::(''Type arg'', ... ''Type arg'') -> { ''Statement''; ''Statement''; ... '''return''' ''result''; ... }		::(''Type arg'', ... ''Type arg'') -> { ''Statement''; ''Statement''; ... '''return''' ''result''; ... }

	:Use the first of these if your result can be computed with a single expression. If a sequence of statements is required, it must be enclosed in brackets. A return statement must be the last statement executed by the sequence<ref>A return will always cause an immediate exit from the code</ref>. Returns can appear anywhere so long as the code segment, when executed, always terminates with a return (otherwise the compiler will reject the squib).		:Use the first of these if your result can be computed with a single expression. If a sequence of statements is required, it must be enclosed in brackets. A return statement must be the last statement executed by the sequence<ref>A return will always cause an immediate exit from the code.</ref>. Returns can appear anywhere so long as the code segment, when executed, always terminates with a return (otherwise the compiler will reject the squib).

	:The Function squib is notably used in the Function Component. A new Function Component will look as follows:		:The Function squib is notably used in the Function Component. A new Function Component will look as follows:

Rsalter: /* Hybrid */

2022-06-07T15:09:56Z

Hybrid

← Older revision		Revision as of 15:09, 7 June 2022
Line 175:		Line 175:
	:[[File: hsquib.png\|thumb\|300px\|center\|Fig 9. Agent Distribution Squib]]		:[[File: hsquib.png\|thumb\|300px\|center\|Fig 9. Agent Distribution Squib]]

	:''AgentLeft'' and ''AgentRight'' are the names of 2 Actors used in this model (see a description of the [[Movable Agent Component]]. This code will be executed for each Agent created at the start of the simulation, with the variable ''id'' bound each time to a different value. Depending on the odd or even parity of the ''id'', the Agent will use one or the other Actor.		:''AgentLeft'' and ''AgentRight'' are the names of 2 Actors used in this model (see a description of the [[Movable Agent Component]]). This code will be executed for each Agent created at the start of the simulation, with the variable ''id'' bound each time to a different value. Depending on the odd or even parity of the ''id'', the Agent will use one or the other Actor.

	==Referencing Components from Squibs==		==Referencing Components from Squibs==

Rsalter: /* Hybrid */

2022-06-07T15:09:33Z

Hybrid

← Older revision		Revision as of 15:09, 7 June 2022
Line 175:		Line 175:
	:[[File: hsquib.png\|thumb\|300px\|center\|Fig 9. Agent Distribution Squib]]		:[[File: hsquib.png\|thumb\|300px\|center\|Fig 9. Agent Distribution Squib]]

	:This code will be executed for each Agent created at the start of the simulation, with the variable ''id'' bound each time to a different value.		:''AgentLeft'' and ''AgentRight'' are the names of 2 Actors used in this model (see a description of the [[Movable Agent Component]]. This code will be executed for each Agent created at the start of the simulation, with the variable ''id'' bound each time to a different value. Depending on the odd or even parity of the ''id'', the Agent will use one or the other Actor.

	==Referencing Components from Squibs==		==Referencing Components from Squibs==

Rsalter: /* Hybrid */

2022-06-07T15:06:28Z

Hybrid

← Older revision		Revision as of 15:06, 7 June 2022
Line 163:		Line 163:

	====<span style="color:#E804E8">'''Hybrid'''</span>====		====<span style="color:#E804E8">'''Hybrid'''</span>====
	:A Hybrid squib is a cross between the Function and Supplier types, where specific input and output ~~types~~ are required. A Hybrid squib is ~~like~~ a Function ~~in that it accepts one or more~~ inputs~~; however the inputs are~~ supplied by the Component~~, and the~~ squib ~~need only return~~ a value of the expected output type using the format of a Supplier squib. In doing so it may refer to ~~the~~ input ~~values while computing its result~~.		:A Hybrid squib is a cross between the Function and Supplier types, where specific input values and type of output are required. A Hybrid squib is a Function with specific inputs supplied by the Component. The squib returns a value of the expected output type using the format of a Supplier squib. In doing so it may refer to its input arguments.

	:A hybrid squib can be found in the Cell (and Agent) ~~property pane~~, used to ~~define~~ the ~~Actors~~ used for ~~particular~~ row-column (or Agent ID) ~~values~~.		:A hybrid squib can be found in the Cell (and Agent) Property Pane, used to specify the Actor used for each row-column (or Agent ID) value.

	:[[File: hybridsquib.png\|thumb\|300px\|center\|Fig 8. Hybrid Squib]]		:[[File: hybridsquib.png\|thumb\|300px\|center\|Fig 8. Hybrid Squib]]

	:~~Note that like~~ the ~~Function squib,~~ input ~~values are specified, but~~ in the header of the squib. The return type, in this case ''String'', is shown on the right-hand-side of the header. The programmer need only write the body of the function in one of the formats of the Supplier squib, but may reference the variables ''row'' and ''col'' in the computation.		:Here the input signature is provided in the header of the squib. The return type, in this case ''String'', is shown on the right-hand-side of the header. The programmer need only write the body of the function in one of the formats of the Supplier squib, but may reference the variables ''row'' and ''col'' in the computation.

	:Here is an example where the squib is used to determine the Actor for each agent in a Movable Agent Component.		:Here is an example where the squib is used to determine the Actor for each agent in a Movable Agent Component.

Rsalter: /* Command */

2022-06-07T15:00:34Z

Command

← Older revision		Revision as of 15:00, 7 June 2022
Line 156:		Line 156:
	:Note that the squib can be empty since it is not required to do anything.		:Note that the squib can be empty since it is not required to do anything.

	:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to the ~~store~~ called ''liviness''. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.		:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to the Store called ''liviness''. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.
	<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">		<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">
	csquib1.png		csquib1.png

Rsalter: /* Command */

2022-06-07T15:00:12Z

Command

← Older revision		Revision as of 15:00, 7 June 2022
Line 156:		Line 156:
	:Note that the squib can be empty since it is not required to do anything.		:Note that the squib can be empty since it is not required to do anything.

	:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to the store called ''~~liveness~~''. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.		:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to the store called ''liviness''. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.
	<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">		<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">
	csquib1.png		csquib1.png

Rsalter: /* Command */

2022-06-07T14:59:59Z

Command

← Older revision		Revision as of 14:59, 7 June 2022
Line 156:		Line 156:
	:Note that the squib can be empty since it is not required to do anything.		:Note that the squib can be empty since it is not required to do anything.

	:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to a store. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.		:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to the store called ''liveness''. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.
	<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">		<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">
	csquib1.png		csquib1.png

Rsalter: /* Command */

2022-06-07T14:59:26Z

Command

← Older revision		Revision as of 14:59, 7 June 2022
Line 156:		Line 156:
	:Note that the squib can be empty since it is not required to do anything.		:Note that the squib can be empty since it is not required to do anything.

	Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to a store. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.		:Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to a store. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.
	<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">		<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">
	csquib1.png		csquib1.png
	csquib2.png		csquib2.png
	</gallery>		</gallery>

	====<span style="color:#E804E8">'''Hybrid'''</span>====		====<span style="color:#E804E8">'''Hybrid'''</span>====
	:A Hybrid squib is a cross between the Function and Supplier types, where specific input and output types are required. A Hybrid squib is like a Function in that it accepts one or more inputs; however the inputs are supplied by the Component, and the squib need only return a value of the expected output type using the format of a Supplier squib. In doing so it may refer to the input values while computing its result.		:A Hybrid squib is a cross between the Function and Supplier types, where specific input and output types are required. A Hybrid squib is like a Function in that it accepts one or more inputs; however the inputs are supplied by the Component, and the squib need only return a value of the expected output type using the format of a Supplier squib. In doing so it may refer to the input values while computing its result.

Rsalter: /* Squib Types */

2022-06-07T14:57:28Z

Squib Types

← Older revision		Revision as of 14:57, 7 June 2022
Line 104:		Line 104:
	Squib code resembles some or part of a method definition. Squibs are compiled to executable code during the build process. Any squib errors found during a build are displayed in the Build Reporter.<ref>A simple squib error may cascade a flood of error messages. If you get a build error, the first error message will generally show the actual error.</ref> You are advised to rebuild the simulation after completing each squib.		Squib code resembles some or part of a method definition. Squibs are compiled to executable code during the build process. Any squib errors found during a build are displayed in the Build Reporter.<ref>A simple squib error may cascade a flood of error messages. If you get a build error, the first error message will generally show the actual error.</ref> You are advised to rebuild the simulation after completing each squib.

	~~Components use~~ 4 different squib types, depending on what is required by the Component. Squib types are color coded as shown in the following descriptions. Squib labels will use these colors to indicate the type of squib required.		There are 4 different squib types, depending on what is required by the Component. Squib types are color coded as shown in the following descriptions. Squib labels in the Property Pane will use these colors to indicate the type of squib required.

	====<span style="color:#21a0ff"> '''Function'''</span>====		====<span style="color:#21a0ff">'''Function'''</span>====
	:Defines a function ~~transforming~~ input ~~values to~~ output ~~values~~. The function may ~~also use primops to~~ change ~~the Component's state~~. This squib has one of the following forms:		:Defines a function requiring input and producing output. The function may contain code that changes effects a state change.

			:This squib has one of the following forms:

	::(''Type arg'', ... ''Type arg'') -> ''result''		::(''Type arg'', ... ''Type arg'') -> ''result''
	::(''Type arg'', ... ''Type arg'') -> {''Statement''; ''Statement''; ... '''return''' ''result''}		::(''Type arg'', ... ''Type arg'') -> { ''Statement''; ''Statement''; ... '''return''' ''result''; ... }

	:Use the first of these if your result can be computed with a single ~~statement~~. If a sequence of statements is required, it must be enclosed in brackets ~~and include a ''~~return'' statement. ~~The return~~ can appear anywhere ~~and more than once~~ so long as the code segment always terminates with a return (otherwise the compiler will reject the squib).		:Use the first of these if your result can be computed with a single expression. If a sequence of statements is required, it must be enclosed in brackets. A return statement must be the last statement executed by the sequence<ref>A return will always cause an immediate exit from the code</ref>. Returns can appear anywhere so long as the code segment, when executed, always terminates with a return (otherwise the compiler will reject the squib).

	:The Function squib is notably used in the Function Component. A new Function Component will look as follows:		:The Function squib is notably used in the Function Component. A new Function Component will look as follows:
Line 118:		Line 120:
	:[[File: function.png\|thumb\|center\|300px\|Fig 3. Function Squib]]		:[[File: function.png\|thumb\|center\|300px\|Fig 3. Function Squib]]

	:Note that a return type must be specified (volatility will be explained ~~below~~). The <code>() -> null</code> is a reminder of the requirements of the squib. Here are 2 examples, corresponding respectively to the 2 formats shown above. Note that ~~the first~~ does not require a semicolon at the end of the line~~; and~~ the second ~~has 2~~ calls to return from different branches of the conditional.		:Note that a return type must be specified (volatility will be explained elsewhere). The <code>() -> null</code> is a reminder of the requirements of the squib. Here are 2 examples, corresponding, respectively, to the 2 formats shown above. Note that a 1-line squib does not require a semicolon at the end of the line, but a semicolon will not cause an error. In the second we show two calls to return from different branches of the conditional.

	<gallery caption="Fig 4. Two Function Squibs" widths="180px" mode="nolines" class="center">		<gallery caption="Fig 4. Two Function Squibs" widths="180px" mode="nolines" class="center">
Line 129:		Line 131:

	::''result''		::''result''
	::{''Statement''; ''Statement''; ... '''return''' ''result''}		::{ ''Statement''; ''Statement''; ... '''return''' ''result''; ... }

	:Supplier squibs are by far the most ~~common squibs~~ used ~~by the~~ ''Designer''. They compute values based on the current state of ~~other Components and return them for use by their Components~~. Supplier squibs may simply compute a value without affecting the system's state, or may use a primop to change state in the process of computing that value.		:Supplier squibs are by far the most commonly used in ''Designer''. They compute values based on the current state of the simulation. Supplier squibs may simply compute a value without affecting the system's state, or may use a primop to change state in the process of computing that value.

	:The Term Component is defined with a single Supplier squib. A new Term will look like this		:The Term Component is defined with a single Supplier squib. A new Term will look like this
Line 144:		Line 146:

	====<span style="color:#ff8c00">'''Command'''</span>====		====<span style="color:#ff8c00">'''Command'''</span>====
	:Command squibs are like functions of no arguments that do not return values. They take the form of the second version of Supplier squibs, but omitting the brackets.		:Command squibs are like functions of no arguments that do not return values. They take the form of the second version of Supplier squibs, but omitting the brackets and return.

	::''Statement''; ''Statement''; ... ''Statement'';		::''Statement''; ''Statement''; ... ''Statement'';
Line 152:		Line 154:
	:[[File: cmdsquib.png\|thumb\|300px\|center\|Fig 7. Command Squib]]		:[[File: cmdsquib.png\|thumb\|300px\|center\|Fig 7. Command Squib]]

	:Note that the squib can be empty since it is not required to do anything. In the ~~first~~ one, a state change occurs through the update call to a store. The ~~second also performs~~ Store updates and ~~is concerned with~~ the birth and ~~death~~ of agents. These topics are discussed elsewhere.		:Note that the squib can be empty since it is not required to do anything.

			Below are two examples of Commands. In the left-hand one, a state change occurs through the update call to a store. The right-hand one is more elaborate, performing Store updates and computing the birth and termination of agents. These topics are discussed elsewhere.
	<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">		<gallery caption="Fig 8. Two Command Squibs" widths="180px" mode="nolines" class="center">
	csquib1.png		csquib1.png