File: selectVariables-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 (25 lines) | stat: -rw-r--r-- 722 bytes parent folder | download | duplicates (2)
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
document {
    Key => {
	 selectVariables,
	(selectVariables, List, PolynomialRing)
    },
    Headline => "make a subring of a polynomial ring generated by selected variables",
    Usage => "(S,F) = selectVariables(v,R)",
    Inputs => {
	"v" => {"a sorted list of numbers specifying which variables to select"},
	"R"
    },
    Outputs => {
	"S" => PolynomialRing => {"a polynomial ring generated as a subring of R by the variables whose indices
	    occur in the list v, together with the induced monomial ordering"
	},
	"F" => RingMap => {"the inclusion map from S to R"}
    },
    EXAMPLE lines ///
        R = QQ[a..h, Weights => 1..8]
        (S,F) = selectVariables({2,4}, R);
	describe S
	options S
	F
    ///
}