File: degreeLength-doc.m2

package info (click to toggle)
macaulay2 1.17.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 68,376 kB
  • sloc: cpp: 102,995; ansic: 10,040; javascript: 6,019; sh: 3,506; makefile: 3,426; lisp: 727; yacc: 590; perl: 369; xml: 177; python: 141; lex: 65; awk: 3
file content (31 lines) | stat: -rw-r--r-- 920 bytes parent folder | download
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
--- status: Draft
--- author(s): DRG, MES
--- notes: 

undocumented {
     (degreeLength, InexactField),
     (degreeLength,PolynomialRing), 
     (degreeLength,QuotientRing),
     (degreeLength,FractionField)
     }

document {
     Key => {degreeLength,
	  (degreeLength,Module), 
	  (degreeLength,Ideal),
	  (degreeLength,OrderedMonoid), 
     	  (degreeLength,GeneralOrderedMonoid), 
	  (degreeLength,Ring)},
     Headline => "the number of degrees",
     Usage => "degreeLength X",
     Inputs => {"X" => {ofClass Ring, ", ",ofClass Ideal, ", ",ofClass Module, ", or ",ofClass Monoid}
	       },
     Outputs => { ZZ => {"the length of a multidegree vector used as a degree of an element of ", TT "X"}},
     EXAMPLE lines ///
     	  degreeLength ZZ
     	  degreeLength (ZZ[x])
     	  degreeLength (ZZ[x, Degrees => {{1,2,3}}])
     	  degreeLength (GF 9)
     ///,
     SeeAlso => {"degree",degreesRing}
     }