EMK:Formulae and Functions - Revision history

WoodsM: /* Array Functions */

2013-09-10T21:15:23Z

Array Functions

WoodsM: /* Array Functions */

2013-09-10T21:12:32Z

Array Functions

WoodsM: /* Array Functions */

2013-09-10T21:11:26Z

Array Functions

WoodsM: /* Array Functions */

2013-09-10T21:10:31Z

Array Functions

WoodsM: /* Array Functions */

2013-09-10T21:10:09Z

Array Functions

WoodsM: /* Arithmetic Functions */

2013-09-10T21:05:13Z

Arithmetic Functions

WoodsM: /* Arithmetic Functions */

2013-09-10T20:42:54Z

Arithmetic Functions

WoodsM: /* Special Variables */

2013-08-19T23:18:15Z

Special Variables

WoodsM: /* Special Variables */

2013-08-19T23:17:51Z

Special Variables

WoodsM: /* Special Variables */

2013-08-19T23:17:04Z

Special Variables

@@ Line 115: / Line 115: @@
 | WgtAvg || Average of numbers in an array, weighted by numbers in another array || 2 x Integer or Real Array, (Values, Weights) || Real || WgtAvg(Generator.Generation,Generator.Cost)
 |-
-| ArrMult || Returns an array whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration)
+| ArrMult || Returns an array whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Array || ArrMult(Node.Demand, Duration)
 |-
-| AddElements || Returns an array whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || AddElements(Node.Demand, Node.Losses)
+| AddElements || Returns an array whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Array || AddElements(Node.Demand, Node.Losses)
 |-
-| SubElements || Returns an array whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || SubElements(Circuit.Flow, Circuit.Losses)
+| SubElements || Returns an array whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Array || SubElements(Circuit.Flow, Circuit.Losses)
 |-
-| MultiplyElements || Returns an array whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || MultiplyElements(Node.Demand, Node.Price)
+| MultiplyElements || Returns an array whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Array || MultiplyElements(Node.Demand, Node.Price)
 |}

@@ Line 115: / Line 115: @@
 | WgtAvg || Average of numbers in an array, weighted by numbers in another array || 2 x Integer or Real Array, (Values, Weights) || Real || WgtAvg(Generator.Generation,Generator.Cost)
 |-
-| ArrMult || Creates a new array, whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration)
+| ArrMult || Returns an array whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration)
 |-
-| AddElements || Creates a new array, whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || AddElements(Node.Demand, Node.Losses)
+| AddElements || Returns an array whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || AddElements(Node.Demand, Node.Losses)
 |-
-| SubElements || Creates a new array, whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || SubElements(Circuit.Flow, Circuit.Losses)
+| SubElements || Returns an array whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || SubElements(Circuit.Flow, Circuit.Losses)
 |-
-| MultiplyElements || Creates a new array, whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || MultiplyElements(Node.Demand, Node.Price)
+| MultiplyElements || Returns an array whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || MultiplyElements(Node.Demand, Node.Price)
 |}

@@ Line 103: / Line 103: @@
 ! Function !! Purpose !! Parameters !! Return Type !! Example
 |-
-| Sum || Total value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Sum(Node.Price) ||
+| Sum || Total value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Sum(Node.Price)
 |-
-| Max || Maximum value of numbers in an array, optionally excluding values with value over an exclude value || Integer or Real Array, [Exclude Value] || Real || Max(Generator.Generation) ||
+| Max || Maximum value of numbers in an array, optionally excluding values with value over an exclude value || Integer or Real Array, [Exclude Value] || Real || Max(Generator.Generation)
 |-
-| Min || Minimum value of numbers in an array ||  Integer or Real Array, [Exclude Value] || Real || Min(Generator.Generation) ||
+| Min || Minimum value of numbers in an array ||  Integer or Real Array, [Exclude Value] || Real || Min(Generator.Generation)
 |-
-| StdDev || Standard deviation of numbers in an array || Integer or Real Array, [Exclude Value] || Real || StdDev(Generator.Generation) ||
+| StdDev || Standard deviation of numbers in an array || Integer or Real Array, [Exclude Value] || Real || StdDev(Generator.Generation)
 |-
-| Avg || Average value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Avg(Generator.Generation) ||
+| Avg || Average value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Avg(Generator.Generation)
 |-
-| WgtAvg || Average of numbers in an array, weighted by numbers in another array || 2 x Integer or Real Array, (Values, Weights) || Real || WgtAvg(Generator.Generation,Generator.Cost) ||
+| WgtAvg || Average of numbers in an array, weighted by numbers in another array || 2 x Integer or Real Array, (Values, Weights) || Real || WgtAvg(Generator.Generation,Generator.Cost)
 |-
-| ArrMult || Creates a new array, whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration) ||
+| ArrMult || Creates a new array, whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration)
 |-
-| AddElements || Creates a new array, whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || AddElements(Node.Demand, Node.Losses) ||
+| AddElements || Creates a new array, whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || AddElements(Node.Demand, Node.Losses)
 |-
-| SubElements || Creates a new array, whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || SubElements(Circuit.Flow, Circuit.Losses) ||
+| SubElements || Creates a new array, whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || SubElements(Circuit.Flow, Circuit.Losses)
 |-
-| MultiplyElements || Creates a new array, whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || MultiplyElements(Node.Demand, Node.Price) ||
+| MultiplyElements || Creates a new array, whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || MultiplyElements(Node.Demand, Node.Price)
 |}

@@ Line 101: / Line 101: @@
 The following table lists EMarket's array functions:
 {|class="wikitable"
-! Function !! Purpose !! Parameters !! Return Type !! Example !! Result
+! Function !! Purpose !! Parameters !! Return Type !! Example
 |-
 | Sum || Total value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Sum(Node.Price) ||

@@ Line 102: / Line 102: @@
 {|class="wikitable"
 ! Function !! Purpose !! Parameters !! Return Type !! Example !! Result
 | Sum || Total value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Sum(Node.Price) ||
 |-
@@ Line 115: / Line 116: @@
 |-
 | ArrMult || Creates a new array, whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration) ||
 | AddElements || Creates a new array, whose elements are the sum of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || AddElements(Node.Demand, Node.Losses) ||
 | SubElements || Creates a new array, whose elements are the difference of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || SubElements(Circuit.Flow, Circuit.Losses) ||
 | MultiplyElements || Creates a new array, whose elements are the product of the elements in two arrays (the arrays must be of the same size) || 2 x Integer or Real Arrays || Real Value Array || MultiplyElements(Node.Demand, Node.Price) ||
 |}

@@ Line 94: / Line 94: @@
 | Int || Integer portion of a number || Integer or Real || Integer || Int(45.786) || 45
 |-
-| Sum || Total value of numbers in an array || Integer or Real Array, (Exclude Value) || Real || Sum(Node.Price) ||
+| Choke || Returns a collared value (i.e. the value of the referenced variable is returned if it falls within the specified range otherwise the relevant minimum or maximum value is returned) || Integer or Real || Real || Choke(500,200,Generator.Generation)||
 |-
-| Max || Maximum value of numbers in an array, optionally excluding values with value over an exclude value || Value Array (Exclude Value), Integer or Real || Real || Max(Generator.Generation) ||
+| Max || Maximum value of numbers in an array, optionally excluding values with value over an exclude value || Integer or Real Array, [Exclude Value] || Real || Max(Generator.Generation) ||
 |-
-| Min || Minimum value of numbers in an array ||  Value Array (Exclude Value), Integer or Real || Real || Min(Generator.Generation) ||
+| Min || Minimum value of numbers in an array ||  Integer or Real Array, [Exclude Value] || Real || Min(Generator.Generation) ||
 |-
-| StdDev || Standard deviation of numbers in an array || Value Array (Exclude Value), Integer or Real || Real || StdDev(Generator.Generation) ||
+| StdDev || Standard deviation of numbers in an array || Integer or Real Array, [Exclude Value] || Real || StdDev(Generator.Generation) ||
 |-
-| Avg || Average value of numbers in an array || Value Array (Exclude Value), Integer or Real || Real || Avg(Generator.Generation) ||
+| Avg || Average value of numbers in an array || Integer or Real Array, [Exclude Value] || Real || Avg(Generator.Generation) ||
 |-
-| WgtAvg || Average of numbers in an array, weighted by numbers in another array || Value Array (Weights Array), Integer or Real || Real || WgtAvg(Generator.Generation,Generator.Cost) ||
+| WgtAvg || Average of numbers in an array, weighted by numbers in another array || 2 x Integer or Real Array, (Values, Weights) || Real || WgtAvg(Generator.Generation,Generator.Cost) ||
 |-
-| Choke || Returns a collared value (i.e. the value of the referenced variable is returned if it falls within the specified range otherwise the relevant minimum or maximum value is returned) || Integer or Real || Real || Choke(500,200,Generator.Generation)||
+| ArrMult || Creates a new array, whose elements are the product of the elements in an array and a scalar value || Integer or Real Array, Integer or Real Value || Real Value Array || ArrMult(Node.Demand, Duration) ||
 |}

@@ Line 41: / Line 41: @@
 |-
 | RandomSeed || This variable is set up according to the 'Random Seed' option in the '''''[[EMK:Run Window | Run Resource]]'''''.  It allows the generation of random sequences to be
-coordinated for all '''''[[#Random Functions | random functions]]'''''randomisation functions within the run
+coordinated for all '''''[[#Random Functions | Random Functions]]''''' within the run
 |-
 |}

@@ Line 40: / Line 40: @@
 |-
 |-
-| RandomSeed || This variable is set up according to the 'Random Seed' option in the '''''[[EMK:Run Resource | Run Resource]]'''''.  It allows the generation of random sequences to be
+| RandomSeed || This variable is set up according to the 'Random Seed' option in the '''''[[EMK:Run Window | Run Resource]]'''''.  It allows the generation of random sequences to be
 coordinated for all randomisation functions within the run
 |-