File: toExternalString-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 (76 lines) | stat: -rw-r--r-- 2,337 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
--- status: DRAFT
--- author(s): MES
--- notes: 

undocumented {
    (toExternalString, Nothing),
    (toExternalString, Ideal),
    (toExternalString, MonomialIdeal),
    (toExternalString, Boolean),
    (toExternalString, LATER),
    (toExternalString, Number),
    (toExternalString, Manipulator),
    (toExternalString, Module),
    (toExternalString, Sequence),
    (toExternalString, QuotientRing),
    (toExternalString, GaloisField),
    (toExternalString, Array),
    (toExternalString, Matrix),
    (toExternalString, GeneralOrderedMonoid),
    (toExternalString, Thing),
    (toExternalString, Function),
    (toExternalString, CC),
    (toExternalString, HashTable),
    (toExternalString, MutableHashTable),
    (toExternalString, Type),
    (toExternalString, BasicList),
    (toExternalString, MutableList),
    (toExternalString, Vector),
    (toExternalString, Option),
    (toExternalString, Symbol),
    (toExternalString, Command),
    (toExternalString,Constant),
    (toExternalString,RR),
    (toString,ComplexField),
    (toString,Constant),
    (toString,Expression),
    (toString,IndexedVariableTable),
    (toString,RealField),
    (toExternalString, Hypertext),
    (toExternalString, Keyword),
    (toExternalString, PolynomialRing),
    (toExternalString, Net),
    (toExternalString, String),
    (toExternalString,FractionField),
    (toExternalString,Variety)
    }     

document { 
     Key => toExternalString,
     Headline => "convert to a readable string",
     Usage => "toExternalString x",
     Inputs => {
	  "x" => "any Macaulay2 object"
	  },
     Outputs => {
	  String => {"a string representation of ", TT "x", ", which can be used, in conjunction with ", TO "value", ", to read the object back into the program later"}
	  },
     "See also ", TO "toString", " which simply converts ", TT "x", " to a string that can be displayed meaningfully.",     
     EXAMPLE {
	  "toString {1,4,a,f,212312,2.123243242}"
	  },
     EXAMPLE {
	  "R = QQ[x_1..x_5];",
	  "toExternalString R",
	  },
     "Matrices and ring elements are linearized",
     EXAMPLE {
	  "x_1^3-3/4*x_5*x_3",
	  "toExternalString oo",
	  "value oo"
	  },
     Caveat => "Not everything can be converted to a string in such a way that it can be read back into the program later.",
     SeeAlso => {toString, value}
     }