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

document { 
     Key => {isFreeModule, (isFreeModule, Thing), (isFreeModule, Module)},
     Headline => "whether something is a free module",
     Usage => "isFreeModule M",
     Inputs => {
	  "M" => Thing
	  },
     Outputs => {
	  Boolean => {TO "true", " if the given representation of ", TT "M", 
	       " is a free module and ", TO "false", " otherwise"}
	  },
     "This function checks if the module ", TT "M", " is equal to its ", TO "ambient", 
     " free module by examining its matrix of ", TO2((generators, Module),"generators"), 
     " and its matrix of ", TO2((relations, Module),"relations"), ".",
     PARA{}, 
     "To determine whether ", TT "M", " is isomorphic to a free module, use ", 
     TO "prune", " ", TT "M", ".",
     EXAMPLE {
	  "R = ZZ/7[x,y];",
      	  "M = kernel vars R",
      	  "isFreeModule M",
      	  "isFreeModule prune M"	  
	  },
     SeeAlso => {ambient,(prune,Module)}
     }