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

Revision as of 10:38, 4 April 2011

Returns the index of largest value of argument x.

Result

The result is the index of the maximum value of x.

if x is a scalar: the result is 0
if x is a vector: the result is the index (row) of the minimum
if x is a matrix: the result is the element index i of the maximum; the column c and the row r can be computed as follows: c := int i/x[!nrow], r := int i%x[!nrow]

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:{{SUBPAGENAME}}}}
-=====imax=====
+Returns the index of largest value of argument <var>x</var>.
-The index of the maximum element in the vector <var>x</var>.
+;Usage: '''<code>imax(<var>x</var>)</code>'''
-{|
+;Result: The result is the index of the maximum value of <var>x</var>.
-|-
+::*if <var>x</var> is a scalar: the result is '''0'''
-|Usage:
+::*if <var>x</var> is a vector: the result is the index (row) of the minimum
-|imax(x)
+::*if <var>x</var> is a matrix: the result is the element index ''i'' of the maximum; the column ''c'' and the row ''r'' can be computed as follows: <code>''c'' := int ''i''/''x''[!nrow]</code>, <code>r := int ''i''%''x''[!nrow]</code>
-|-
-|Result type:
+;See also: [[Programmer_Guide/Command_Reference/EVAL/max|max]], [[Programmer_Guide/Command_Reference/EVAL/absmax|absmax]], [[Programmer_Guide/Command_Reference/EVAL/imin|imin]],
-|scalar
-|}
+[[Programmer_Guide/Command_Reference/EVAL#Functions|<function list>]]