File: coefficient-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 (34 lines) | stat: -rw-r--r-- 959 bytes parent folder | download | duplicates (5)
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
--- status: DRAFT
--- author(s): MES
--- notes: 

undocumented {
	  (coefficient, RingElement, RingElement),
	  (coefficient, MonoidElement, RingElement)
	  }

document { 
     Key => coefficient,
     Headline => "coefficient of a monomial",
     Usage => "coefficient(m,f)",
     Inputs => {
	  "m" => RingElement => "a monomial",
	  "f" => RingElement => {"in the same ring ", TT "R", " as ", TT "m"}
	  },
     Outputs => {
	  RingElement => {"the coefficient of the monomial ", TT "m", " in ", TT "f",
	       " as an element of the coefficient ring of ", TT "R"}
	  },
     EXAMPLE {
	  "R = GF(25,Variable=>a)[x,y,z];",
	  "f = ((a+1)*x+a*y+a^2*z)^2",
	  "coefficient(y^2,f)"
	  },
     "The returned value is an element of the coefficient ring, even in the case when that
     ring is another polynomial ring.",
     EXAMPLE {
	  "S = R[r,s,t];",
	  "coefficient(r,a*x*(r+a*s))"
	  },
     SeeAlso => {coefficients, monomials, coefficientRing}
     }