|
1
|
1 NAME
|
|
|
2 PathGraph
|
|
|
3
|
|
|
4 SYNOPSIS
|
|
|
5 use Graph::PathGraph;
|
|
|
6
|
|
|
7 use Graph::PathGraph qw(:all);
|
|
|
8
|
|
|
9 DESCRIPTION
|
|
|
10 PathGraph class provides the following methods:
|
|
|
11
|
|
|
12 new, CollapseVertexAndCollectCyclicPaths,
|
|
|
13 DeleteVerticesWithDegreeLessThan, GetCyclicPaths, GetPaths, IsPathGraph,
|
|
|
14 StringifyPathGraph
|
|
|
15
|
|
|
16 PathGraph class is derived from *Graph* class.
|
|
|
17
|
|
|
18 METHODS
|
|
|
19 new
|
|
|
20 $NewPathGraph = new Graph::PathGraph($Graph);
|
|
|
21
|
|
|
22 Using specified *Graph*, new method creates a new PathGraph object
|
|
|
23 and returns newly created PathGraph object.
|
|
|
24
|
|
|
25 *Graph* is converted into a PathGraph by copying all its vertices
|
|
|
26 and edges without any associated properties data and associating a
|
|
|
27 *Path* object to each edge containing edge vertex IDs as intial
|
|
|
28 path.
|
|
|
29
|
|
|
30 CollapseVertexAndCollectCyclicPaths
|
|
|
31 $PathGraph->CollapseVertexAndCollectCyclicPaths($VertexID);
|
|
|
32
|
|
|
33 Collapses paths around a *VertexID* by updating paths around the
|
|
|
34 vertex [Ref 31] and associating any resulting cyclic paths to graph
|
|
|
35 as CyclicPaths property name. And returns *PathGraph*.
|
|
|
36
|
|
|
37 DeleteVerticesWithDegreeLessThan
|
|
|
38 $Return = $PathGraph->DeleteVerticesWithDegreeLessThan($Degree);
|
|
|
39
|
|
|
40 Deletes vertices with degree less than *Degree* from *PathGraph* and
|
|
|
41 returns *PathGraph*.
|
|
|
42
|
|
|
43 GetCyclicPaths
|
|
|
44 @CyclicPaths = $PathGraph->GetCyclicPaths();
|
|
|
45 $NumOfPaths = $PathGraph->GetCyclicPaths();
|
|
|
46
|
|
|
47 Returns an array of cyclic *Paths* associated with edges in
|
|
|
48 *PathGraph*. In scalar context, number of cyclic paths is returned.
|
|
|
49
|
|
|
50 GetPaths
|
|
|
51 @Paths = $PathGraph->GetPaths();
|
|
|
52 $NumOfPaths = $PathGraph->GetPaths();
|
|
|
53
|
|
|
54 Returns an array of *Paths* associated with edges in *PathGraph*. In
|
|
|
55 scalar context, number of paths is returned.
|
|
|
56
|
|
|
57 IsPathGraph
|
|
|
58 $Status = Graph::PathGraph::IsPathGraph($Object);
|
|
|
59
|
|
|
60 Returns 1 or 0 based on whether *Object* is a PathGraph object.
|
|
|
61
|
|
|
62 StringifyPathGraph
|
|
|
63 $String = $PathGraph->StringifyPathGraph();
|
|
|
64
|
|
|
65 Returns a string containing information about traversed paths in
|
|
|
66 *PathGraph* object.
|
|
|
67
|
|
|
68 AUTHOR
|
|
|
69 Manish Sud <msud@san.rr.com>
|
|
|
70
|
|
|
71 SEE ALSO
|
|
|
72 Graph.pm, Path.pm
|
|
|
73
|
|
|
74 COPYRIGHT
|
|
|
75 Copyright (C) 2015 Manish Sud. All rights reserved.
|
|
|
76
|
|
|
77 This file is part of MayaChemTools.
|
|
|
78
|
|
|
79 MayaChemTools is free software; you can redistribute it and/or modify it
|
|
|
80 under the terms of the GNU Lesser General Public License as published by
|
|
|
81 the Free Software Foundation; either version 3 of the License, or (at
|
|
|
82 your option) any later version.
|
|
|
83
|
