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

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
Line 8: Line 8:
;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''&ne;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''=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'']) // ''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'',*]) // ''i'' = 0 .. nrow(''x'')-1</code>
----
----

Revision as of 10:18, 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
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]) // i = 0 .. ncol(x)-1
  • otherwise: the result r is the vector of the row means
r[i] = eval avr( x[i,*]) // i = 0 .. nrow(x)-1

See also
median, var, dev, corr, sum, hist,

<function list>

Navigation menu

Personal tools