File: toExternalString-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 (35 lines) | stat: -rw-r--r-- 1,020 bytes parent folder | download | duplicates (4)
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
--- status: DRAFT
--- author(s): MES
--- notes: 

undocumented methods toExternalString

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}
     }