File: describe-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 (45 lines) | stat: -rw-r--r-- 1,035 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
37
38
39
40
41
42
43
44
45
--- status: moved Aug 2022
--- author(s):
--- notes:

doc ///
Node
  Key
     describe
    (describe, FractionField)
    (describe, GaloisField)
    (describe, Matrix)
    (describe, Module)
    (describe, Monoid)
    (describe, PolynomialRing)
    (describe, QuotientRing)
    (describe, RingMap)
    (describe, Thing)
    (describe, Vector)
  Headline
    real description
  Usage
    describe X
  Inputs
    X:Thing
  Outputs
    :Expression
  Description
    Text
      @TT "describe X"@ returns an @TT "Expression"@ containing the real description
      of @TT "X"@, bypassing the feature that causes certain types of things to acquire,
      for brevity, the names of global variables to which they are assigned.

      For example, it also displays the options used at creation of polynomial rings.
    Example
      R = ZZ/101[a,b,c_1,c_2];
      R
      describe R
      toString describe R
      toExternalString R
      QQ[x, dx, WeylAlgebra => { x => dx }]
      describe oo
  SeeAlso
    toString
    toExternalString
///