annotate mayachemtools/docs/modules/man3/PathsTraversal.3 @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 .\" Standard preamble:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 .\" ========================================================================
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 .de Sp \" Vertical space (when we can't use .PP)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 .if t .sp .5v
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 .if n .sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 .de Vb \" Begin verbatim text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 .ft CW
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 .nf
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 .ne \\$1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 .de Ve \" End verbatim text
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 .ft R
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 .fi
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 .\" Set up some character translations and predefined strings. \*(-- will
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 .\" nothing in troff, for use with C<>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 .tr \(*W-
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 .ie n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 . ds -- \(*W-
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 . ds PI pi
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 . ds L" ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 . ds R" ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 . ds C` ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 . ds C' ""
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 'br\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 .el\{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 . ds -- \|\(em\|
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 . ds PI \(*p
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 . ds L" ``
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 . ds R" ''
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 'br\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 .ie \n(.g .ds Aq \(aq
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 .el .ds Aq '
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 .\" If the F register is turned on, we'll generate index entries on stderr for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 .\" output yourself in some meaningful fashion.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 .ie \nF \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 . de IX
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 . tm Index:\\$1\t\\n%\t"\\$2"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 . nr % 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 . rr F
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 .el \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 . de IX
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 ..
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 . \" fudge factors for nroff and troff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 .if n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 . ds #H 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 . ds #V .8m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 . ds #F .3m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 . ds #[ \f1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 . ds #] \fP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 .if t \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 . ds #V .6m
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 . ds #F 0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 . ds #[ \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 . ds #] \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 . \" simple accents for nroff and troff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 .if n \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 . ds ' \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 . ds ` \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 . ds ^ \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 . ds , \&
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 . ds ~ ~
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 . ds /
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 .if t \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 . \" troff and (daisy-wheel) nroff accents
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 .ds ae a\h'-(\w'a'u*4/10)'e
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 .ds Ae A\h'-(\w'A'u*4/10)'E
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 . \" corrections for vroff
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 . \" for low resolution devices (crt and lpr)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 .if \n(.H>23 .if \n(.V>19 \
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 \{\
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 . ds : e
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 . ds 8 ss
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 . ds o a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 . ds d- d\h'-1'\(ga
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 . ds D- D\h'-1'\(hy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 . ds th \o'bp'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 . ds Th \o'LP'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 . ds ae ae
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 . ds Ae AE
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 .\}
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 .rm #[ #] #H #V #F C
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 .\" ========================================================================
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 .\"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 .IX Title "PATHSTRAVERSAL 1"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 .TH PATHSTRAVERSAL 1 "2015-03-29" "perl v5.14.2" "MayaChemTools"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 .\" way too many mistakes in technical documents.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 .if n .ad l
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 .nh
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 .SH "NAME"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 PathsTraversal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 .SH "SYNOPSIS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 .IX Header "SYNOPSIS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 use Graph::PathsTraversal;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 use Graph::PathsTraversal qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 .SH "DESCRIPTION"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 .IX Header "DESCRIPTION"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 \&\fBPathsTraversal\fR class provides the following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 new, Copy, GetConnectedComponentsVertices, GetPaths, GetVertices,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 GetVerticesDepth, GetVerticesNeighborhoods,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 GetVerticesNeighborhoodsWithSuccessors, GetVerticesPredecessors, GetVerticesRoots,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 PerformAllPathsSearch, PerformAllPathsSearchWithLength,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 PerformAllPathsSearchWithLengthUpto, PerformBreadthFirstSearch,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 PerformBreadthFirstSearchWithLimit, PerformDepthFirstSearch,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 PerformDepthFirstSearchWithLimit, PerformNeighborhoodVerticesSearch,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 PerformNeighborhoodVerticesSearchWithRadiusUpto,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 PerformNeighborhoodVerticesSearchWithSuccessors,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 PerformNeighborhoodVerticesSearchWithSuccessorsAndRadiusUpto, PerformPathsSearch,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 PerformPathsSearchBetween, PerformPathsSearchWithLength,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 PerformPathsSearchWithLengthUpto, StringifyPaths, StringifyPathsTraversal,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 StringifyVerticesDepth, StringifyVerticesNeighborhoods,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 StringifyVerticesNeighborhoodsWithSuccessors, StringifyVerticesPredecessors,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 StringifyVerticesRoots, StringifyVerticesSuccessors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 .SS "\s-1METHODS\s0"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 .IX Subsection "METHODS"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 .IP "\fBnew\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 .IX Item "new"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 \& $PathsTraversal = new Graph::PathsTraversal($Graph);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 Using specified \fIGraph\fR, \fBnew\fR method creates a new \fBPathsTraversal\fR object and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 newly created \fBPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 .IP "\fBCopy\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 .IX Item "Copy"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 \& $PathsTraversal = $PathsTraversal\->Copy();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 Copies \fIPathsTraversal\fR and its associated data using \fBStorable::dclone\fR and returns a new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 \&\fBPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 .IP "\fBGetConnectedComponentsVertices\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 .IX Item "GetConnectedComponentsVertices"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 \& @Components = $PathsTraversal\->GetConnectedComponentsVertices();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 \& $NumOfComponents = $PathsTraversal\->GetConnectedComponentsVertices();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 Returns an array of \fBComponents\fR containing references to arrays of vertex IDs corresponding
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 to connected components of graph after a search. In scalar context, the number of connected
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 components is returned.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 Connected \fBComponents\fR is sorted in descending order of number of vertices in each
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 connected component.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 .IP "\fBGetPaths\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 .IX Item "GetPaths"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 \& @Paths = $PathsTraversal\->GetPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 \& $NumOfPaths = $PathsTraversal\->GetPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 Returns an array of \fBPaths\fR containing references to arrays of vertex IDs corresponding to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 to paths traversed in a graph after a search. In scalar context, number of paths is returned.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 \&\fBPaths\fR array is sorted in ascending order of path lengths.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 .IP "\fBGetVertices\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 .IX Item "GetVertices"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 \& @Vertices = $PathsTraversal\->GetVertices();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 \& $NumOfVertices = $PathsTraversal\->GetVertices();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 Returns an array containing an ordered list of vertex IDs traversed during a search. In
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 scalar context, the number of vertices is returned.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 .IP "\fBGetVerticesDepth\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 .IX Item "GetVerticesDepth"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 \& %VerticesDepth = $PathsTraversal\->GetVerticesDepth();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 Returns a hash \fIVerticesDepth\fR containing vertex \s-1ID\s0 and depth from root vertex as a key and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 value pair for all vertices traversed during a search.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 .IP "\fBGetVerticesNeighborhoods\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 .IX Item "GetVerticesNeighborhoods"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 .Vb 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 \& @VerticesNeighborhoods =
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 \& $PathsTraversal\->GetVerticesNeighborhoods();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 \& $NumOfVerticesNeighborhoods =
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 \& $PathsTraversal\->GetVerticesNeighborhoods();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 Returns an array \fIVerticesNeighborhoods\fR containing references to arrays corresponding
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 to vertices collected at various neighborhood radii around a specified vertex during a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 neighborhood search. In scalar context, the number of neighborhoods is returned.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 .IP "\fBGetVerticesNeighborhoodsWithSuccessors\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 .IX Item "GetVerticesNeighborhoodsWithSuccessors"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 .Vb 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 \& @VerticesNeighborhoodsWithSucceessors =
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233 \& $PathsTraversal\->GetVerticesNeighborhoodsWithSuccessors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 \& $NumOfVerticesNeighborhoodsWithSucceessors =
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 \& $PathsTraversal\->GetVerticesNeighborhoodsWithSuccessors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 Returns an array \fIVerticesNeighborhoodsWithSucceessors\fR containing references to arrays
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 with first value corresponding to vertex IDs corresponding to a vertex at a specific neighborhood
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 radius level and second value a reference to an arraty containing its successors.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241 .IP "\fBGetVerticesPredecessors\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 .IX Item "GetVerticesPredecessors"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 \& %VerticesPredecessors = $PathsTraversal\->GetVerticesPredecessors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 Returns a hash \fIVerticesPredecessors\fR containing vertex \s-1ID\s0 and predecessor vertex \s-1ID\s0 as key
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 and value pair for all vertices traversed during a search.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 .IP "\fBGetVerticesRoots\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250 .IX Item "GetVerticesRoots"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252 \& %VerticesRoots = $PathsTraversal\->GetVerticesRoots();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255 Returns a hash \fIVerticesPredecessors\fR containing vertex \s-1ID\s0 and root vertex \s-1ID\s0 as a key
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 and value pair for all vertices traversed during a search.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 .IP "\fBPerformAllPathsSearch\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258 .IX Item "PerformAllPathsSearch"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 \& $PathsTraversal\->PerformAllPathsSearch($StartVertexID, [$AllowCycles]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 Searches all paths starting from a \fIStartVertexID\fR with sharing of edges in paths traversed and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 By default, cycles are included in paths. A path containing a cycle is terminated at a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267 completing the cycle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 .IP "\fBPerformAllPathsSearchWithLength\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 .IX Item "PerformAllPathsSearchWithLength"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 \& $PathsTraversal\->PerformAllPathsSearchWithLength($StartVertexID,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 \& $Length, [$AllowCycles]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275 Searches all paths starting from \fIStartVertexID\fR of specific \fILength\fR with sharing of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 edges in paths traversed and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 By default, cycles are included in paths. A path containing a cycle is terminated at a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279 completing the cycle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 .IP "\fBPerformAllPathsSearchWithLengthUpto\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281 .IX Item "PerformAllPathsSearchWithLengthUpto"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283 \& $PathsTraversal\->PerformAllPathsSearchWithLengthUpto($StartVertexID,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 \& $Length, [$AllowCycles]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287 Searches all paths starting from \fIStartVertexID\fR of length upto a \fILength\fR with sharing of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 edges in paths traversed and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 By default, cycles are included in paths. A path containing a cycle is terminated at a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291 completing the cycle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 .IP "\fBPerformBreadthFirstSearch\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 .IX Item "PerformBreadthFirstSearch"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295 \& $PathsTraversal\->PerformBreadthFirstSearch();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 Performs Breadth First Search (\s-1BFS\s0) and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299 .IP "\fBPerformBreadthFirstSearchWithLimit\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 .IX Item "PerformBreadthFirstSearchWithLimit"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 \& $PathsTraversal\->PerformBreadthFirstSearchWithLimit($DepthLimit,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303 \& [$RootVertexID]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306 Performs \s-1BFS\s0 with depth up to \fIDepthLimit\fR starting at \fIRootVertexID\fR and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 \&\fIPathsTraversal\fR. By default, root vertex \s-1ID\s0 corresponds to an arbitrary vertex.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308 .IP "\fBPerformDepthFirstSearch\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 .IX Item "PerformDepthFirstSearch"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 \& $Return = $PathsTraversal\->PerformDepthFirstSearch();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314 Performs Depth First Search (\s-1DFS\s0) and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315 .IP "\fBPerformDepthFirstSearchWithLimit\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316 .IX Item "PerformDepthFirstSearchWithLimit"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318 \& $PathsTraversal\->PerformDepthFirstSearchWithLimit($DepthLimit,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319 \& [$RootVertexID]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322 Performs \s-1DFS\s0 with depth up to \fIDepthLimit\fR starting at \fIRootVertexID\fR and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323 \&\fIPathsTraversal\fR. By default, root vertex \s-1ID\s0 corresponds to an arbitrary vertex.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 .IP "\fBPerformNeighborhoodVerticesSearch\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325 .IX Item "PerformNeighborhoodVerticesSearch"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327 \& $PathsTraversal\->PerformNeighborhoodVerticesSearch($StartVertexID);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330 Searches vertices around \fIStartVertexID\fR at all neighborhood radii and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332 .IP "\fBPerformNeighborhoodVerticesSearchWithRadiusUpto\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333 .IX Item "PerformNeighborhoodVerticesSearchWithRadiusUpto"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335 \& $PathsTraversal\->PerformNeighborhoodVerticesSearchWithRadiusUpto(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 \& $StartVertexID, $Radius);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339 Searches vertices around \fIStartVertexID\fR with neighborhood radius up to \fIRadius\fR and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 .IP "\fBPerformNeighborhoodVerticesSearchWithSuccessors\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342 .IX Item "PerformNeighborhoodVerticesSearchWithSuccessors"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344 \& $PathsTraversal\->PerformNeighborhoodVerticesSearchWithSuccessors(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 \& $StartVertexID);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348 Searches vertices around \fIStartVertexID\fR at all neighborhood radii along with identification of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 successor vertices for each vertex found during the traversal and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
350 .IP "\fBPerformNeighborhoodVerticesSearchWithSuccessorsAndRadiusUpto\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
351 .IX Item "PerformNeighborhoodVerticesSearchWithSuccessorsAndRadiusUpto"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
352 .Vb 3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
353 \& $PathsTraversal\->
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
354 \& PerformNeighborhoodVerticesSearchWithSuccessorsAndRadiusUpto(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
355 \& $StartVertexID, $Radius);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
356 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
357 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
358 Searches vertices around \fIStartVertexID\fR with neighborhood radius upto \fIRadius\fR along with
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
359 identification of successor vertices for each vertex found during the traversal and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
360 \&\fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
361 .IP "\fBPerformPathsSearch\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
362 .IX Item "PerformPathsSearch"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
363 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
364 \& $PathsTraversal\->PerformPathsSearch($StartVertexID, [$AllowCycles]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
365 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
366 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
367 Searches paths starting from \fIStartVertexID\fR with no sharing of edges in paths traversed and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
368 returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
369 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
370 By default, cycles are included in paths. A path containing a cycle is terminated at a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
371 completing the cycle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
372 .IP "\fBPerformPathsSearchBetween\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
373 .IX Item "PerformPathsSearchBetween"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
374 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
375 \& $PathsTraversal\->PerformPathsSearchBetween($StartVertexID, $EndVertexID);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
376 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
377 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
378 Searches paths between \fIStartVertexID\fR and \fIEndVertexID\fR and returns \fIPathsTraversal\fR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
379 .IP "\fBPerformPathsSearchWithLength\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
380 .IX Item "PerformPathsSearchWithLength"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
381 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
382 \& $PathsTraversal\->PerformPathsSearchWithLength($StartVertexID, $Length,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
383 \& [$AllowCycles]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
384 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
385 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
386 Searches paths starting from \fIStartVertexID\fR with length \fILength\fR with no sharing of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
387 edges in paths traversed and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
388 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
389 By default, cycles are included in paths. A path containing a cycle is terminated at a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
390 completing the cycle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
391 .IP "\fBPerformPathsSearchWithLengthUpto\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
392 .IX Item "PerformPathsSearchWithLengthUpto"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
393 .Vb 2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
394 \& $PathsTraversal\->PerformPathsSearchWithLengthUpto($StartVertexID, $Length,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
395 \& [$AllowCycles]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
396 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
397 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
398 Searches paths starting from \fIStartVertexID\fR with length upto \fILength\fR with no sharing of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
399 edges in paths traversed and returns \fIPathsTraversal\fR.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
400 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
401 By default, cycles are included in paths. A path containing a cycle is terminated at a vertex
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
402 completing the cycle.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
403 .IP "\fBStringifyPaths\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
404 .IX Item "StringifyPaths"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
405 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
406 \& $String = $PathsTraversal\->StringifyPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
407 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
408 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
409 Returns a string containing information about traversed paths in \fIPathsTraversal\fR object
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
410 .IP "\fBStringifyPathsTraversal\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
411 .IX Item "StringifyPathsTraversal"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
412 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
413 \& $String = $PathsTraversal\->StringifyPathsTraversal();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
414 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
415 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
416 Returns a string containing information about \fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
417 .IP "\fBStringifyVerticesDepth\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
418 .IX Item "StringifyVerticesDepth"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
419 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
420 \& $String = $PathsTraversal\->StringifyVerticesDepth();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
421 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
422 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
423 Returns a string containing information about depth of vertices found during search by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
424 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
425 .IP "\fBStringifyVerticesNeighborhoods\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
426 .IX Item "StringifyVerticesNeighborhoods"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
427 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
428 \& $String = $PathsTraversal\->StringifyVerticesNeighborhoods();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
429 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
430 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
431 Returns a string containing information about neighborhoods of vertices found during search by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
432 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
433 .IP "\fBStringifyVerticesNeighborhoodsWithSuccessors\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
434 .IX Item "StringifyVerticesNeighborhoodsWithSuccessors"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
435 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
436 \& $String = $PathsTraversal\->StringifyVerticesNeighborhoodsWithSuccessors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
437 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
438 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
439 Returns a string containing information about neighborhoods of vertices along with their successors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
440 found during search by \fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
441 .IP "\fBStringifyVerticesPredecessors\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
442 .IX Item "StringifyVerticesPredecessors"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
443 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
444 \& $String = $PathsTraversal\->StringifyVerticesPredecessors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
445 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
446 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
447 Returns a string containing information about predecessors of vertices found during search by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
448 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
449 .IP "\fBStringifyVerticesRoots\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
450 .IX Item "StringifyVerticesRoots"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
451 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
452 \& $String = $PathsTraversal\->StringifyVerticesRoots();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
453 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
454 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
455 Returns a string containing information about roots of vertices found during search by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
456 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
457 .IP "\fBStringifyVerticesSuccessors\fR" 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
458 .IX Item "StringifyVerticesSuccessors"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
459 .Vb 1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
460 \& $String = $PathsTraversal\->StringifyVerticesSuccessors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
461 .Ve
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
462 .Sp
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
463 Returns a string containing information about successors of vertices found during search by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
464 \&\fIPathsTraversal\fR object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
465 .SH "AUTHOR"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
466 .IX Header "AUTHOR"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
467 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
468 .SH "SEE ALSO"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
469 .IX Header "SEE ALSO"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
470 Graph.pm, Path.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
471 .SH "COPYRIGHT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
472 .IX Header "COPYRIGHT"
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
473 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
474 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
475 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
476 .PP
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
477 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
478 the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
479 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
480 any later version.