File: ideal-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 (177 lines) | stat: -rw-r--r-- 4,783 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
--- status: Draft
--- author(s): Gregory G. Smith
--- notes: 

-- in Classic: (ideal, String)

undocumented (ideal,Ideal)

document { 
     Key => ideal,
     Headline => "make an ideal",
    SeeAlso => {
	"Classic::ideal(String)",
        },
    Subnodes => {
	-- TODO: combine some of these
	TO (ideal, List),
	TO (ideal, Matrix),
	TO (ideal, Module),
	TO (ideal, MonomialIdeal),
	TO (ideal, Ring),
	TO (ideal, RingElement),
        },
     }
document { 
     Key => {(ideal,List), (ideal,Sequence)},
     Usage => "ideal L",
     Inputs => {
	  "L" => {"or a ", TO2("Sequence","sequence"), " of ", TO2("RingElement", "ring elements")}
	  },
     Outputs => {
	  Ideal => {"which is generated by the ", TO2("List","list"), " or ",
	  TO2("Sequence","sequence"), " of ",  TO2("RingElement", "ring elements")}
	  },
     EXAMPLE {
	  "R = ZZ/101[w,x,y,z];",
	  "ideal{x^2-w*y, x*y-w*z, x*z-y^2}",
 	  "ideal(y^2-x*z,x^2*y-z^2,x^3-y*z)",
	  "E = ZZ/2[x,y, SkewCommutative => true];",
	  "ideal(x^2,x*y)",
	  "W = QQ[x,dx, WeylAlgebra => {x => dx}];",
	  "ideal(dx*x+x*dx)",
	  "I = ideal(12,18)",
	  "mingens I"
	  },
     PARA {
	  "An empty list or sequence of generators will yield an ideal of ", TO "ZZ", ", which
	  can be promoted to another ring, if desired."
	  },
     EXAMPLE lines ///
     ideal ()
     promote(oo,R)
     ///,
     SeeAlso => {Ideal, PolynomialRing}
     }
document { 
     Key => (ideal,Matrix),
     Usage => "ideal M",
     Inputs => {
	  "M" => {"whose ", TO "entries", " are ", TO2("RingElement", "ring elements")}
	  },
     Outputs => {
	  Ideal => {"which is generated by all the entries in ", TT "M"}
	  },
     EXAMPLE {
	  "R = ZZ/7[w,x,y,z];",
	  "f = vars R",
	  "ideal f",
	  "g = matrix{{x^2-w*y, x*y-w*z, x*z-y^2},{y^2-x*z,x^2*y-z^2,x^3-y*z}}",
	  "ideal g"
	  },
     PARA{},     
     "The functions ", TO "minors", ", ", TO "pfaffians", " and ", 
     TO2("fittingIdeal", "fitting ideal"),  " are typically more useful methods of creating an ", 
     TO2("Ideal","ideal"), " from a matrix.",
     SeeAlso => {entries, flatten}
     }
document { 
     Key => {(ideal,RingElement), (ideal,Number)},
     Usage => "ideal r",
     Inputs => {
	  "r"
	  },
     Outputs => {
	  Ideal => {"which is generated by the ", TO2("RingElement", "ring element"), " ", TT "r"}
	  },
     EXAMPLE {
	  "ideal 7",
	  "R = ZZ/2[x,y];",
	  "f = x^2+y^2;",
	  "ideal f"
	  },
     PARA {
	  "The zero ideal with one generator can be made:"
	  },
     EXAMPLE "ideal 0_R",
     PARA {
	  "Alternatively, the zero ideal with no generators can be made in one of these ways:"
	  },
     EXAMPLE lines ///
     ideal id_(R^0)
     promote(ideal(), R)
     ///,
     PARA {
	  "See ", TO promote, ", ", TO (id,Module), ", and ", TO (ideal,Sequence), ".",
	  }
     }
document { 
     Key => {(ideal,Ring), (ideal,QuotientRing)},
     Headline => "get the defining ideal",
     Usage => "ideal R",
     Inputs => {
	  "R"
	  },
     Outputs => {
	  Ideal => {"which is the defining ideal of ", TT "R"}
	  },
     "A ", TO2("QuotientRing","quotient ring"), " is a the quotient of its ", TO "ambient", 
     " ", TO2("Ring","ring"), " by its defining ideal.  Other rings have no ambient ring,
     and the defining ideal is its zero ideal.", 
     EXAMPLE {
	  "S = ZZ/2[x,y,z];",
	  "ideal S",
	  "R = S/(y^2-x*z,x^2*y-z^2)",
	  "ideal R",
	  "T = R/(x^3-y*z)",
	  "ideal T",
	  "ambient T",
	  "sing = singularLocus T",
	  "ideal sing",
	  "ambient sing"
	  },
     SeeAlso => {ambient, singularLocus}
     }
document { 
     Key => (ideal,MonomialIdeal),
     Headline => "convert a monomial ideal to an ideal",
     Usage => "ideal I",
     Inputs => {
	  "I"
	  },
     Outputs => {
	  Ideal => {"which is generated by the monomials in ", TT "I"} 
	  },
     EXAMPLE {
	  "R = QQ[x,y,z];",
	  "I = monomialIdeal(x*y^2, x^2*z, y^2*z)",
     	  "ideal I"
	  },
     PARA{},
     "Most operations between ", TO2("Ideal","ideals"), " and ", TO2("MonomialIdeal","monomial ideals"), 
     " automatically perform the necessary conversions, so one rarely needs to apply the function ", 
     TT "ideal", " to a ", TO2("MonomialIdeal","monomial ideal"), ".",
     EXAMPLE {
	  "I * ideal I",
	  "I + ideal(x*y+y*z)"
	  },
     SeeAlso => {monomialIdeal, (generators,Ideal)}
     }
document { 
     Key => (ideal,Module),
     Headline => "convert a module to an ideal",
     Usage => "ideal M",
     Inputs => {
	  "M" => "which is a submodule of a free module of rank 1"
	  },
     Outputs => {
	  Ideal => {"given by the generators of ", TT "M"}
	  },
     EXAMPLE {
	  "R = QQ[w,x,y,z];",
	  "f = map(R^1,R^3, matrix{{x^2-w*y, x*y-w*z, x*z-y^2}})",
	  "image f",
	  "ideal image f"
	  }, 
     SeeAlso => {(generators,Module), ambient, isSubmodule, isIdeal}
     }