File: getNonUnit-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 (28 lines) | stat: -rw-r--r-- 933 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
-- -*- coding: utf-8 -*-
--- status: Draft
--- author(s): MES
--- notes: This function is not functional yet

document {
     Key =>  getNonUnit,
     Headline => "retrieve a previously discovered non-unit",
     Usage => "getNonUnit R",
     Inputs => {
	  "R" => Ring => "in which division by a non-unit may have been attempted"
	  },
     Outputs => {
	  RingElement => {"the non-unit, if any, or ", TO null}
	  },
     "If a ring has been declared to be a field, using ", TO toField, " or ", TO frac, ", but a nonzero element is
     found to not be a unit, this routine will return that element, otherwise ", TO null, " is returned.",
     EXAMPLE lines ///
     	  A = ZZ/101[a]/(a^2-1);
	  toField A
	  1//(a-1)
	  getNonUnit A
          ///,
     "Warning: this function does not work yet for divisions attempted in the course
     of computing a Gröbner basis or resolution.",
     SeeAlso => { "toField", "frac" }
     }