Difference between revisions of "ArgMin and ArgMax"
m (Ana:Fn:ArgMin and ArgMax moved to ArgMin and ArgMax: moved namespace) |
m |
||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Category:Array-reducing functions]] | |
| + | [[Category:Doc Status C]] <!-- For Lumina use, do not change --> | ||
| + | {{ReleaseBar}} | ||
| − | ArgMax( | + | == ArgMax(r, i'', position{{Release|5.2||, first}}''), ArgMin(r, i'', position{{Release|5.2||, first}}'')== |
| − | ArgMin is | + | <code>'''ArgMax'''(r, i)</code> returns the value of index «i» for which array «r» contains the largest numerical value (or if «r» contains text, the last in alphabetic order.) More specifically, it returns a value, ''ix'' where <code>r[i = ix] = Max(r, i)</code>. If there are ties, i.e. «r» has two or more values that are equal largest, it returns the value of «i» nearest the end. Similarly, <code>'''ArgMin'''(r, i)</code> returns the value of «i» for which «r» is smallest (or if «r» contains text, the first alphabetically.) |
| − | + | Optional flags: | |
| + | * '''''position''''': (default:false) When true, it returns the index position -- 1 when the max or min appears in the first element.{{Release|5.2|| | ||
| + | * '''''first''''': (default:false) If True, it returns first position (rather than the default last when there are ties.}} | ||
| − | + | == Use with multiple indexes == | |
| − | |||
| − | + | <code>'''ArgMax'''(r, i)</code> and <code>'''ArgMin'''(r, i)</code> expect «r» to be an array with index <code>i</code>, and return a result not indexed by <code>i</code>. If array «r» has any indexes in addition to «i», the result will retain those other indexes. For example, if «r» is indexed by «i» and ''j'', it will return the value of «i» for which «r» is largest (or smallest) for each value of ''j''. | |
| − | + | If you want to find the smallest or largest value of ''x'' over more than one index, you can list all those indexes: e.g. | |
| − | + | :<code>ArgMax(X, I: Mpg, Car_type)</code> | |
| − | |||
| + | It will then return an array dimensioned by a local index <code>.Dim</code> and any indexes of <code>X</code> that you did not list as parameters. Index <code>.Dim</code> will contain the names of the indexes given as parameters, <code>Mpg</code> and <code>Car_type</code>, in this case. The result will contain the values of Index <code>Mpg</code> and <code>Car_type</code> for which <code>X</code> is maximum (or minimum). | ||
| − | + | == Positional usage == | |
| − | + | By default, '''ArgMax''' and '''ArgMin''' return a value of the index. If you specify optional parameter «position» as <code>True</code>, they return the ''position'' instead of the ''value'' of the index containing the maximum (minimum). For example: | |
| + | :<code>ArgMax(R: Profit, I: UnitPrice, Position: true)</code> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
This helps avoid ambiguity when the index contains duplicate values. | This helps avoid ambiguity when the index contains duplicate values. | ||
| − | == | + | == History == |
| + | The «first» attrribute was introduced in [[Analytica 5.2]]. | ||
| − | * [[ | + | == See Also == |
| − | * [[ | + | * [[Min]] |
| − | * [[ | + | * [[Max]] |
| + | * [[CondMin]] | ||
| + | * [[CondMax]] | ||
| + | * [[SubIndex]] | ||
| + | * [[PositionInIndex]] | ||
| + | * [[Array-reducing functions]] | ||
Latest revision as of 23:14, 27 August 2019
| Release: |
4.6 • 5.0 • 5.1 • 5.2 • 5.3 • 5.4 • 6.0 • 6.1 • 6.2 • 6.3 • 6.4 • 6.5 |
|---|
ArgMax(r, i, position, first), ArgMin(r, i, position, first)
ArgMax(r, i) returns the value of index «i» for which array «r» contains the largest numerical value (or if «r» contains text, the last in alphabetic order.) More specifically, it returns a value, ix where r[i = ix] = Max(r, i). If there are ties, i.e. «r» has two or more values that are equal largest, it returns the value of «i» nearest the end. Similarly, ArgMin(r, i) returns the value of «i» for which «r» is smallest (or if «r» contains text, the first alphabetically.)
Optional flags:
- position: (default:false) When true, it returns the index position -- 1 when the max or min appears in the first element.
- first: (default:false) If True, it returns first position (rather than the default last when there are ties.
Use with multiple indexes
ArgMax(r, i) and ArgMin(r, i) expect «r» to be an array with index i, and return a result not indexed by i. If array «r» has any indexes in addition to «i», the result will retain those other indexes. For example, if «r» is indexed by «i» and j, it will return the value of «i» for which «r» is largest (or smallest) for each value of j.
If you want to find the smallest or largest value of x over more than one index, you can list all those indexes: e.g.
ArgMax(X, I: Mpg, Car_type)
It will then return an array dimensioned by a local index .Dim and any indexes of X that you did not list as parameters. Index .Dim will contain the names of the indexes given as parameters, Mpg and Car_type, in this case. The result will contain the values of Index Mpg and Car_type for which X is maximum (or minimum).
Positional usage
By default, ArgMax and ArgMin return a value of the index. If you specify optional parameter «position» as True, they return the position instead of the value of the index containing the maximum (minimum). For example:
ArgMax(R: Profit, I: UnitPrice, Position: true)
This helps avoid ambiguity when the index contains duplicate values.
History
The «first» attrribute was introduced in Analytica 5.2.
Enable comment auto-refresher