File: someTerms-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-- 1,098 bytes parent folder | download | duplicates (4)
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: TODO
--- author(s): MES
--- notes: 

document { 
     Key => {someTerms,(someTerms,RingElement,ZZ,ZZ)},
     Headline => "select some terms of a polynomial",
     Usage => "someTerms(f,i,n)",
     Inputs => {
	  "f" => RingElement => "in a polynomial ring",
	  "i" => ZZ => "the starting index",
	  "n" => ZZ => "the number of terms to select"
	  },
     Outputs => {
	  RingElement => {"the ", TT "n", " terms of the polynomial ", TT "f", " starting with the 
	  ", TT "i", "-th one"}
	  },
     "The index i is 0-based, and a negative number refers to location from the end of the polynomial.",
     EXAMPLE {
	  "R = ZZ[a..d];",
	  "f = (a+2*b-3)^2",
	  "someTerms(f,0,1) -- the lead term",
	  "someTerms(f,-1,1) -- the last term",
	  "someTerms(f,-2,2) -- the last 2 terms"
	  },
     "Here is an example where the coefficient ring is also a polynomial ring.",
     EXAMPLE {
	  "S = R[x,y,z];",
	  "f = (x*(a-b)+y^2+a-1)^2",
	  "someTerms(f,-1,1) -- the last term",
	  "someTerms(f,-2,2) -- the last 2 terms"
	  },
     SeeAlso => {monomials, coefficients, terms, leadTerm}
     }