File: net-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 (72 lines) | stat: -rw-r--r-- 1,650 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
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
--- status: TODO
--- author(s): 
--- notes: 

undocumented toList(set methods net - set{(net, Thing), (net, String)})

doc ///
Node
  Key
     net
    (net, Thing)
  Headline
    format for printing, as a net
  Usage
    net o
  Inputs
    x:Thing
  Outputs
    :Net
      obtained by formatting @TT "o"@ for printing
  Description
    Text
      This function is the primary function called upon by @TO "<<"@ to format expressions for printing.
      The default method provided by the system is to convert @TT "o"@ to an @TO "Expression"@ with
      @TO "expression"@ and then to convert that to a @TO Net@.

      A new method for formatting expressions of type @TT "T"@ may be installed as follows:
    Code
      EXAMPLE { PRE ////net T := x -> ...//// }
    Text
      The function provided by the user should return a @TO Net@ or a @TO String@.

      There are various such methods for formatting, but we don't document them separately.
  SeeAlso
    String
    Expression
    AfterPrint
    toString
    toExternalString
    expression

Node
  Key
    (net, String)
  Headline
    convert a string to a net
  Usage
    net s
  Inputs
    s:String
  Outputs
    :Net
      formed by stacking the lines of the string @TT "s"@ vertically
  Description
    Text
      Tab characters are converted to spaces, with a tab stop at every 8-th column.

      In the following examples we can use @TT "peek"@ to see the exact shape of the nets produced.
    Example
      net "line 1\nline 2\nline 3\n"
      peek oo
      net ""
      peek oo
      net "\n"
      peek oo
      net "\n\n\ta"
      peek oo
  SeeAlso
    peek
    stack
    unstack
///