aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user/gra_summ
blob: d0ca1039fafe99a27eba76b4ad6880c11a28236b (plain) (blame)
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
@Section
   @Title { Summary }
   @Tag { grsummary }
@Begin
@PP
The options to the @Code "@Graph" symbol, their default values, and
graphs. @RawIndex { graphs (statistical) }
graphs.summary @SubIndex { summary of all options }
their possible values are:
@ID -2.5px @Break -1p @Font @Tab
   hmargin { 0.15c }
   @Fmta { @Col @Code { "    "A } ! @Col @Code "{" ! @Col @Code B !
	   @Col @Code "}" ! @Col ! @Col ! @Col C }
   @Fmtb { @Col @Code A ! @Col ! @Col ! @Col ! @Col ! @Col ! @Col }
{
@Rowb
    A { "@Graph" }
@Rowa
    A { style }
    B { frame }
    C { {@Code frame}, {@Code axes}, or {@Code none} }
@Rowa
    A { width }
    B { 6.0c }
    C { any @I distance }
@Rowa
    A { height }
    B { 4.0c }
    C { any @I distance }
@Rowa
    A { xextra }
    B { 0.5c }
    C { any @I distance ({@Code axes} and {@Code none} default is {@Code "0c"}) }
@Rowa
    A { yextra }
    B { 0.5c }
    C { any @I distance ({@Code axes} and {@Code none} default is {@Code "0c"}) }
@Rowa
    A { xdecreasing }
    B { no }
    C { @Code yes or @Code no }
@Rowa
    A { ydecreasing }
    B { no }
    C { @Code yes or @Code no }
@Rowa
    A { leftcaption }
    B { }
    C { any Lout object }
@Rowa
    A { rightcaption }
    B { }
    C { any Lout object }
@Rowa
    A { abovecaption }
    B { }
    C { any Lout object }
@Rowa
    A { belowcaption }
    B { }
    C { any Lout object }
@Rowa
    A { leftgap }
    B { 1.5c }
    C { any @I distance }
@Rowa
    A { rightgap }
    B { 0.5c }
    C { any @I distance }
@Rowa
    A { abovegap }
    B { 0.5c }
    C { any @I distance }
@Rowa
    A { belowgap }
    B { 0.5c }
    C { any @I distance }
@Rowa
    A { hidecaptions }
    B { yes }
    C { @Code yes or @Code no }
@Rowa
    A { xorigin }
    B { none }
    C { {@Code none} or any @I number }
@Rowa
    A { yorigin }
    B { none }
    C { {@Code none} or any @I number }
@Rowa
    A { xlog }
    B { none }
    C { {@Code none} or any @I number greater than 1 }
@Rowa
    A { ylog }
    B { none }
    C { {@Code none} or any @I number greater than 1 }
@Rowa
    A { xmin }
    B { none }
    C { @Code none or any {@I number} }
@Rowa
    A { xmax }
    B { none }
    C { @Code none or any {@I number} }
@Rowa
    A { ymin }
    B { none }
    C { @Code none or any {@I number} }
@Rowa
    A { ymax }
    B { none }
    C { @Code none or any {@I number} }
@Rowa
    A { xticksep }
    B { none }
    C { {@Code none} or any @I number greater than 0 }
@Rowa
    A { yticksep }
    B { none }
    C { {@Code none} or any @I number greater than 0 }
@Rowa
    A { rticksep }
    B { none }
    C { {@Code none} or any @I number greater than 0 }
@Rowa
    A { xticks }
    B { auto  }
    C { @I sequence (of numbers and strings), or @Code auto meaning
automatic }
@Rowa
    A { yticks }
    B { auto }
    C { @I sequence (of numbers and strings), or @Code auto meaning
automatic }
@Rowa
    A { rticks }
    B { }
    C { @I sequence (of numbers and strings), or @Code auto meaning
automatic }
@Rowa
    A { xticklength }
    B { 0.5f }
    C { any @I distance }
@Rowa
    A { yticklength }
    B { 0.5f }
    C { any @I distance }
@Rowa
    A { rticklength }
    B { 0.5f }
    C { any @I distance }
@Rowa
    A { objects }
    B { }
    C { sequence of {@Code "@CTR"}, {@Code "@NW"}, {@Code "@SW"}, {@Code "@SE"},
{@Code "@NE"}, {@Code "@N"}, {@Code "@W"}, {@Code "@S"}, {@Code "@E"} symbols }
@Rowa
    A { points }
    B { none }
    C { {@Code none}, {@Code plus}, {@Code cross}, {@Code square},
{@Code filledsquare}, {@Code diamond}, {@Code filleddiamond},
{@Code circle}, {@Code filledcircle}, {@Code triangle}, {@Code filledtriangle} }
@Rowa
    A { pairs }
    B { none }
    C { {@Code none}, {@Code solid}, {@Code dashed}, {@Code dotted},
{@Code dotdashed}, {@Code dotdotdashed}, {@Code dotdotdotdashed}, 
{@Code yhisto}, {@Code xhisto}, {@Code filledyhisto}, {@Code filledxhisto},
{@Code surfaceyhisto}, {@Code surfacexhisto} }
@Rowa
    A { "colour/color" }
    B { none }
    C { {@Code none} or any colour from Section {@NumberOf colour}}
@Rowa
    A { paint }
    B { no }
    C { {@Code no} or {@Code yes} }
@Rowa
    A { texture }
    B { solid }
    C { any texture from Section {@NumberOf textures} }
@Rowa
    A { dataformat }
    B { xandy }
    C { {@Code xandy}, {@Code yonly}, {@Code xonly}, {@Code swapxandy} }
@Rowa
    A { dashlength }
    B { 0.2f }
    C { any @I distance }
@Rowa
    A { linewidth }
    B { 0.5p }
    C { any @I distance }
@Rowa
    A { symbolsize }
    B { 0.15f }
    C { any @I distance }
}
@I Number means an ordinary decimal number; @I distance means a number
with a unit of measurement (Section {@NumberOf objects}), such as
@Code { 5c } or {@Code 0.5f}.  In general, numbers denote x or y
values while distances denote lengths on the printed result.
@PP
The minimum plottable x value is the minimum of all the x data,
{@Code xticks}, {@Code xorigin}, {@Code xmin}, and {@Code xmax} whenever
these are not {@Code none}.  If @Code xticks is {@Code none}, this
minimum may be reduced further to a `round' number.  The maximum plottable
x value is the maximum of the same values, and it may be increased further
if {@Code xticks} is {@Code none}.  Similar remarks apply to y values.
@PP
The value of the @Code "objects" option is a sequence of zero or more of
the following:
@ID @Tab
    vmargin { 0.5vx }
    @Fmta { @Col A ! @Col { @Code "at {" @I expression @I expression
@Code "}" } ! @Col @I object }
{
@Rowa A { @Code "@CTR" }
@Rowa A { @Code "@NW"  }
@Rowa A { @Code "@SW"  }
@Rowa A { @Code "@SE"  }
@Rowa A { @Code "@NE"  }
@Rowa A { @Code "@N"   }
@Rowa A { @Code "@W"   }
@Rowa A { @Code "@S"   }
@Rowa A { @Code "@E"   }
}
where @I object is an arbitrary Lout object.  Each of these nine symbols
also has a @Code "margin" option whose value may be any non-negative
distance, with default value {@Code "0.3f"}.
@PP
The options to the @Code "@Data" symbol, their default values, and
their possible values are:
@ID 0.85vx @Break @Tab
   hmargin { 0.15c }
   @Fmta { @Col @Code { "    "A } ! @Col @Code "{" ! @Col @I inherited !
	   @Col @Code "}" ! @Col ! @Col ! @Col C }
   @Fmtb { @Col A ! @Col ! @Col ! @Col ! @Col ! @Col ! @Col }
{
@Rowb
    A { @Code "@Data" }
@Rowa
    A { points }
    C { {@Code none}, {@Code plus}, {@Code cross}, {@Code square},
{@Code filledsquare}, {@Code diamond}, {@Code filleddiamond},
{@Code circle}, {@Code filledcircle},
{@Code triangle}, {@Code filledtriangle} }
@Rowa
    A { pairs }
    C { {@Code none}, {@Code solid}, {@Code dashed}, {@Code dotted},
{@Code dotdashed}, {@Code dotdotdashed}, {@Code dotdotdotdashed}, 
{@Code yhisto}, {@Code xhisto}, {@Code filledyhisto}, {@Code filledxhisto},
{@Code surfaceyhisto}, {@Code surfacexhisto} }
@Rowa
    A { "colour/color" }
    C { {@Code none}, or any colour name from Section {@NumberOf colour} }
@Rowa
    A { paint }
    C { {@Code no} or {@Code yes} }
@Rowa
    A { texture }
    C { Any texture from Section {@NumberOf textures} }
@Rowa
    A { dataformat }
    C { {@Code xandy}, {@Code yonly}, {@Code xonly} }
@Rowa
    A { dashlength }
    C { any @I distance }
@Rowa
    A { linewidth }
    C { any @I distance }
@Rowa
    A { symbolsize }
    C { any @I distance }
@Rowb
    A { @Code "{" @I sequence @Code "}" }
    C { any @I sequence }
}
@I Inherited means that the default value is taken from the
@Code "@Graph" option with the same name.
@PP
The right parameter of @Code "@Data" contains a @I sequence of zero
or more {@I expressions}.  The {@Code xticks}, {@Code yticks}, and
{@Code rticks} options also are sequences, which may contain @Code "@"
and labels as well as expressions.  An @I expression is any of the
following (operators are shown in decreasing precedence order, with
the precedence, if relevant, at right):
@ID @Tab
    vmargin { 0.5vx }
    @Fmta { @Col A ! @Col ! @Col B }
{
@Rowa
    A { @I number }
@Rowa
    A { @Code x   (within @Code xloop only) }
@Rowa
    A { @Code y   (within @Code yloop only) }
@Rowa
    A { @Code z   (within @Code zloop only) }
@Rowa
    A { @Code pi }
@Rowa
    A { @Code e }
@Rowa
    A { @Code "{" @I expression @Code "}" }
@Rowa
    A { @Code "sqrt" @I expression }
    B { 40 }
@Rowa
    A { @Code "abs" @I expression }
    B { 40 }
@Rowa
    A { @Code "ceiling" @I expression }
    B { 40 }
@Rowa
    A { @Code "floor" @I expression }
    B { 40 }
@Rowa
    A { @Code "truncate" @I expression }
    B { 40 }
@Rowa
    A { @Code "round" @I expression }
    B { 40 }
@Rowa
    A { @Code "cos" @I expression }
    B { 40 }
@Rowa
    A { @Code "sin" @I expression }
    B { 40 }
@Rowa
    A { @I expression @Code "atan" @I expression }
    B { 39 }
@Rowa
    A { @I expression @Code "exp" @I expression }
    B { 38 }
@Rowa
    A { @I expression @Code "log" @I expression }
    B { 37 }
@Rowa
    A { @I expression @Code "rand" @I expression }
    B { 36 }
@Rowa
    A { @I expression @Eq { non * } @I expression }
    B { 35 }
@Rowa
    A { @I expression @Code "/" @I expression }
    B { 34 }
@Rowa
    A { @I expression @Code "idiv" @I expression }
    B { 34 }
@Rowa
    A { @I expression @Code "mod" @I expression }
    B { 34 }
@Rowa
    A { @I expression @Eq { non - } @I expression }
    B { 33 }
@Rowa
    A { @Eq { non - } @I expression }
    B { 33 }
@Rowa
    A { @I expression @Code "+" @I expression }
    B { 32 }
@Rowa
    A { @Code "+" @I expression }
    B { 32 }
@Rowa
   A { @Code "if cond {" @I boolean @Code "} then {" @I expression
@Code "} else {" @I expression @Code "}" }
}
A @Eq { non - } immediately followed by a digit or decimal point is
always taken to be a minus sign, never a subtraction.  The left
parameter of @Code "exp" and @Code "log" is the base of the
exponentiation and logarithm respectively; @Code "idiv" is integer
division; and @Code "rand" returns a uniform random integer lying between
its two parameters (inclusive).  Now a @I sequence is zero or more of
the following:
@ID @Tab
    vmargin { 0.5vx }
    @Fmta { @Col A }
{
@Rowa
   A { 2c @Wide "@" (within {@Code xticks}, {@Code yticks}, and {@Code rticks} only) }
@Rowa
   A { 2c @Wide { ({@I label}) } (within {@Code xticks}, {@Code yticks}, and {@Code rticks} only) }
@Rowa
   A { @I expression }
@Rowa
   A { @Code "xloop from {" @I expression @Code "} to {" @I expression
@Code "} by {" @I expression @Code "} do {" @I sequence @Code "}" }
@Rowa
   A { @Code "yloop from {" @I expression @Code "} to {" @I expression
@Code "} by {" @I expression @Code "} do {" @I sequence @Code "}" }
@Rowa
   A { @Code "zloop from {" @I expression @Code "} to {" @I expression
@Code "} by {" @I expression @Code "} do {" @I sequence @Code "}" }
@Rowa
   A { @Code "if cond {" @I boolean @Code "} then {" @I sequence
@Code "} else {" @I sequence @Code "}" }
}
The @Code "by" part of the loop symbols is optional with default
value 1; the @Code "else" part of @Code "if" is optional with
default value equal to the empty sequence.  A @I boolean is any one of
the following things, again shown in decreasing precedence order, with
the precedence at right:
@ID @Tab
    vmargin { 0.5vx }
    @Fmta { @Col A ! @Col ! @Col B }
{
@Rowa
    A { @Code true }
@Rowa
    A { @Code false }
@Rowa
    A { @Code "{" @I boolean @Code "}" }
@Rowa
    A { @I expression @Code = @I expression }
    B { 30 }
@Rowa
    A { @I expression @Code != @I expression }
    B { 30 }
@Rowa
    A { @I expression @Code < @I expression }
    B { 30 }
@Rowa
    A { @I expression @Code <= @I expression }
    B { 30 }
@Rowa
    A { @I expression @Code > @I expression }
    B { 30 }
@Rowa
    A { @I expression @Code >= @I expression }
    B { 30 }
@Rowa
    A { @Code not @I boolean }
    B { 25 }
@Rowa
    A { @I boolean @Code and @I boolean }
    B { 24 }
@Rowa
    A { @I boolean @Code xor @I boolean }
    B { 23 }
@Rowa
    A { @I boolean @Code or @I boolean }
    B { 22 }
@Rowa
   A { @Code "if cond {" @I boolean @Code "} then {" @I boolean
@Code "} else {" @I boolean @Code "}" }
}
@End @Section