File: peek-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 (54 lines) | stat: -rw-r--r-- 1,055 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
--- status: TODO
--- author(s): 
--- notes: 

undocumented toList(set methods peek' - set{(peek', ZZ, Thing)})

doc ///
Node
  Key
    peek
  Headline
    examine contents of an object
  Usage
    peek o
  Inputs
    o:Thing
      any Macaulay2 object
  Outputs
    :Net
      laying out the internal contents of @TT "o"@ to depth 1, bypassing installed methods for displaying the object
  Description
    Text
      This function is used during debugging Macaulay2 programs to examine the internal structure of objects.
    Example
      set {1, 2, 3}
      peek oo
      new MutableHashTable from { a => 3, b => 44}
      peek oo
  SeeAlso
    peek'

Node
  Key
     peek'
    (peek', ZZ, Thing)
  Headline
    examine contents of an object
  Usage
    peek'(n, o)
  Inputs
    n:ZZ
    o:Thing
      any Macaulay2 object
  Outputs
    :Net
      laying out the contents of @TT "o"@, bypassing installed formatting and printing methods to depth @TT "n"@
  Description
    Example
      s = factor 112
      peek s
      peek'_2 s
  SeeAlso
    peek
///