Programmer Guide/Command Reference/EVAL/avr: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(7 intermediate revisions by 2 users not shown)
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: '''<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
:;<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>: compute mean of the column vectors (''flag''=0) or the row vectors (''flag''&ne;0) is requsted; ''flag'' must be a scalar
;Result 2:  
;Result 2:  
:*if flag equals '''0''': the result ''r'' is the vector of the column averages
:*if ''flag''=0: the result ''r'' is the vector of the column means
:::<code>''r''[''i''] = eval avr( ''x''[*,''i'']) // ''i'' = 0 .. ncol(''x'')-1</code>
:::<code>''r''[''i''] = eval avr( ''x''[*,''i''], 0) // ''i'' = 0 .. ncol(''x'')-1</code>
:*otherwise: the result ''r'' is the vector of the row averages
:*otherwise: the result ''r'' is the vector of the row means
:::<code>''r''[''i''] = eval avr( ''x''[''i'',*]) // ''i'' = 0 .. nrow(''x'')-1</code>
:::<code>''r''[''i''] = eval avr( ''x''[''i'',*], 1) // ''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: [[../median|median]], [[../var|var]], [[../dev|dev]], [[../corr|corr]], [[../sum|sum]], [[../hist|hist]],


[[Programmer_Guide/Command_Reference/EVAL#Functions|<function list>]]
[[../#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
See also
median, var, dev, corr, sum, hist,

<function list>

Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Command_Reference/EVAL/avr&oldid=10678"

Navigation menu

Personal tools