File: diagonalMatrix-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 (61 lines) | stat: -rw-r--r-- 1,844 bytes parent folder | download | duplicates (2)
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
--- status: 
--- author(s): M2fest 2005
--- notes: 

document { 
     Key => diagonalMatrix,
     Headline => "make a diagonal matrix",
    SeeAlso => {"matrices"},
    Subnodes => {
	TO (diagonalMatrix, Matrix),
        TO (diagonalMatrix, Ring, ZZ, ZZ, List),
        },
     }

document { 
     Key => (diagonalMatrix,Matrix),
     Headline => "make a diagonal matrix from entries of a matrix",
     Usage => "diagonalMatrix m",
     Inputs => {
	  "m" => Matrix
	  },
     Outputs => {
	  Matrix => {"a diagonal matrix whose diagonal entries are the entries of ",  "m"}
	  },
     EXAMPLE {
	  "R = QQ[a..d];",
	  "diagonalMatrix vars R"
	  },
     "If the matrix has more than one row, the first column is placed on the diagonal
     first, then the second column, etc.",
     EXAMPLE {
	  "diagonalMatrix matrix{{0,2},{4,6}}"
	  },
     SeeAlso => {"matrices"}
     }

document { 
     Key => {(diagonalMatrix, Ring, ZZ, ZZ, List),(diagonalMatrix,Ring,List),(diagonalMatrix,List),
	  (diagonalMatrix, RingFamily, List),(diagonalMatrix, RingFamily, ZZ, ZZ, List),
	  (diagonalMatrix, ZZ, ZZ, List)
	  },
     Headline => "make a diagonal matrix from a list",
     Usage => "diagonalMatrix(R,L)\ndiagonalMatrix L\ndiagonalMatrix(m,n,L)\ndiagonalMatrix(R,m,n,L)",
     Inputs => {
	  "R" => Ring => "the ring of the matrix, if specified",
	  "m" => ZZ => "the number of rows, if specified",
	  "n" => ZZ => "the number of columns, if specified",
	  "L" => List => {" of elements in the ring ", TT "R", " not longer than ", TT "m", " or ", TT "n"}
	  },
     Outputs => {
	  Matrix => {"a diagonal matrix whose diagonal entries are the elements of ",  TT "L"}
	  },
     EXAMPLE lines ///
	  R = QQ[a..d];
	  diagonalMatrix{a,b,c,3/4}
	  diagonalMatrix(3,5,{a,b,3/4})
	  diagonalMatrix(R,{1,2,3})
	  ///,
     SeeAlso => {"matrices"}
     }