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

document { 
     Key => {isUnit, (isUnit, ZZ), (isUnit, RingElement), (isUnit, Number)},
     Headline => "whether a ring element is a unit",
     Usage => "isUnit r",
     Inputs => {
	  "r" => RingElement
	  },
     Outputs => {
	  Boolean => {TO "true", " if the ", TO2("RingElement","ring element"), " ", TT "r", 
	       " generates an ideal containing the multiplicative identity ", TT "1", " and ", 
	       TT "false", " otherwise" }
	  },
     EXAMPLE {
	  "R = QQ[z]/(z^2+1);",
	  "isUnit z",
	  "S = QQ[x,y]/(1-(x-1)*(y-1));",
	  "isUnit (x^2 - 2*x + 1)",
	  "isUnit x"	  
	  },
     }