File: pivots-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 (24 lines) | stat: -rw-r--r-- 638 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
--- status: DRAFT
--- author(s): MES
--- notes: 

document { 
     Key => {(pivots,Matrix),pivots},
     Headline => "list of pivot locations of a matrix",
     Usage => "pivots f",
     Inputs => {
	  "f"
	  },
     Outputs => {
	  List => {"of positions (r,c) which are the positions of the non-zero lead terms
	       (in each column)"}
	  },
     EXAMPLE lines ///
     	  f = matrix{{1,3,0,0,3,5,2,0,0},{0,0,0,1,3,6,7,8,0}}
	  pivots f
	  ///,
     PARA{"This function is used in the current implementation of the Smith normal form."},
     Caveat => "Should be implemented in the engine.",
     SeeAlso => {smithNormalForm}
     }