File: isSubmodule-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 (27 lines) | stat: -rw-r--r-- 792 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
--- status: Draft
--- author(s): Gregory G. Smith
--- notes: 

document { 
     Key => {isSubmodule, (isSubmodule,Thing), (isSubmodule,Module)},
     Headline =>  "whether a module is evidently a submodule of a free module",
     Usage => "isSubmodule M",
     Inputs => {
	  "M" => Thing
	  },
     Outputs => {
	  {TO "true", " if ", TT "M", " is evidently a submodule of a free module and ",
	       TO "false", " otherwise"}
	  },
     "No computation is done -- ", TT "M", " may be a isomorphic to a submodule of a free", 
     " module although this function will not detect it.",
     EXAMPLE {
	  "R = ZZ/5[a,b,c];",
	  "M = R^3;",
	  "isSubmodule M",
	  "N = ideal(a,b) * M",
	  "isSubmodule N",
	  "N' = ideal(a,b) * (R^1 / ideal(a^2,b^2,c^2))", 
	  "isSubmodule N'"	  
	  }
     }