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

document { 
     Key => {isRing, (isRing,Ring), (isRing, Thing)},
     Headline => "whether something is a ring",
     Usage => "isRing R",
     Inputs => {
	  "R" => Thing
	  },
     Outputs => {
	  Boolean => {TO "true", " if ", TT "R", " is a ", TO2("Ring", "ring"), " and ", 
	       TO "false", " otherwise"}
	  },
     EXAMPLE {
	  "isRing QQ",
	  "R = QQ[x,y];",
	  "isRing(R)",
	  "isRing(R^1)",
	  "isRing(GF(2,3)[x,dx, WeylAlgebra => {x => dx}])"
	  },
     }