File: class-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 (33 lines) | stat: -rw-r--r-- 836 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
--- status: DRAFT
--- author(s): MES, taken from Dan's.
--- notes: 

document { 
     Key => {class, (class, Thing)},
     Headline => "class of an object",
     Usage => "class x",
     Inputs => {
	  "x" => Thing => "any Macaulay2 object"
	  },
     Outputs => {
	  Type => {"the class of ", TT "x"}
	  },
     "Every object in Macaulay2 has a class, see ", TO "what a class is", " for more details.",
     EXAMPLE {
	  "class {1,2,3}",
	  "R = QQ[a..d]",
     	  "class R"
	  },
     "Use strict equality ", TT "===", " to test the exact class
     of an object.",
     EXAMPLE {
	  "class R === PolynomialRing",
	  "class R === Ring"
	  },
     "However, each PolynomialRing is a Ring, by inheritance, so a more
     useful test uses ", TO instance, ".",
     EXAMPLE {
	  "instance(R,Ring)"
	  },
     SeeAlso => {instance}
     }