File: indices-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 (45 lines) | stat: -rw-r--r-- 1,534 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
35
36
37
38
39
40
41
42
43
44
45
--- status: TODO
--- author(s): 
--- notes: 

document { 
     Key => indices,
     Headline => "indices of a polynomial; also components for a direct sum",
     TT "indices", " has two uses in Macaulay2: indices of a direct sum, or indices of a
     polynomial.  Additionally, the symbol is used as a key in a direct sum
     under which to store a list of the preferred  keys used
     to index the components of the direct sum.",
     SeeAlso => {"directSum", "components", "indexComponents",index,support}
     }

document { 
     Key => {(indices,RingElement),(indices,Matrix)},
     Headline => "indices of variables occurring in a polynomial",
     Usage => "indices f",
     Inputs => {
	  "f" => {"or ",ofClass Matrix, "over a polynomial ring"}
	  },
     Outputs => {
	  List => "of integers, the indices of the variables 
	    occurring in the polynomial or matrix"
	  },
     "The first variable in a polynomial ring has index 0, the second has index 1, etc.
     This function returns a list (in ascending order) of the indices of all
     of the variables that occur in ", TT "f", ".",
     EXAMPLE lines ///
	  R = QQ[a..g]
	  F = a^3+b^2*c+3*f^10*d-1+e-e
	  indices F
	  index a
	  support F
	  ///,
     "The same works for matrices.",
     EXAMPLE lines ///
     	  M = matrix"a+b,c+e;2a-e,3b-c4"
	  indices M
	  support M
     	  ///,
     "This use of ", TO indices, " has no relationship with the use for
     specifying parts of a direct sum",
     SeeAlso => {index, support, indices, (symbol_,Ring,ZZ)}
     }