File: isIdeal-doc.m2

package info (click to toggle)
macaulay2 1.24.11%2Bds-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 171,648 kB
  • sloc: cpp: 107,850; ansic: 16,307; javascript: 4,188; makefile: 3,947; lisp: 682; yacc: 604; sh: 476; xml: 177; perl: 114; lex: 65; python: 33
file content (31 lines) | stat: -rw-r--r-- 891 bytes parent folder | download | duplicates (3)
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): Gregory G. Smith
--- notes: 

document { 
     Key => {isIdeal, (isIdeal,Thing), (isIdeal,Module),(isIdeal, Ideal)},
     Headline => "whether something is an ideal",
     Usage => "isIdeal I",
     Inputs => {
	  "I" => Thing
	  },
     Outputs => {
	  Boolean => {TO "true", " if ", TT "I", " is either an ", TO2("Ideal", "ideal"), 
	       ", a ", TO2("MonomialIdeal", "monomial ideal"), " or a ", TO2("Module", "module"), 
	       " which is a submodule of a free module of rank 1 with generators in degree 0 and ", 
	       TO "false", " otherwise"}
	  },
     EXAMPLE {
	  "S = QQ[x,y,z];",
	  "I = ideal(x^2, y^2)",
	  "isIdeal I",
	  "J = monomialIdeal I",
	  "isIdeal J",	  	  
	  "R = QQ[a..d]/(a*b*c*d);",
	  "I = ideal(a^2,b^2) * R^1",
	  "isIdeal I",
	  "J = a^2 * R^2 + a*b * R^2",
	  "isIdeal J"
	  },
     SeeAlso => {(ideal, Module)}
     }