File: net-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 (159 lines) | stat: -rw-r--r-- 3,941 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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
--- status: TODO
--- author(s): 
--- notes: 

undocumented {
	  (net, Adjacent),
	  (net, Array),
	  (net, Bag),
	  (net, BasicList),
	  (net, BinaryOperation),
	  (net, Boolean),
	  (net, CC),
	  (net, CODE),
	  (net, ChainComplex),
	  (net, ChainComplexMap),
	  (net, CoherentSheaf),
	  (net, Command),
	  (net, Constant),
	  (net, Database),
	  (net, Divide),
	  (net, DocumentTag),
	  (net, Equation),
	  (net, File),
	  (net, FilePosition),
	  (net, Function),
	  (net, FunctionApplication),
	  (net, FunctionBody),
	  (net, GaloisField),
	  (net, GeneralOrderedMonoid),
	  (net, GradedModule),
	  (net, GradedModuleMap),
	  (net, GroebnerBasis),
	  (net, HEADER1),
	  (net, HEADER2),
	  (net, HEADER3),
	  (net, HR),
	  (net, HREF),
	  (net, HashTable),
	  (net, Holder),
	  (net, IMG),
	  (net, Ideal),
	  (net, IndeterminateNumber),
	  (net, IndexedVariable),
	  (net, InexactField),
	  (net, InfiniteNumber),
	  (net, List),
	  (net, MENU),
	  (net, Manipulator),
	  (net, Hypertext),
	  (net, Matrix),
	  (net, MatrixExpression),
	  (net, Minus),
	  (net, Module),
	  (net, MultigradedBettiTally),
	  (net, MutableHashTable),
	  (net, MutableList),
	  (net, MutableMatrix),
	  (net, Net),
	  (net, NonAssociativeProduct),
	  (net, Nothing),
	  (net, NumberedVerticalList),
	  (net, Option),
	  (net, PRE),
	  (net, Package),
	  (net, Power),
	  (net, Product),
	  (net, ProjectiveHilbertPolynomial),
	  (net, QQ),
	  (net, Parenthesize),
	  (net, Descent),
	  (net, CacheFunction),
	  (net, IndexedVariableTable),
	  (net, RR),
	  (net, RingElement),
	  (net, RingMap),
	  (net, RowExpression),
	  (net, SUB),
	  (net, SUP),
	  (net, ScriptedFunctor),
	  (net, Sequence),
	  (net, Set),
	  (net, SheafOfRings),
	  (net, SparseMonomialVectorExpression),
	  (net, SparseVectorExpression),
	  (net, Subscript),
	  (net, Sum),
	  (net, SumOfTwists),
	  (net, Superscript),
	  (net, Symbol),
	  (net, TABLE),
	  (net, TITLE),
	  (net, TO),
	  (net, TO2),
	  (net, TOH),
	  (net, TT),
	  (net, Table),
	  (net, VirtualTally),
	  (net, Thing),
	  (net, Time),
	  (net, Type),
	  (net, UL),
	  (net, Variety),
	  (net, Vector),
	  (net, VerticalList),
	  (net, ZZ),
	  (net, BettiTally),
	  (net, COMMENT),
	  (net, HypertextContainer),
	  (net, EngineRing),
	  (net, MapExpression),
	  (net, MatrixDegreeExpression),
	  (net, SheafExpression),
	  (net, VectorExpression)
	  }

document {
     Key => (net, String),
     Headline => "convert a string to a net",
     Usage => "net s",
     Inputs => { "s" },
     Outputs => { { "the net formed by stacking the lines of the string ", TT "x", " vertically"} },
     PARA {
	  "Tab characters are converted to spaces, with a tab stop at every 8-th column."
	  },
     PARA {
     	  "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}
     }

document {
     Key => net, 
     Headline => "format for printing, as a net",
     Usage => "net x",
     Inputs => { "x" },
     Outputs => { { "a net obtained by formatting ", TT "x", " for printing" } },
     PARA{},
     "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 "x", " to an ", TO "Expression", " with 
     ", TO "expression", " and then to convert that to a net.",
     PARA{},
     "A new method for formatting expressions of class ", TT "X", " may be
     installed by the user with code of the form ", TT "net X := x -> ...", ".
     The function provided by the user should return a net or a string.",
     PARA{},
     "There are various such methods for formatting, but we don't document
     them separately."
     }