Programmer Guide/Command Reference/EVAL/avr: Difference between revisions
From STX Wiki
< Programmer Guide | Command Reference | EVAL
Jump to navigationJump to search
(initial import) |
No edit summary |
||
| (22 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE: | {{DISPLAYTITLE:avr (alias: avg)}} | ||
=====avr= | The arithmetic mean function is implemented in two versions. | ||
---- | |||
;Usage 1: <code>avr(<var>x</var>)</code> | |||
:;<var>x</var>: a scalar, vector or matrix | |||
;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> | |||
:;<var>x</var>: a matrix | |||
:;<var>flag</var>: compute mean of the column vectors (''flag''=0) or the row vectors (''flag''≠0) is requsted; ''flag'' must be a scalar | |||
;Result 2: | |||
:*if ''flag''=0: the result ''r'' is the vector of the column means | |||
:::<code>''r''[''i''] = eval avr( ''x''[*,''i''], 0) // ''i'' = 0 .. ncol(''x'')-1</code> | |||
:*otherwise: the result ''r'' is the vector of the row means | |||
:::<code>''r''[''i''] = eval avr( ''x''[''i'',*], 1) // ''i'' = 0 .. nrow(''x'')-1</code> | |||
---- | |||
;See also: [[../median|median]], [[../var|var]], [[../dev|dev]], [[../corr|corr]], [[../sum|sum]], [[../hist|hist]], | |||
[[../#Functions|<function list>]] | |||
Latest revision as of 08:59, 29 January 2020
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
- compute mean of the column vectors (flag=0) or the row vectors (flag≠0) is requsted; flag must be a scalar
- Result 2
-
- if flag=0: the result r is the vector of the column means
r[i] = eval avr( x[*,i], 0) // i = 0 .. ncol(x)-1
- otherwise: the result r is the vector of the row means
r[i] = eval avr( x[i,*], 1) // i = 0 .. nrow(x)-1
