NumericArray: Difference between revisions
From MultiCharts
(Created page with "Used in function input declaration statements to define an input as a Numerical Array with a specified number of dimensions. Input defined as Numerical can be used both as a ...") |
mNo edit summary |
||
Line 1: | Line 1: | ||
Used in function input declaration statements to define an input as a Numerical Array with a specified number of dimensions. | Used in function input declaration statements to define an input as a Numerical Array with a specified number of dimensions. | ||
Input defined as Numerical can be used both as a Numerical Simple as well as a Numerical Series input; the value of a Simple input is constant from bar to bar and thus has no history, while the value of a Series input may vary from bar to bar and can be referenced historically. | |||
Input defined as Numerical can be used both as a ''Numerical Simple'' as well as a ''Numerical Series'' input; the value of a Simple input is constant from bar to bar and thus has no history, while the value of a Series input may vary from bar to bar and can be referenced historically. | |||
== Usage == | |||
<syntaxhighlight>Input:InputName[M1,M2,M3,etc.](NumericArray)</syntaxhighlight> | <syntaxhighlight>Input: InputName[M1,M2,M3,etc.](NumericArray)</syntaxhighlight> | ||
The name cannot begin with a number or a period and is not case-sensitive. | == 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. | |||
An input will only accept an array with the specified number of dimensions. | |||
== Example == | |||
Declare Length as a one-dimensional Numerical Array function input: | Declare Length as a one-dimensional Numerical Array function input: | ||
<syntaxhighlight>Input:Length[X](NumericArray);</syntaxhighlight> | <syntaxhighlight>Input: Length[X](NumericArray);</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 Table as a three-dimensional Numerical Array function input: | Declare Table as a three-dimensional Numerical Array function input: | ||
<syntaxhighlight>Input:Table[X,Y,Z](NumericArray);</syntaxhighlight> | <syntaxhighlight>Input: Table[X,Y,Z](NumericArray);</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]] |