File: genericMatrix-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 (36 lines) | stat: -rw-r--r-- 1,022 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
--- status: Draft
--- author(s): Gregory G. Smith
--- notes: 

document { 
     Key => {genericMatrix, (genericMatrix,Ring,RingElement,ZZ,ZZ), (genericMatrix,Ring,ZZ,ZZ)},
     Headline => "make a generic matrix of variables",
     Usage => "genericMatrix(R,r,m,n)",
     Inputs => {
	  "R" => Ring,
	  "r" => RingElement => {"which is a variable in the ring ", TT "R",
	       " (this input is optional)"},
	  "m" => ZZ,
	  "n" => ZZ
	  },
     Outputs => {
	  Matrix => {"with ", TT "m", " rows and ", TT "n", 
	       " columns whose entries are variables in the ring ", TT "R", 
	       " starting with ", TT "r"} 
	  },
     EXAMPLE {
	  "R = ZZ[a..z];",
	  "genericMatrix(R,a,2,4)",
	  "genericMatrix(R,i,3,2)"
	  },
     PARA{},
     "Omitting the input ", TT "r", " is the same as having ", TT "r", 
     " be the first variable in ", TT "R", ".",     
     EXAMPLE{
	  "genericMatrix(R,2,4)",
	  "genericMatrix(R,3,2)"	  
	  },
     SeeAlso => {(vars,Ring), genericSkewMatrix, genericSymmetricMatrix}
     }
end