File: baseRing-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 (41 lines) | stat: -rw-r--r-- 1,434 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
document {
     Key => baseRings,
     Headline => "store the list of base rings of a ring",
     TT "baseRings", " -- a symbol used as a key in a ring ", TT "R", " under which is
     stored a list of base rings for ", TT "R", ".",
     PARA{
     	  "A base ring ", TT "A", " of ", TT "R", " is one of the rings involved in the
     	  construction of ", TT "R", "."
	  },
     PARA{ "The base rings are presented in chronological order." },
     SeeAlso => { baseRing }
     }

document {
     Key => {baseRing,(baseRing, Ring)},
     Headline => "produce the ring from which a ring was formed",
     Usage => "baseRing R",
     Inputs => { "R" => Ring },
     Outputs => { Ring => "the ring from which ", TT "R", " was formed" },
     PARA {
	  "The base ring of a ring ", TT "R", " is the ring from which ", TT "R", " was formed.
	  For example, if ", TT "R", " is a quotient ring of the form ", TT "S/I", ", 
	  or if ", TT "R", " is a fraction ring of the form ", TT "frac S", ", 
	  or if ", TT "R", " is a polynomial ring over ", TT "S", ",
	  then the base ring is ", TT "S", "."
	  },
     EXAMPLE lines ///
     baseRing QQ
     R = QQ[x,y]
     S = R / (x^2 + y^3 - 1)
     T = frac S
     baseRing T
     baseRing S
     baseRing R
     ///,
     PARA {
	  "The entire chain of base rings can be obtained under the key ", TO "baseRings", "."
	  },
     EXAMPLE "T.baseRings",
     Subnodes => { TO "baseRings" },
     }