File: isField-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 (36 lines) | stat: -rw-r--r-- 983 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
32
33
34
35
36
--- status: Draft
--- author(s): Gregory G. Smith
--- notes: 

undocumented{(isField, InexactField)}
document { 
     Key => {isField, (isField, EngineRing), (isField, Ring)},
     Headline => "whether something is a field",
     Usage => "isField R",
     Inputs => {
	  "R" => Ring
	  },
     Outputs => {
	  Boolean => {TO "true", " if ", TT "R", 
	       " was explicitly constructed as a field (no computation is done) and ", 
	       TO "false", " otherwise"}
	  },
     "This function recognizes basic fields, ", TO2("GaloisField","Galois fields"), 
     " and ", TO2("FractionField","fraction fields"), ".",
     EXAMPLE {
	  "isField QQ",
	  "isField CC_53",
	  "isField GF(2,3)",
	  "isField(frac(QQ[x,y]))"
	  },
     "This function will not recognize other rings as fields.",
     EXAMPLE {
	  "R = QQ[x]/(x^2+1)",
	  "isUnit x",
	  "isField R",
	  "F = toField R",
	  "isField F"
	  },
     SeeAlso => {toField, FractionField, GaloisField, QuotientRing, isUnit}
     }