Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix a few broken links related to isNormal and normalCone #3467

Merged
merged 4 commits into from
Oct 29, 2024
Merged

Fix a few broken links related to isNormal and normalCone #3467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
640c4af
fixed a broken link in IntegralClosure
mahrud Sep 10, 2024
3adf496
fixed missing documentation for normalCone
mahrud Sep 10, 2024
792e54c
fixed broken links for isNormal
mahrud Sep 10, 2024
378aad6
moved associatedGradedRing up in documentation keys
mahrud Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/AssociativeAlgebras/doc.m2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ doc ///
Text
The normal elements in degree 2 are x^2, y^2 and z^2. The basis
calculation shows y^2 and z^2 are normal forms in B. The normalElements
method first checks all basis monomials using @ TO isNormal @. In this case
method first checks all basis monomials using @ TO (isNormal, RingElement)@. In this case
it finds y^2 and z^2 are normal and returns this information. However,
x^2 is not a normal form expression. The normal form of x^2 is y*z+z*y. In
the second phase of the calculation, the method returns generators of the
Expand Down
3 changes: 1 addition & 2 deletions M2/Macaulay2/packages/IntegralClosure.m2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1170,7 +1170,6 @@ doc ///

doc ///
Key
isNormal
(isNormal, Ring)
Headline
determine if a reduced ring is normal
Expand Down Expand Up @@ -2173,7 +2172,7 @@ document {
"With this extra bit of information, the user can now compute
integral closures of principal ideals in ", TT "R", " via ",
TO icPIdeal, ".",
SeeAlso => {"icPIdeal", "integralClosure", "isNormal"},
SeeAlso => {"icPIdeal", "integralClosure", (isNormal, Ring)},
Caveat => "The interface to this algorithm will likely change eventually"
-- Caveat => "NOTE: mingens is not reliable, neither is kernel of the zero map!!!"
}
Expand Down
6 changes: 5 additions & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/shared.m2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ document { Key => isVeryAmple, methodstr, SeeAlso => {
"Divisor::isVeryAmple(WeilDivisor)", "Polyhedra::isVeryAmple(Polyhedron)",
"PositivityToricBundles::isVeryAmple(ToricVectorBundleKlyachko)",
"NormalToricVarieties::isVeryAmple(ToricDivisor)" } }
document { Key => isNormal, methodstr, SeeAlso => { "Polyhedra::isNormal(Polyhedron)","IntegralClosure::isNormal(Ring)"} }
document { Key => isNormal, methodstr, SeeAlso => {
"Polyhedra::isNormal(Polyhedron)",
"IntegralClosure::isNormal(Ring)",
"AssociativeAlgebras::isNormal(RingElement)",
} }
document { Key => normalCone, methodstr, SeeAlso => { "Polyhedra::normalCone(Polyhedron,Polyhedron)","ReesAlgebra::normalCone(Ideal)"} }


Expand Down
4 changes: 2 additions & 2 deletions M2/Macaulay2/packages/MultiplicitySequence.m2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,15 +373,15 @@ doc ///
this function computes the bi-graded ring Gr_m(Gr_I(R)), presented as a
quotient of a bigraded polynomial ring with variables names u and v.
After being computed once, this ring is stored in the cache of I.
This function is based on the method normalCone.
This function is based on the method @TO associatedGradedRing@.
Example
R = QQ[x,y]
I = ideal"x2,xy"
A = grGr I
describe A
hilbertSeries A
SeeAlso
normalCone
associatedGradedRing
///

doc ///
Expand Down
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/NCAlgebra/NCAlgebraDoc.m2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2487,7 +2487,7 @@ doc ///
Text
The normal elements in degree 2 are x^2, y^2 and z^2. The basis
calculation shows x^2 and y^2 are normal forms in B. The normalElements
method first checks all basis monomials using @ TO isNormal @. In this case
method first checks all basis monomials using @ TO (isNormal, NCRingElement)@. In this case
it finds x^2 and y^2 are normal and returns this information. However,
z^2 is not a normal form expression. The normal form of z^2 is x*y+y*x. In
the second phase of the calculation, the method returns generators of the
Expand Down
31 changes: 21 additions & 10 deletions M2/Macaulay2/packages/ReesAlgebra.m2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1142,7 +1142,7 @@ doc ///

In the following example, we find the Rees Algebra of a monomial curve
singularity. We also demonstrate the use of @TO reesIdeal@, @TO symmetricKernel@,
@TO isLinearType@, @TO normalCone@, @TO associatedGradedRing@, @TO specialFiberIdeal@.
@TO isLinearType@, @TO (normalCone, Ideal, RingElement)@, @TO associatedGradedRing@, @TO specialFiberIdeal@.
Example
S = QQ[x_0..x_3]
i = monomialCurveIdeal(S,{3,7,8})
Expand Down Expand Up @@ -1257,11 +1257,11 @@ doc ///

doc ///
Key
(normalCone, Ideal, RingElement)
(normalCone, Ideal)
associatedGradedRing
(associatedGradedRing, Ideal)
(associatedGradedRing, Ideal, RingElement)
(normalCone, Ideal)
(normalCone, Ideal, RingElement)
Headline
The normal cone of a subscheme
Usage
Expand All @@ -1284,8 +1284,7 @@ doc ///
isomorphic to $S/IS$, which is how it is computed here.
SeeAlso
reesAlgebra
associatedGradedRing
normalCone
"MultiplicitySequence::grGr"
///


Expand Down Expand Up @@ -1928,6 +1927,8 @@ doc ///
[reesIdeal, Variable]
[reesAlgebra, Variable]
[associatedGradedRing, Variable]
[(normalCone, Ideal), Variable]
[(normalCone, Ideal, RingElement), Variable]
[specialFiberIdeal, Variable]
[specialFiber, Variable]
[distinguished, Variable]
Expand Down Expand Up @@ -1986,6 +1987,8 @@ doc ///
[isReduction, Strategy]
[multiplicity, Strategy]
[associatedGradedRing, Strategy]
[(normalCone, Ideal), Strategy]
[(normalCone, Ideal, RingElement), Strategy]
[specialFiberIdeal, Strategy]
[specialFiber, Strategy]
[analyticSpread, Strategy]
Expand All @@ -2011,7 +2014,7 @@ doc ///
reesAlgebra
isLinearType
isReduction
normalCone
associatedGradedRing
multiplicity
specialFiberIdeal
specialFiber
Expand All @@ -2030,6 +2033,8 @@ doc ///
[specialFiberIdeal, PairLimit]
[multiplicity, PairLimit]
[associatedGradedRing, PairLimit]
[(normalCone, Ideal), PairLimit]
[(normalCone, Ideal, RingElement), PairLimit]
[isReduction, PairLimit]
[isLinearType,PairLimit]
[reesAlgebra,PairLimit]
Expand All @@ -2048,7 +2053,7 @@ doc ///
reesAlgebra
isLinearType
isReduction
normalCone
associatedGradedRing
multiplicity
specialFiberIdeal
specialFiber
Expand All @@ -2067,6 +2072,8 @@ doc ///
[specialFiberIdeal, MinimalGenerators]
[multiplicity, MinimalGenerators]
[associatedGradedRing, MinimalGenerators]
[(normalCone, Ideal), MinimalGenerators]
[(normalCone, Ideal, RingElement), MinimalGenerators]
[isReduction, MinimalGenerators]
[isLinearType,MinimalGenerators]
[reesAlgebra,MinimalGenerators]
Expand All @@ -2086,7 +2093,7 @@ doc ///
reesAlgebra
isLinearType
isReduction
normalCone
associatedGradedRing
multiplicity
specialFiberIdeal
specialFiber
Expand All @@ -2104,6 +2111,8 @@ doc ///
[specialFiber, BasisElementLimit]
[multiplicity, BasisElementLimit]
[associatedGradedRing, BasisElementLimit]
[(normalCone, Ideal), BasisElementLimit]
[(normalCone, Ideal, RingElement), BasisElementLimit]
[isReduction, BasisElementLimit]
[isLinearType,BasisElementLimit]
[reesAlgebra,BasisElementLimit]
Expand All @@ -2123,7 +2132,7 @@ doc ///
reesAlgebra
isLinearType
isReduction
normalCone
associatedGradedRing
multiplicity
specialFiberIdeal
specialFiber
Expand All @@ -2141,6 +2150,8 @@ doc ///
[specialFiber, DegreeLimit]
[multiplicity, DegreeLimit]
[associatedGradedRing, DegreeLimit]
[(normalCone, Ideal), DegreeLimit]
[(normalCone, Ideal, RingElement), DegreeLimit]
[isReduction, DegreeLimit]
[isLinearType,DegreeLimit]
[reesAlgebra,DegreeLimit]
Expand All @@ -2162,7 +2173,7 @@ doc ///
reesAlgebra
isLinearType
isReduction
normalCone
associatedGradedRing
multiplicity
specialFiberIdeal
specialFiber
Expand Down
Loading