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

document { 
     Key => {genericSymmetricMatrix, (genericSymmetricMatrix,Ring,ZZ), (genericSymmetricMatrix,Ring,RingElement,ZZ)},
     Headline => "make a generic symmetric matrix",
     Usage => "genericSymmetricMatrix(R,r,n)",
     Inputs => {
	  "R" => Ring,
	  "r" => RingElement => {"which is a variable in the ring ", TT "R", 
	       " (this input is optional)"},
	  "n" => ZZ
	  },
     Outputs => {
	  {"a symmetric ", TO2("Matrix", "matrix"), " with ", TT "n",
	       " rows whose entries on and above the diagonal are the variables of ", TT "R",
	       " starting with ", TT "r"}
	  },
     "A square ", TO2("Matrix","matrix"), " ", TT "M", " is ", EM "symmetric", 
     " if ", TT "transpose(M) - M == 0", ".",
     EXAMPLE {
	  "R = ZZ[a..z];",
	  "M = genericSymmetricMatrix(R,a,3)",
	  "transpose(M) - M == 0",
	  "genericSymmetricMatrix(R,d,5)"
	  },
     PARA{},
     "Omitting the input ", TT "r", " is the same as having ", TT "r", 
     " be the first variable in ", TT "R", ".",
     EXAMPLE{
     	  "genericSymmetricMatrix(R,3)",
     	  "genericSymmetricMatrix(R,5)"
	  },
     SeeAlso => {(vars, Ring), genericMatrix, genericSkewMatrix}
     }