Difference between revisions of "TrueFalseArray"

From MultiCharts
Jump to navigation Jump to search
(Created page with "Used in function input declaration statements to define an input as a true/false Array with a specified number of dimensions. Input defined as true/false can be used both as ...")
 
m
 
Line 1: Line 1:
 
Used in function input declaration statements to define an input as a true/false Array with a specified number of dimensions.  
 
Used in function input declaration statements to define an input as a true/false Array with a specified number of dimensions.  
Input defined as true/false can be used both as a true/false Simple as well as a true/false 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 true/false can be used both as a ''True/False Simple'' as well as a ''True/False 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 ====
+
== Usage ==
<syntaxhighlight>Input:InputName[M1,M2,M3,etc.](TrueFalseArray)</syntaxhighlight>  
+
<syntaxhighlight>Input: InputName[M1,M2,M3,etc.](TrueFalseArray)</syntaxhighlight>  
 
 
==== 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.  
+
== 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.  
+
:'''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 ====
+
== Example ==
Declare [[UpTrend]] as a one-dimensional true/false Array function input:  
+
Declare ''UpTrend'' as a one-dimensional true/false Array function input:  
  
<syntaxhighlight>Input:UpTrend[X](TrueFalseArray);</syntaxhighlight>  
+
<syntaxhighlight>Input: UpTrend[X](TrueFalseArray);</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 ''FlagTable'' as a three-dimensional true/false Array function input:
  
Declare [[FlagTable]] as a three-dimensional true/false Array function input:
+
<syntaxhighlight>Input: FlagTable[X,Y,Z](TrueFalseArray);</syntaxhighlight>  
 
 
<syntaxhighlight>Input:FlagTable[X,Y,Z](TrueFalseArray);</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:05, 8 April 2013

Used in function input declaration statements to define an input as a true/false Array with a specified number of dimensions.

Input defined as true/false can be used both as a True/False Simple as well as a True/False 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

Input: InputName[M1,M2,M3,etc.](TrueFalseArray)

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 UpTrend as a one-dimensional true/false Array function input:

Input: UpTrend[X](TrueFalseArray);

The maximum index value for the array passed to the function will be assigned to input variable X.

Declare FlagTable as a three-dimensional true/false Array function input:

Input: FlagTable[X,Y,Z](TrueFalseArray);

The maximum index value for each dimension of the array passed to the function will be assigned to input variables X, Y, and Z.