Difference between revisions of "TrueFalseArrayRef"
Jump to navigation
Jump to search
(Created page with "Used in function input declaration statements to define an input as Passed by Reference true/false Array with a specified number of dimensions. Declaring an input as Passed b...") |
m |
||
Line 1: | Line 1: | ||
− | Used in function input declaration statements to define an input as Passed by Reference true/false Array with a specified number of dimensions. | + | Used in function [[input]] declaration statements to define an input as Passed by Reference true/false [[Array]] with a specified number of dimensions. |
− | Declaring an input as Passed by Reference enables the function to modify the values of variables passed as the input. | + | |
+ | Declaring an input as ''Passed by Reference'' enables the function to modify the values of variables passed as the input. | ||
− | + | == Usage == | |
− | <syntaxhighlight>Input:InputName[M1,M2,M3,etc.](TrueFalseArrayRef)</syntaxhighlight> | + | <syntaxhighlight>Input: InputName[M1,M2,M3,etc.](TrueFalseArrayRef)</syntaxhighlight> |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | An input will only accept an array with the specified number of dimensions. | + | == Parameters == |
+ | :'''InputName''' - an expression specifying the input name. The name can consist of letters, underscore characters, numbers, and periods. The name ''cannot'' begin with a number or a period and is not case-sensitive. | ||
+ | :'''M''' - an input variable that represents the maximum index value for each dimension of the array passed to the function; a single input variable specifies a one-dimensional array input, two input variables specify a two-dimensional (M1 by M2) array input, three input variables specify a three-dimensional (M1 by M2 by M3) array input, etc. | ||
+ | ::An input will only accept an array with the specified number of dimensions. | ||
− | + | == Example == | |
− | Declare | + | Declare ''Trend'' as a Passed by Reference one-dimensional true/false Array function input: |
− | <syntaxhighlight>Input:Trend[X](TrueFalseArrayRef);</syntaxhighlight> | + | <syntaxhighlight>Input: Trend[X](TrueFalseArrayRef);</syntaxhighlight> |
The maximum index value for the array passed to the function will be assigned to input variable X. | The maximum index value for the array passed to the function will be assigned to input variable X. | ||
+ | Declare ''TrendTable'' as a Passed by Reference three-dimensional true/false Array function input: | ||
− | + | <syntaxhighlight>Input: TrendTable[X,Y,Z](TrueFalseArrayRef);</syntaxhighlight> | |
− | |||
− | <syntaxhighlight>Input:TrendTable[X,Y,Z](TrueFalseArrayRef);</syntaxhighlight> | ||
The maximum index value for each dimension of the array passed to the function will be assigned to input variables X, Y, and Z. | The maximum index value for each dimension of the array passed to the function will be assigned to input variables X, Y, and Z. | ||
− | |||
− | |||
[[Category:Declaration]] | [[Category:Declaration]] |
Latest revision as of 06:07, 8 April 2013
Used in function input declaration statements to define an input as Passed by Reference true/false Array with a specified number of dimensions.
Declaring an input as Passed by Reference enables the function to modify the values of variables passed as the input.
Usage
Input: InputName[M1,M2,M3,etc.](TrueFalseArrayRef)
Parameters
- InputName - an expression specifying the input name. The name can consist of letters, underscore characters, numbers, and periods. The name cannot begin with a number or a period and is not case-sensitive.
- M - an input variable that represents the maximum index value for each dimension of the array passed to the function; a single input variable specifies a one-dimensional array input, two input variables specify a two-dimensional (M1 by M2) array input, three input variables specify a three-dimensional (M1 by M2 by M3) array input, etc.
- An input will only accept an array with the specified number of dimensions.
Example
Declare Trend as a Passed by Reference one-dimensional true/false Array function input:
Input: Trend[X](TrueFalseArrayRef);
The maximum index value for the array passed to the function will be assigned to input variable X.
Declare TrendTable as a Passed by Reference three-dimensional true/false Array function input:
Input: TrendTable[X,Y,Z](TrueFalseArrayRef);
The maximum index value for each dimension of the array passed to the function will be assigned to input variables X, Y, and Z.