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 1: | Line 1: | ||
{{DISPLAYTITLE:avr (alias: avg)}} | {{DISPLAYTITLE:avr (alias: avg)}} | ||
The arithmetic mean function is implemented in two versions. | The arithmetic mean function is implemented in two versions. | ||
---- | ---- | ||
;Usage 1: | ;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: | ;Usage 2: <code>avr(<var>x</var>, <var>flag</var>)</code> | ||
:;<var>x</var>: a matrix | :;<var>x</var>: a matrix | ||
:;<var>flag</var>: selects if the average of the column vectors (''flag''==0) or the row vectors (''flag''!=0) is requsted; ''flag'' must be a scalar | :;<var>flag</var>: selects if the average of the column vectors (''flag''==0) or the row vectors (''flag''!=0) is requsted; ''flag'' must be a scalar | ||
| Line 16: | Line 15: | ||
:::<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: [[ | ;See also: [[../median|median]], [[../var|var]], [[../dev|dev]], [[../corr|corr]], [[../sum|sum]], [[../hist|hist]], | ||
[[ | [[../#Functions|<function list>]] | ||
Revision as of 10:15, 21 April 2011
The arithmetic mean function is implemented in two versions.
- 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 the 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
