annotate lib/Graph/Path.pm @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 package Graph::Path;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: Path.pm,v $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:49:06 $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.25 $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 use Carp;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 use Exporter;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 use Storable ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 use Scalar::Util ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 @ISA = qw(Exporter);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 @EXPORT = qw();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 @EXPORT_OK = qw();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 # Setup class variables...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 my($ClassName, $ObjectID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 _InitializeClass();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 # Overload Perl functions...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 use overload '""' => 'StringifyPath',
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 '==' => '_PathEqualOperator',
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 'eq' => '_PathEqualOperator',
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 'fallback' => undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 # Class constructor...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 sub new {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 my($Class, @VertexIDs) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 # Initialize object...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 my $This = {};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 bless $This, ref($Class) || $Class;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 $This->_InitializePath();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 if (@VertexIDs) { $This->AddVertices(@VertexIDs); }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 # Initialize object data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 sub _InitializePath {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 @{$This->{Vertices}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 # Initialize class ...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 sub _InitializeClass {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 #Class name...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 $ClassName = __PACKAGE__;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 # Add a vertex to path after the end vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 sub AddVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 my($This, $VertexID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88 if (!defined $VertexID ) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 carp "Warning: ${ClassName}->AddVertex: No vertex added: Vertex ID must be specified...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 push @{$This->{Vertices}}, $VertexID;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 # Add vertices to the path after the end vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 sub AddVertices {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 my($This, @VertexIDs) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 if (!@VertexIDs) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 carp "Warning: ${ClassName}->AddVertices: No vertices added: Vertices list is empty...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 push @{$This->{Vertices}}, @VertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 # Add a vertex to path after the end vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 sub PushVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 my($This, $VertexID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 return $This->AddVertex($VertexID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 # Add vertices to the path after the end vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 sub PushVertices {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 my($This, @VertexIDs) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 return $This->AddVertices(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 # Remove end vertex from path...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 sub PopVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132 if (!@{$This->{Vertices}}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 carp "Warning: ${ClassName}->PopVertex: No vertex removed: Path is empty...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136 pop @{$This->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
140
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
141 # Remove start vertex from path...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
142 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
143 sub ShiftVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
144 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
145
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
146 if (!@{$This->{Vertices}}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
147 carp "Warning: ${ClassName}->ShiftVertex: No vertex removed: Path is empty...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
148 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
149 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
150 shift @{$This->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
151
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
152 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
153 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
154
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
155 # Add a vertex to path before the start vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
156 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
157 sub UnshiftVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
158 my($This, $VertexID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
159
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
160 if (!defined $VertexID ) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
161 carp "Warning: ${ClassName}->UnshiftVertex: No vertex added: Vertex ID must be specified...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
162 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
163 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
164 unshift @{$This->{Vertices}}, $VertexID;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
165
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
166 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
167 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
168
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
169 # Add vertices to the path before the start vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
170 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
171 sub UnshiftVertices {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
172 my($This, @VertexIDs) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
173
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
174 if (!@VertexIDs) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
175 carp "Warning: ${ClassName}->UnshiftVertices: No vertices added: Vertices list is empty...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
176 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
177 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
178 unshift @{$This->{Vertices}}, @VertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
179
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
180 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
181 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
182
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
183 # Get length...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
184 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
185 sub GetLength {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
186 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
187
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
188 return scalar @{$This->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
189 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
190
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
191 # Get start vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
192 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
193 sub GetStartVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
194 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
195
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
196 if (!$This->GetLength()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
197 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
198 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
199 my($Index) = 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
200 return $This->_GetVertex($Index);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
201 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
202
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
203 # Get end vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
204 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
205 sub GetEndVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
206 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
207
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
208 if (!$This->GetLength()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
209 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
210 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
211 my($Index);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
212
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
213 $Index = $This->GetLength() - 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
214 return $This->_GetVertex($Index);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
215 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
216
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
217 # Get start and end vertices...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
218 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
219 sub GetTerminalVertices {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
220 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
221
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
222 return ( $This->GetStartVertex(), $This->GetEndVertex() ),
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
223 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
224
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
225 # Get path vertices...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
226 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
227 sub GetVertices {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
228 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
229
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
230 return wantarray ? @{$This->{Vertices}} : scalar @{$This->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
231 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
232
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
233 # Get a specific vertex from path with indicies starting from 0...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
234 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
235 sub GetVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
236 my($This, $Index) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
237
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
238 if ($Index < 0) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
239 croak "Error: ${ClassName}->GetValue: Index value must be a positive number...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
240 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
241 if ($Index >= $This->GetLength()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
242 croak "Error: ${ClassName}->GetValue: Index vaue must be less than length of path...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
243 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
244 if (!$This->GetLength()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
245 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
246 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
247 return $This->_GetVertex($Index);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
248 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
249
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
250 # Get a vertex...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
251 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
252 sub _GetVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
253 my($This, $Index) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
254
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
255 return $This->{Vertices}[$Index];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
256 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
257
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
258 # Get path edges as pair of vertices or number of edges...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
259 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
260 sub GetEdges {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
261 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
262
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
263 if ($This->GetLength < 1) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
264 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
265 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
266 # Set up edges...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
267 my($Index, $VertexID1, $VertexID2, @Vertices, @Edges);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
268
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
269 @Edges = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
270 for $Index (0 .. ($#{$This->{Vertices}} - 1) ) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
271 $VertexID1 = $This->{Vertices}[$Index];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
272 $VertexID2 = $This->{Vertices}[$Index + 1];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
273 push @Edges, ($VertexID1, $VertexID2);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
274 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
275
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
276 return wantarray ? @Edges : ((scalar @Edges)/2);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
277 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
278
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
279 # Is it a cycle?
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
280 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
281 sub IsCycle {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
282 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
283 my($StartVertex, $EndVertex);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
284
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
285 ($StartVertex, $EndVertex) = $This->GetTerminalVertices();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
286
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
287 return ($StartVertex == $EndVertex) ? 1 : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
288 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
289
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
290 # For a path to be an independent path, it must meet the following conditions:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
291 # . All other vertices are unique.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
292 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
293 sub IsIndependentPath {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
294 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
295
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
296 # Make sure it has at least two vertices...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
297 if ($This->GetLength() < 2) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
298 return 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
299 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
300
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
301 # Check frequency of occurence for non-terminal vertices...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
302 my($VertexID, $IndependenceStatus, @Vertices, %VerticesMap);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
303
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
304 @Vertices = $This->GetVertices();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
305 shift @Vertices; pop @Vertices;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
306
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
307 %VerticesMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
308 $IndependenceStatus = 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
309
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
310 VERTEXID: for $VertexID (@Vertices) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
311 if (exists $VerticesMap{$VertexID} ) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
312 $IndependenceStatus = 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
313 last VERTEXID;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
314 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
315 $VerticesMap{$VertexID} = $VertexID;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
316 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
317 return $IndependenceStatus;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
318 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
319
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
320 # For a path to be an independent cyclic path, it must meet the following conditions:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
321 # . Termimal vertices are the same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
322 # . All other vertices are unique.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
323 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
324 sub IsIndependentCyclicPath {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
325 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
326
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
327 # Make sure it's a cycle...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
328 if (!($This->GetLength() >= 3 && $This->IsCycle())) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
329 return 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
330 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
331 return $This->IsIndependentPath();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
332 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
333
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
334 # Is it a path object?
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
335 sub IsPath ($) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
336 my($Object) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
337
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
338 return _IsPath($Object);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
339 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
340
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
341 # Copy path...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
342 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
343 sub Copy {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
344 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
345 my($NewPath);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
346
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
347 $NewPath = Storable::dclone($This);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
348
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
349 return $NewPath;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
350 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
351
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
352 # Reverse order of vertices in path...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
353 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
354 sub Reverse {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
355 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
356 my(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
357
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
358 @VertexIDs = (); push @VertexIDs, @{$This->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
359
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
360 @{$This->{Vertices}} = (); push @{$This->{Vertices}}, reverse @VertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
361
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
362 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
363 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
364
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
365 # Get vertices common between two paths...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
366 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
367 sub GetCommonVertices {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
368 my($This, $Other) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
369 my($VertexID, @CommonVertices, %OtherVerticesMap);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
370
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
371 # Setup a vertices hash for a quick look up...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
372 %OtherVerticesMap = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
373 for $VertexID ($Other->GetVertices()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
374 $OtherVerticesMap{$VertexID} = $VertexID;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
375 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
376
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
377 @CommonVertices = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
378 for $VertexID ($This->GetVertices()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
379 if ($OtherVerticesMap{$VertexID}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
380 push @CommonVertices, $VertexID
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
381 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
382 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
383 return wantarray ? @CommonVertices : scalar @CommonVertices;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
384 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
385
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
386 # Join the existing path with a new path specifed using a path object of a list of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
387 # verticies.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
388 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
389 sub Join {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
390 my($This, @Values) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
391
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
392 return $This->_Join(@Values);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
393 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
394
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
395 # Join the existing path with a new path specifed using a path object at a specified
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
396 # vertex.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
397 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
398 sub JoinAtVertex {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
399 my($This, $Other, $CenterVertexID) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
400
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
401 # Make sure CenterVertexID is end vertex in This and start vertex in Other before
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
402 # joining them...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
403 if ($This->GetEndVertex() != $CenterVertexID) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
404 $This->Reverse();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
405 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
406 if ($Other->GetStartVertex() != $CenterVertexID) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
407 $Other->Reverse();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
408 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
409 return $This->_Join($Other);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
410 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
411
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
412 # Join the existing path with a new path specifed using a path object of a list of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
413 # verticies.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
414 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
415 # Notes:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
416 # . Paths must have a common terminal vertex.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
417 # . Based on the common terminal vertex found, new path vertices are added to the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
418 # current path in one of the four ways:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
419 # . New path at end of current path with same vertices order : EndVertex = NewStartVertex
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
420 # . New path at end of current path with reversed vertices order: EndVertex = NewEndVertex
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
421 # . New path at front of current path with same vertices order: StartVertex = NewEndVertex
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
422 # . New path at front of current path with reversed vertices order: StartVertex = NewStartVertex
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
423 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
424 sub _Join {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
425 my($This, @Values) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
426
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
427 if (!@Values) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
428 return;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
429 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
430
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
431 # Get a list of new vertex IDs..
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
432 my($NewPath, $FirstValue, $TypeOfFirstValue, @NewVertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
433
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
434 $NewPath = $This->Copy();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
435
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
436 @NewVertexIDs = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
437 $FirstValue = $Values[0];
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
438 $TypeOfFirstValue = ref $FirstValue;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
439 if ($TypeOfFirstValue =~ /^(SCALAR|HASH|CODE|REF|GLOB)/) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
440 croak "Error: ${ClassName}->JoinPath: Trying to add vertices to path object with a reference to unsupported value format...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
441 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
442
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
443 if (_IsPath($FirstValue)) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
444 # It's another path object...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
445 push @NewVertexIDs, @{$FirstValue->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
446 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
447 elsif ($TypeOfFirstValue =~ /^ARRAY/) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
448 # It's array reference...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
449 push @NewVertexIDs, @{$FirstValue};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
450 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
451 else {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
452 # It's a list of values...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
453 push @NewVertexIDs, @Values;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
454 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
455 my($StartVertex, $EndVertex, $NewStartVertex, $NewEndVertex);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
456
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
457 ($StartVertex, $EndVertex) = $NewPath->GetTerminalVertices();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
458 ($NewStartVertex, $NewEndVertex) = ($NewVertexIDs[0], $NewVertexIDs[$#NewVertexIDs]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
459
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
460 if (!($EndVertex == $NewStartVertex || $EndVertex == $NewEndVertex || $StartVertex == $NewEndVertex || $StartVertex == $NewStartVertex)) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
461 carp "Warning: ${ClassName}->JoinPath: Paths can't be joined: No common terminal vertex found...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
462 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
463 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
464
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
465 if ($EndVertex == $NewStartVertex) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
466 # Take out EndVertex and add new path at the end...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
467 pop @{$NewPath->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
468 push @{$NewPath->{Vertices}}, @NewVertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
469 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
470 elsif ($EndVertex == $NewEndVertex) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
471 # Take out EndVertex and add new path at the end with reversed vertex order...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
472 pop @{$NewPath->{Vertices}};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
473 push @{$NewPath->{Vertices}}, reverse @NewVertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
474 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
475 elsif ($StartVertex == $NewEndVertex) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
476 # Take out NewEndVertex and add new path at the front...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
477 pop @NewVertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
478 unshift @{$NewPath->{Vertices}}, @NewVertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
479 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
480 elsif ($StartVertex == $NewStartVertex) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
481 # Take out NewStartVertex and add new path at the front...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
482 shift @NewVertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
483 unshift @{$NewPath->{Vertices}}, reverse @NewVertexIDs;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
484 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
485
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
486 return $NewPath,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
487 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
488
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
489 # Compare two paths...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
490 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
491 sub _PathEqualOperator {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
492 my($This, $Other) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
493
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
494 if (!(defined($This) && _IsPath($This) && defined($Other) && _IsPath($Other))) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
495 croak "Error: ${ClassName}->_PathEqualOperator: Path equal comparison failed: Both object must be paths...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
496 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
497
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
498 if ($This->GetLength() != $Other->GetLength()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
499 return 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
500 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
501 my($ThisID, $OtherID, $ReverseOtherID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
502
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
503 $ThisID = join('-', @{$This->{Vertices}});
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
504 $OtherID = join('-', @{$Other->{Vertices}});
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
505 $ReverseOtherID = join('-', reverse(@{$Other->{Vertices}}));
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
506
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
507 return ($ThisID =~ /^($OtherID|$ReverseOtherID)$/) ? 1 : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
508 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
509
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
510 # Return a string containing vertices in the path...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
511 sub StringifyPath {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
512 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
513 my($PathString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
514
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
515 $PathString = "Path: " . join('-', @{$This->{Vertices}});
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
516
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
517 return $PathString;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
518 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
519
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
520 # Is it a path object?
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
521 sub _IsPath {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
522 my($Object) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
523
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
524 return (Scalar::Util::blessed($Object) && $Object->isa($ClassName)) ? 1 : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
525 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
526
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
527 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
528
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
529 __END__
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
530
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
531 =head1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
532
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
533 Path - Path class
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
534
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
535 =head1 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
536
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
537 use Graph::Path;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
538
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
539 use Graph::Path qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
540
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
541 =head1 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
542
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
543 B<Path> class provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
544
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
545 new, AddVertex, AddVertices, Copy, GetCommonVertices, GetEdges, GetEndVertex,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
546 GetLength, GetStartVertex, GetTerminalVertices, GetVertex, GetVertices, IsCycle,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
547 IsIndependentCyclicPath, IsIndependentPath, IsPath, Join, JoinAtVertex, PopVertex,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
548 PushVertex, PushVertices, Reverse, ShiftVertex, StringifyPath, UnshiftVertex,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
549 UnshiftVertices
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
550
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
551 Path is a sequential list of vertices with an edge between two successive vertices. The path
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
552 becomes a cycle when start vertex and end vertex are the same.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
553
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
554 The following operators are overloaded:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
555
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
556 "" == eq
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
557
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
558 =head2 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
559
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
560 =over 4
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
561
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
562 =item B<new>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
563
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
564 $NewPath = new Path();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
565 $NewPath = new Path(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
566
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
567 Using specified I<VertexIDs>, B<new> method creates a new B<Path> object and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
568 newly created B<Path> object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
569
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
570 =item B<AddVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
571
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
572 $Path->AddVertex($VertexID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
573
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
574 Adds I<VertexID> to I<Path> and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
575
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
576 =item B<AddVertices>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
577
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
578 $Path->AddVertices(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
579
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
580 Adds vertices using I<VertexIDs> to I<Path> and returns I<Graph>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
581
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
582 =item B<Copy>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
583
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
584 $Return = $Path->Copy();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
585
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
586 Copies I<Path> and its associated data using B<Storable::dclone> and returns a new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
587 B<Path> object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
588
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
589 =item B<GetCommonVertices>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
590
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
591 @CommonVertices = $Path->GetCommonVertices($OtherPath);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
592 $NumOfCommonVertices = $Path->GetCommonVertices($OtherPath);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
593
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
594 Returns an array containing common vertex IDs between two paths. In scalar context, number
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
595 of common vertices is returned.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
596
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
597 =item B<GetEdges>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
598
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
599 @EdgesVertexIDs = $Path->GetEdges();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
600 $NumOfEdges = $Path->GetEdges();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
601
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
602 Returns an array containg successive paris of vertex IDs corresponding to all edges in I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
603 In scalar context, the number of edges is returned.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
604
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
605 =item B<GetEndVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
606
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
607 $VertexID = $Path->GetEndVertex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
608
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
609 Returns B<VertexID> of end vertex in I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
610
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
611 =item B<GetLength>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
612
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
613 $Length = $Path->GetLength();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
614
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
615 Returns B<Length> of I<Path> corresponding to number of vertices in I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
616
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
617 =item B<GetStartVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
618
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
619 $VertexID = $Path->GetStartVertex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
620
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
621 Returns B<VertexID> of start vertex in I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
622
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
623 =item B<GetTerminalVertices>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
624
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
625 ($StartVertexID, $EndVertexID) = $Path->GetTerminalVertices();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
626
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
627 Returns vertex IDs of start and end vertices in I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
628
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
629 =item B<GetVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
630
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
631 $VertexID = $Path->GetVertex($Index);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
632
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
633 Returns specific vertex ID from I<Path> corresponding to I<Index> with indicies starting from 0.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
634
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
635 =item B<GetVertices>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
636
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
637 @Vertices = $Path->GetVertices();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
638 $NumOfVertices = $Path->GetVertices();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
639
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
640 Returns an array containing all vertex IDs in I<Path>. In scalar context, number of vertices
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
641 is returned.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
642
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
643 =item B<IsCycle>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
644
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
645 $Status = $Path->IsCycle();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
646
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
647 Returns 1 or 0 based on whether I<Path> is a B<CyclicPath> which has the same start and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
648 end vertex IDs.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
649
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
650 =item B<IsIndependentCyclicPath>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
651
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
652 $Status = $Path->IsIndependentCyclicPath();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
653
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
654 Returns 1 or 0 based on whether I<Path> is an independent B<CyclicPath>. For a I<Path> to be
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
655 an independent cyclic path, it must be a cyclic path and have unique vertices.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
656
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
657 =item B<IsIndependentPath>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
658
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
659 $Status = $Path->IsIndependentPath();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
660
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
661 Returns 1 or 0 based on whether I<Path> is an independent B<Path>. For a I<Path> to be
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
662 an independent path, it must have unique vertices.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
663
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
664 =item B<IsPath>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
665
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
666 $Status = Graph::Path::IsPath();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
667
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
668 Returns 1 or 0 based on whether I<Object> is a B<Path> object
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
669
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
670 =item B<Join>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
671
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
672 $NewPath = $Path->Join($OtherPath);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
673 $NewPath = $Path->Join(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
674
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
675 Joins existing I<Path> with a new path specified as a I<OtherPath> object or an array of I<VertexIDs>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
676 and returns I<NewPath>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
677
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
678 In order to successfully join two paths, terminal vertices must have a common vertex. Based on the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
679 common terminal vertex found, additional path vertices are added to the current I<Path> in one of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
680 the following four ways:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
681
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
682 . EndVertex = NewStartVertex: New path at end of current path with
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
683 same vertices order
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
684
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
685 . EndVertex = NewEndVertex: New path at end of current path with
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
686 reversed vertices order
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
687
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
688 . StartVertex = NewEndVertex: New path at front of current path
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
689 with same vertices order
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
690
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
691 . StartVertex = NewStartVertex: New path at front of current path
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
692 with reversed vertices order
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
693
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
694 =item B<JoinAtVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
695
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
696 $NewPath = $Path->JoinAtVertex($OtherPath, $CenterVertexID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
697
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
698 Joins existing I<Path> with I<OtherPath> at a specified I<CeterVertexID> and returns a I<NewPath>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
699
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
700 =item B<PopVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
701
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
702 $Path->PopVertex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
703
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
704 Removes end vertex from I<Path> and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
705
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
706 =item B<PushVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
707
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
708 $Path->PushVertex($VertexID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
709
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
710 Adds I<VertexID> to I<Path> after end vertex and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
711
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
712 =item B<PushVertices>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
713
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
714 $Path->PushVertices(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
715
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
716 Adds I<VertexIDs> to I<Path> after end vertex and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
717
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
718 =item B<Reverse>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
719
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
720 $Path->Reverse();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
721
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
722 Reverses order of vertices in I<Path> and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
723
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
724 =item B<ShiftVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
725
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
726 $Path->ShiftVertex();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
727
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
728 Removes start vertex from I<Path> and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
729
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
730 =item B<StringifyPath>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
731
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
732 $String = $Path->StringifyPath();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
733
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
734 Returns a string containing information about I<Path> object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
735
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
736 =item B<UnshiftVertex>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
737
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
738 $Path->UnshiftVertex($VertexID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
739
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
740 Adds I<VertexID> to I<Path> before start vertex and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
741
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
742 =item B<UnshiftVertices>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
743
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
744 $Path->UnshiftVertices(@VertexIDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
745
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
746 Adds I<VertexIDs> to I<Path> before start vertex and returns I<Path>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
747
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
748 =back
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
749
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
750 =head1 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
751
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
752 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
753
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
754 =head1 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
755
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
756 PathGraph.pm, PathsTraversal.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
757
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
758 =head1 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
759
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
760 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
761
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
762 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
763
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
764 MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
765 the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
766 Software Foundation; either version 3 of the License, or (at your option)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
767 any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
768
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
769 =cut