Designer Primitive Operator Guide - Revision history

Rsalter: /* Misc. Universal Primops */

2022-06-23T17:19:36Z

Misc. Universal Primops

← Older revision		Revision as of 17:19, 23 June 2022
Line 78:		Line 78:
	<p id="me">		<p id="me">
	;<kbd>me()</kbd>		;<kbd>me()</kbd>
	:Returns the component in which this squib is contained. Useful for accessing and applying methods from the component.		:Returns the component in which this squib is contained. Useful for accessing and applying methods from the component. Details are specific to the component.
	</p>		</p>
	<p id="time">		<p id="time">

Rsalter: /* Misc. Universal Primops */

2022-06-23T17:18:39Z

Misc. Universal Primops

← Older revision		Revision as of 17:18, 23 June 2022
Line 78:		Line 78:
	<p id="me">		<p id="me">
	;<kbd>me()</kbd>		;<kbd>me()</kbd>
	:Returns the component in which this squib is contained. Useful for accessing and applying methods.		:Returns the component in which this squib is contained. Useful for accessing and applying methods from the component.
	</p>		</p>
	<p id="time">		<p id="time">

Rsalter: /* Math Primops */

2022-06-23T17:18:07Z

Math Primops

← Older revision		Revision as of 17:18, 23 June 2022
Line 35:		Line 35:
	;<kbd>Double iTotal(Function<Integer, Integer) f, Collection<Integer> nums)</kbd>		;<kbd>Double iTotal(Function<Integer, Integer) f, Collection<Integer> nums)</kbd>
	;<kbd>Double iTotal(Function<Integer, Integer) f, Collection<Integer> nums, Integer base)</kbd>		;<kbd>Double iTotal(Function<Integer, Integer) f, Collection<Integer> nums, Integer base)</kbd>
			:Returns the sum of the values in ''nums'' transformed by ''f'' added to ''base'' (In the first version ''base'' is 0.)
			:Example:  <kbd>iTotal((x) -> x*2, {1,2,3,4,5})</kbd> ⇒ 30
			::::<kbd>iTotal((x) -> x*2, {1,2,3,4,5}, 20)</kbd> ⇒ 50
	</p>		</p>

Rsalter: /* How To Read These Entries */

2022-06-23T17:04:12Z

How To Read These Entries

← Older revision		Revision as of 17:04, 23 June 2022
Line 6:		Line 6:
	==How To Read These Entries==		==How To Read These Entries==
	Each entry shows the return type of the primop and types of the arguments to be passed in. For example, <kbd>Double foo(Double x, Integer y)</kbd> can be invoked as <kbd>foo(3.0, 1)</kbd>, or as <kbd>foo(u, v)</kbd>, where <kbd>u</kbd> has type <kbd>Double</kbd> and <kbd>v</kbd> has type <kbd>Integer</kbd>. A return type of <kbd>void</kbd> means that the primop does not return a value and should be used as a command.		Each entry shows the return type of the primop and types of the arguments to be passed in. For example, <kbd>Double foo(Double x, Integer y)</kbd> can be invoked as <kbd>foo(3.0, 1)</kbd>, or as <kbd>foo(u, v)</kbd>, where <kbd>u</kbd> has type <kbd>Double</kbd> and <kbd>v</kbd> has type <kbd>Integer</kbd>. A return type of <kbd>void</kbd> means that the primop does not return a value and should be used as a command.

			;Variable Number of Arguments
			Entries such as <kbd>foo(String s, Number... z)</kbd> represent primops with a variable number of arguments. In this case, a <kbd>String</kbd> is required as the first argument, but a sequence of <kbd>Numbers</kbd> of any length will be accepted for the second argument; e.g., <kbd>foo("howdy"), foo("howdy", 1.0), foo("howdy", 1.0, 3, 17.5, 21)</kbd>, etc. (The sequence is stored in an array).

	;Collection		;Collection
	This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array ''arr'' as a Collection argument, pass <kbd>Arrays.asList(arr)</kbd>.		This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array ''arr'' as a Collection argument, pass <kbd>Arrays.asList(arr)</kbd>.

	~~;Variable Number of Arguments~~
	Entries such as <kbd>foo(String s, Number... z)</kbd> represent primops with a variable number of arguments. In this case, a <kbd>String</kbd> is required as the first argument, but a sequence of <kbd>Numbers</kbd> of any length will be accepted for the second argument; e.g., <kbd>foo("howdy"), foo("howdy", 1.0), foo("howdy", 1.0, 3, 17.5, 21)</kbd>, etc. (The sequence is stored in an array).

	==Universal Primops==		==Universal Primops==

Rsalter: /* How To Read These Entries */

2022-06-23T17:03:43Z

How To Read These Entries

← Older revision		Revision as of 17:03, 23 June 2022
Line 8:		Line 8:

	;Collection		;Collection
	This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array ''a'' as a Collection argument, pass <kbd>Arrays.asList(a)</kbd>.		This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array ''arr'' as a Collection argument, pass <kbd>Arrays.asList(arr)</kbd>.

	;Variable Number of Arguments		;Variable Number of Arguments

Rsalter: /* How To Read These Entries */

2022-06-23T17:03:27Z

How To Read These Entries

← Older revision		Revision as of 17:03, 23 June 2022
Line 8:		Line 8:

	;Collection		;Collection
	This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array ~~<kbd>~~a~~</kbd>~~ as a Collection argument, pass <kbd>Arrays.asList(a)</kbd>.		This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array ''a'' as a Collection argument, pass <kbd>Arrays.asList(a)</kbd>.

	;Variable Number of Arguments		;Variable Number of Arguments

Rsalter: /* How To Read These Entries */

2022-06-23T17:02:45Z

How To Read These Entries

← Older revision		Revision as of 17:02, 23 June 2022
Line 6:		Line 6:
	==How To Read These Entries==		==How To Read These Entries==
	Each entry shows the return type of the primop and types of the arguments to be passed in. For example, <kbd>Double foo(Double x, Integer y)</kbd> can be invoked as <kbd>foo(3.0, 1)</kbd>, or as <kbd>foo(u, v)</kbd>, where <kbd>u</kbd> has type <kbd>Double</kbd> and <kbd>v</kbd> has type <kbd>Integer</kbd>. A return type of <kbd>void</kbd> means that the primop does not return a value and should be used as a command.		Each entry shows the return type of the primop and types of the arguments to be passed in. For example, <kbd>Double foo(Double x, Integer y)</kbd> can be invoked as <kbd>foo(3.0, 1)</kbd>, or as <kbd>foo(u, v)</kbd>, where <kbd>u</kbd> has type <kbd>Double</kbd> and <kbd>v</kbd> has type <kbd>Integer</kbd>. A return type of <kbd>void</kbd> means that the primop does not return a value and should be used as a command.

			;Collection
			This type includes the ''List'' type, elements of which are returned by many primops. It does not include the array type. In order to use an array <kbd>a</kbd> as a Collection argument, pass <kbd>Arrays.asList(a)</kbd>.

	;Variable Number of Arguments		;Variable Number of Arguments

Rsalter: /* Math Primops */

2022-06-23T16:58:57Z

Math Primops

← Older revision		Revision as of 16:58, 23 June 2022
Line 24:		Line 24:
	;<kbd>Double normalize(Double theta)</kbd>		;<kbd>Double normalize(Double theta)</kbd>
	:Normalizes angle ''theta'' to fall in the range ( ''-π'' , ''π'' ].		:Normalizes angle ''theta'' to fall in the range ( ''-π'' , ''π'' ].
			</p>
			<p id="dTotal">
			;<kbd>Double dTotal(Function<Double, Double) f, Collection<Double> nums, Double base)</kbd>
			;<kbd>Double dTotal(Function<Double, Double) f, Collection<Double> nums)</kbd>
			</p>
			<p id="iTotal">
			;<kbd>Double iTotal(Function<Integer, Integer) f, Collection<Integer> nums)</kbd>
			;<kbd>Double iTotal(Function<Integer, Integer) f, Collection<Integer> nums, Integer base)</kbd>
	</p>		</p>

Rsalter: /* Math Primops */

2022-06-23T16:49:22Z

Math Primops

← Older revision		Revision as of 16:49, 23 June 2022
Line 23:		Line 23:
	<p id="normalize">		<p id="normalize">
	;<kbd>Double normalize(Double theta)</kbd>		;<kbd>Double normalize(Double theta)</kbd>
	:Normalizes angle ''theta'' to fall in the range (-π, π].		:Normalizes angle ''theta'' to fall in the range ( ''-π'' , ''π'' ].
	</p>		</p>

Rsalter: /* Math Primops */

2022-06-23T16:48:35Z

Math Primops

← Older revision		Revision as of 16:48, 23 June 2022
Line 20:		Line 20:
	;<kbd>Integer signum(Number x)</kbd>		;<kbd>Integer signum(Number x)</kbd>
	:Returns -1 if ''x'' < 0, 1 if ''x'' > 0 and 0 if ''x'' = 0.		:Returns -1 if ''x'' < 0, 1 if ''x'' > 0 and 0 if ''x'' = 0.
			</p>
			<p id="normalize">
			;<kbd>Double normalize(Double theta)</kbd>
			:Normalizes angle ''theta'' to fall in the range (-π, π].
	</p>		</p>