File: maxPosition-doc.m2

package info (click to toggle)
macaulay2 1.25.05%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 172,152 kB
  • sloc: cpp: 107,824; ansic: 16,193; javascript: 4,189; makefile: 3,899; lisp: 702; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (40 lines) | stat: -rw-r--r-- 919 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
-- Status: rewritten July 2018
-- Author: Lily Silverstein

doc///
 Key 
  maxPosition
  (maxPosition, BasicList)
 Headline
  position of the largest element
 Usage
  maxPosition L
 Inputs
  L:BasicList
 Outputs
  i:ZZ
   the index of the largest element in the list {\tt L}
 Description
  Text
   If the largest element occurs more than once, the index of its first occurrence is used.
  Example
   maxPosition {1, 6, 4, 2, 6}
  Text
   If {\tt L} contains elements in a polynomial ring, the @TO MonomialOrder@
   of the ring is used for comparisons.
  Example
   R1 = QQ[x, y, z, MonomialOrder => Lex];
   maxPosition {x*y^2, x*y^2 + z^2, y^4, y*z^5}
   R2 = QQ[x, y, z, MonomialOrder => GRevLex];
   maxPosition (x*y^2, x*y^2 + z^2, y^4, y*z^5)
  Text
   More generally, the order of the elements is determined using the @TO "?"@ operator.
 SeeAlso 
  minPosition
  max
  min
  sort
  position
  positions
  "?"
///