File: algotutor.1

package info (click to toggle)
algotutor 0.8.6-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 640 kB
  • sloc: perl: 2,563; makefile: 41; php: 24; sh: 1
file content (209 lines) | stat: -rw-r--r-- 8,723 bytes parent folder | download | duplicates (3)
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
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ALGOTUTOR 1"
.TH ALGOTUTOR 1 "2007-04-09" "perl v5.8.7" "User Contributed Perl Documentation"
.SH "NAME"
algotutor \- an interactive program for observing the intermediate steps 
of algorithms.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBalgotutor\fR [\fI\s-1OPTION\s0\fR] ... \fI\s-1DATA\s0\fR ...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
algotutor is an interactive program for observing the intermediate steps 
of algorithms. The target audience is computer science students and/or anyone 
who studies algorithms and/or data structures. One can create data files in 
plain text format (actually perl anonymous hashes, but one need not care) 
and let algotutor runs through some predefined algorithm. Then one can step 
backward and forward through the execution sequence of the algorithm at 
different levels of details. It requires perl\-Tk.
.PP
\&\fI\s-1DATA\s0\fR is the input data. For the dynamic programming algorithms such
as lcs and matc, please see the respective entries in the following
list; for other algorithms, it is the file name containing the
actual input data.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-a\fR \fI\s-1ALGO\s0\fR" 4
.IX Item "-a ALGO"
Runs the algorithm \s-1ALGO\s0. Currently \s-1ALGO\s0 can be one of:
.RS 4
.IP "\fBbst\fR operations on binary search trees" 4
.IX Item "bst operations on binary search trees"
.PD 0
.IP "\fBrbt\fR operations on red-black trees (\fIremove()\fR is not implemented yet)" 4
.IX Item "rbt operations on red-black trees (remove() is not implemented yet)"
.IP "\fBheap\fR operations on heaps \*(-- the remove operation on a heap always removes the top element regardless of the argument" 4
.IX Item "heap operations on heaps  the remove operation on a heap always removes the top element regardless of the argument"
.IP "\fBsbs\fR stack-based search on graphs, a variant of depth first search" 4
.IX Item "sbs stack-based search on graphs, a variant of depth first search"
.IP "\fBbfs\fR breadth first search on graphs" 4
.IX Item "bfs breadth first search on graphs"
.IP "\fBprim\fR Prim's minimal spanning tree on graphs" 4
.IX Item "prim Prim's minimal spanning tree on graphs"
.IP "\fBdijk\fR Dijkstra's single-source shortest path on graphs" 4
.IX Item "dijk Dijkstra's single-source shortest path on graphs"
.IP "\fBflwa\fR Floyd\-Warshall's all-pair shortest path on graphs (very, very slow)" 4
.IX Item "flwa Floyd-Warshall's all-pair shortest path on graphs (very, very slow)"
.IP "\fBdom\fR 2\-dimensional point domination" 4
.IX Item "dom 2-dimensional point domination"
.IP "\fBgraham\fR Graham's scan for convex hull" 4
.IX Item "graham Graham's scan for convex hull"
.ie n .IP "\fBlcs\fR longest common subsequence \*(-- it requires two strings as the command line arguments. For example, ""algotutor \-a lcs AGCTATACGATGACT GTCAGTATAGTCATATG""" 4
.el .IP "\fBlcs\fR longest common subsequence \*(-- it requires two strings as the command line arguments. For example, \f(CWalgotutor \-a lcs AGCTATACGATGACT GTCAGTATAGTCATATG\fR" 4
.IX Item "lcs longest common subsequence  it requires two strings as the command line arguments. For example, algotutor -a lcs AGCTATACGATGACT GTCAGTATAGTCATATG"
.ie n .IP "\fBmatc\fR optimal matrix chain multiplication \*(-- it requires an alternating sequence of integers and matrix names as the command line arguments. For example, ""algotutor \-a matc 32 A 35 B 24 C 30 D 36 E 25 F 40 G 34 H 35"" means finding the optimal multiplication sequence of the chain of matrices: A of size 32 by 35, B of size 35 by 24, ... H of size 34 by 35." 4
.el .IP "\fBmatc\fR optimal matrix chain multiplication \*(-- it requires an alternating sequence of integers and matrix names as the command line arguments. For example, \f(CWalgotutor \-a matc 32 A 35 B 24 C 30 D 36 E 25 F 40 G 34 H 35\fR means finding the optimal multiplication sequence of the chain of matrices: A of size 32 by 35, B of size 35 by 24, ... H of size 34 by 35." 4
.IX Item "matc optimal matrix chain multiplication  it requires an alternating sequence of integers and matrix names as the command line arguments. For example, algotutor -a matc 32 A 35 B 24 C 30 D 36 E 25 F 40 G 34 H 35 means finding the optimal multiplication sequence of the chain of matrices: A of size 32 by 35, B of size 35 by 24, ... H of size 34 by 35."
.RE
.RS 4
.RE
.IP "\fB\-s\fR \fI\s-1VERTEX\s0\fR" 4
.IX Item "-s VERTEX"
.PD
Use \s-1VERTEX\s0 as the starting vertex (for sbs, bfs, prim, and dijk)
.IP "\fB\-i\fR \fI\s-1STEP\s0\fR" 4
.IX Item "-i STEP"
Display step \s-1STEP\s0 as the initial image.
.IP "\fB\-d\fR \fI\s-1FILENAME\s0\fR" 4
.IX Item "-d FILENAME"
Dump the picture into \s-1FILENAME\s0 as a ps file and exit immediately
without going into interactive mode.
.SH "LICENSE"
.IX Header "LICENSE"
This code is distributed under the \s-1GNU\s0 General Public License
.SH "AUTHOR"
.IX Header "AUTHOR"
\&\fBChao-Kuei Hung\fR ckhung \s-1AT\s0 ofset \s-1DOT\s0 org
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Please see /usr/share/doc/algotutor/doc/ for examples and
the full set of documentations.