File: vars-doc.m2

package info (click to toggle)
macaulay2 1.21%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 133,096 kB
  • sloc: cpp: 110,377; ansic: 16,306; javascript: 4,193; makefile: 3,821; sh: 3,580; lisp: 764; yacc: 590; xml: 177; python: 140; perl: 114; lex: 65; awk: 3
file content (72 lines) | stat: -rw-r--r-- 1,877 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
62
63
64
65
66
67
68
69
70
71
72
--- status: Draft
--- author(s): Gregory G. Smith
--- notes: 

document { 
     Key => vars,
     Headline => "variables",
     }

undocumented {(vars,QuotientRing)}

document { 
     Key => {(vars,Ring)},
     Headline => "row matrix of the variables",     
     Usage => "vars R",
     Inputs => {
	  "R"
	  },
     Outputs => {
	  Matrix =>  { "a matrix with one row whose entries are the variables of the ring ", TT "R"}
	  },
     EXAMPLE {
	  "S = QQ[w,x,y,z];",
	  "vars S",
	  "ideal vars S",
	  "coker vars S",
	  "res coker vars S",
	  "R = S/(x^2-w*y, x*y-w*z, x*z-y^2);",
          "vars R",
	  "use S;",
	  "Q = S/(x^2-w*y, z);",
	  "vars S"
	  },
     }

document { 
     Key => {(vars, Monoid)},
     Headline => "list of variables in a monoid",
     Usage => "vars M",
     Inputs => { "R" },
     Outputs => { List => { "a list of the generators of ", TT "M"} },
     "The result is the same as that provided by ", TO (generators, Monoid), ".",
     EXAMPLE lines ///
     	  M = monoid[x,y,z]
	  vars M
     ///
     }
document { 
     Key => {(vars,List), (vars,Sequence), (vars,ZZ)},
     Headline => "a sequence of variables",
     Usage => "vars L",
     Inputs => {
	  "L" => {", integer, or ", TO2("Sequence", "sequence"), " of integers"}
	  },
     Outputs => {
	  Sequence => 
	  {"which consists of ", TO2("Symbol","symbols"), 
	       " which can be used as indeterminates"}
	  },
     "The ", TO2("Symbol","symbols"), " returned are single letters, or the letter ", 
     TT "x", " or ", TT "X", " followed by some digits.  ",   
     "There is no limit on the size or sign of the integers in ", TT "L", ".",
     EXAMPLE {
	  "vars{0,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}",
	  "vars(26..51)",
	  "vars 52",
	  "vars(-9..-1)",
	  "vars(3 .. 9, 33 .. 35, 1000 .. 1002, -100 .. -98)"
	  },
     SeeAlso => {".."}
     }