Programmer Guide/Command Reference/EVAL/avr: Difference between revisions
From STX Wiki
< Programmer Guide | Command Reference | EVAL
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| Line 2: | Line 2: | ||
The arithmetic mean function is implemented in two versions. The function '''avg''' is an alias for this function. | The arithmetic mean function is implemented in two versions. The function '''avg''' is an alias for this function. | ||
---- | |||
;Usage 1: '''<code>avr(<var>x</var>)</code>''' | ;Usage 1: '''<code>avr(<var>x</var>)</code>''' | ||
:;<var>x</var>: a scalar, vector or matrix | :;<var>x</var>: a scalar, vector or matrix | ||
;Result 1: The result is the arithmetic mean of all elements of <var>x</var> | ;Result 1: The result is the arithmetic mean of all elements of <var>x</var> | ||
---- | |||
;Usage 2: '''<code>avr(<var>x</var>, <var>flag</var></code>''' | ;Usage 2: '''<code>avr(<var>x</var>, <var>flag</var></code>''' | ||
:;<var>x</var>: a matrix | :;<var>x</var>: a matrix | ||
| Line 17: | Line 15: | ||
:*otherwise: the result ''r'' is the vector of the row averages | :*otherwise: the result ''r'' is the vector of the row averages | ||
:::<code>''r''[''i''] = eval avr( ''x''[''i'',*]) // ''i'' = 0 .. nrow(''x'')-1</code> | :::<code>''r''[''i''] = eval avr( ''x''[''i'',*]) // ''i'' = 0 .. nrow(''x'')-1</code> | ||
---- | |||
;See also: [[Programmer_Guide/Command_Reference/EVAL/median|median]], [[Programmer_Guide/Command_Reference/EVAL/dev|dev]], [[Programmer_Guide/Command_Reference/EVAL/corr|corr]], [[Programmer_Guide/Command_Reference/EVAL/sum|sum]], [[Programmer_Guide/Command_Reference/EVAL/hist|hist]], | ;See also: [[Programmer_Guide/Command_Reference/EVAL/median|median]], [[Programmer_Guide/Command_Reference/EVAL/dev|dev]], [[Programmer_Guide/Command_Reference/EVAL/corr|corr]], [[Programmer_Guide/Command_Reference/EVAL/sum|sum]], [[Programmer_Guide/Command_Reference/EVAL/hist|hist]], | ||
[[Programmer_Guide/Command_Reference/EVAL#Functions|<function list>]] | [[Programmer_Guide/Command_Reference/EVAL#Functions|<function list>]] | ||
Revision as of 11:11, 4 April 2011
The arithmetic mean function is implemented in two versions. The function avg is an alias for this function.
- Usage 1
avr(x)- x
- a scalar, vector or matrix
- Result 1
- The result is the arithmetic mean of all elements of x
- Usage 2
avr(x, flag- x
- a matrix
- flag
- selects if the average of column vectors (flag==0) or the row vectors (flag!=0) is requsted; flag must be a scalar
- Result 2
-
- if flag equals 0: the result r is the vector of the column averages
r[i] = eval avr( x[*,i]) // i = 0 .. ncol(x)-1
- otherwise: the result r is the vector of the row averages
r[i] = eval avr( x[i,*]) // i = 0 .. nrow(x)-1
