projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Graph::Traversal.3
CommitLineData
86530b38
AT		 1.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "Graph::Traversal 3"
132.TH Graph::Traversal 3 "2004-04-04" "perl v5.8.0" "User Contributed Perl Documentation"
133.SH "NAME"
134Graph::Traversal \- graph traversal
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 1
138\& use Graph::Traversal;
139.Ve
140.SH "DESCRIPTION"
141.IX Header "DESCRIPTION"
142.IP "new" 4
143.IX Item "new"
144.Vb 1
145\& $s = Graph::Traversal->new($G, %param)
146.Ve
147.Sp
148Returns a new graph search object for the graph \f(CW$G\fR
149and the parameters \f(CW%param\fR.
150.Sp
151Usually not used directly but instead via frontends like
152Graph::DFS for depth-first searching and Graph::BFS for
153breadth-first searching:
154.Sp
155.Vb 2
156\& $dfs = Graph::DFS->new($G, %param)
157\& $bfs = Graph::BFS->new($G, %param)
158.Ve
159.Sp
160\&\fI%param documentation to be written\fR
161.IP "reset" 4
162.IX Item "reset"
163.Vb 1
164\& $S->reset
165.Ve
166.Sp
167Resets a graph search object \f(CW$S\fR to its initial state.
168.IP "next_preorder" 4
169.IX Item "next_preorder"
170.Vb 1
171\& $v = $s->next_preorder
172.Ve
173.Sp
174Returns the next vertex in preorder of the graph
175encapsulated within the search object \f(CW$s\fR.
176.IP "next_postorder" 4
177.IX Item "next_postorder"
178.Vb 1
179\& $v = $S->next_postorder
180.Ve
181.Sp
182Returns the next vertex in postorder of the graph
183encapsulated within the search object \f(CW$S\fR.
184.IP "next_edge" 4
185.IX Item "next_edge"
186.Vb 1
187\& ($u, $v) = $s->next_edge
188.Ve
189.Sp
190Returns the vertices of the next edge of the graph
191encapsulated within the search object \f(CW$s\fR.
192.IP "preorder" 4
193.IX Item "preorder"
194.Vb 1
195\& @V = $S->preorder
196.Ve
197.Sp
198Returns all the vertices in preorder of the graph
199encapsulated within the search object \f(CW$S\fR.
200.IP "postorder" 4
201.IX Item "postorder"
202.Vb 1
203\& @V = $S->postorder
204.Ve
205.Sp
206Returns all the vertices in postorder of the graph
207encapsulated within the search object \f(CW$S\fR.
208.IP "edges" 4
209.IX Item "edges"
210.Vb 1
211\& @V = $S->edges
212.Ve
213.Sp
214Returns all the edges of the graph
215encapsulated within the search object \f(CW$S\fR.
216.IP "roots" 4
217.IX Item "roots"
218.Vb 1
219\& @R = $S->roots
220.Ve
221.Sp
222Returns all the root vertices of the trees of
223the graph encapsulated within the search object \f(CW$S\fR.
224\&\*(L"The root vertices\*(R" is ambiguous: what really happens
225is that either the roots from the previous search made
226on the \f(CW$s\fR are returned; or a preorder search is done
227and the roots of this search are returned.
228.IP "_vertex_roots" 4
229.IX Item "_vertex_roots"
230.Vb 1
231\& %R = $S->_vertex_roots
232.Ve
233.Sp
234Returns as a hash of ($vertex, index) pairs where index is an index
235into the vertex_root list of the traversal.
236.Sp
237\&\*(L"The root vertices\*(R" is ambiguous; see the documentation of the \fIroots()\fR
238method for more details.
239.Sp
240(This is the old \fIvertex_roots()\fR.)
241.IP "vertex_roots" 4
242.IX Item "vertex_roots"
243.Vb 1
244\& %R = $S->vertex_roots
245.Ve
246.Sp
247Returns as a hash of ($vertex, \f(CW$root\fR) pairs all the vertices
248and the root vertices of their search trees of the graph
249encapsulated within the search object \f(CW$S\fR.
250.Sp
251\&\*(L"The root vertices\*(R" is ambiguous; see the documentation of
252the \fIroots()\fR method for more details.
253.Sp
254(See also \fI_vertex_roots()\fR).
255.SH "COPYRIGHT"
256.IX Header "COPYRIGHT"
257Copyright 1999, O'Reilly & Associates.
258.PP
259This code is distributed under the same copyright terms as Perl itself.
Full OpenSPARC design & verification tarball including full HDL.