File: toString-doc.m2

package info (click to toggle)
macaulay2 1.17.1%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 68,376 kB
  • sloc: cpp: 102,995; ansic: 10,040; javascript: 6,019; sh: 3,506; makefile: 3,426; lisp: 727; yacc: 590; perl: 369; xml: 177; python: 141; lex: 65; awk: 3
file content (81 lines) | stat: -rw-r--r-- 1,887 bytes parent folder | download
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
--- status: DRAFT
--- author(s): MES
--- notes: 

undocumented {
(toString,Sequence),
(toString,Array),
(toString,Package),
(toString,Resolution),
(toString,Command),
(toString,Matrix),
(toString,GeneralOrderedMonoid),
(toString,MutableMatrix),
(toString,Vector),
(toString,InfiniteNumber),
(toString,IndeterminateNumber),
(toString,Bag),
(toString,Manipulator),
(toString,VirtualTally),
(toString,Set),
(toString,ScriptedFunctor),
(toString,DocumentTag),
(toString,Ideal),
(toString,RingElement),
(toString,RingMap),
(toString,EngineRing),
(toString,IndexedVariable),
(toString,Module),
(toString,GaloisField),
(toString,GroebnerBasis),
(toString,Thing),
(toString,HashTable),
(toString,MutableHashTable),
(toString,Type),
(toString,BasicList),
(toString,MutableList),
(toString,Option),
(toString,Function),
(toString,FunctionBody),
(toString,Symbol),
(toString,Hypertext),
(toString,Net),
(toString,String),
(toString,QQ),
(toString,Dictionary),
(toString,CoherentSheaf),
(toString,Variety)
}

document { 
     Key => toString,
     Headline => "convert to a string",
     Usage => "toString x",
     Inputs => {
	  "x" => "any Macaulay2 object"
	  },
     Outputs => {
	  String => {"a string representation of ", TT "x"}
	  },
     "Sometimes the string representation is just the name.
     See also ", TO "toExternalString", " which will try to convert ", TT "x", "
     to a string that can be read back into the program later.",
     EXAMPLE {
	  "toString {1,4,a,f,212312,2.123243242}"
	  },
     "If a ring has a global name, then toString returns this name.",
     EXAMPLE {
	  "R = QQ[x_1..x_5];",
	  "toString R",
	  "toExternalString R",
	  "toString(QQ[a])"
	  },
     "Matrices and ring elements are linearized",
     EXAMPLE {
	  "toString (x_1^3-3/4*x_5*x_3)",
	  "toString vars R",
	  "toExternalString vars R"
	  },
     SeeAlso => {toExternalString, value}
     }