annotate mayachemtools/docs/modules/txt/CyclesDetection.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 CyclesDetection
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use Graph::CyclesDetection;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 use Graph::CyclesDetection qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 CyclesDetection class provides the following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 new, Copy, DetectCycles,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 DetectCyclesUsingCollapsingPathGraphMethodology, GetAllCyclicPaths,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 GetIndependentCyclicPaths, StringifyCyclesDetection
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 Cycles in a Graph are detected using collapsing path graph [Ref 31]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 methodology.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 $NewCyclesDetection = new Graph::CyclesDetection($Graph);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 Using specified *Graph*, new method creates a new CyclesDetection
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 object and returns newly created CyclesDetection object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 Copy
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 $NewCyclesDetection = $CyclesDetection->Copy();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 Copies *CyclesDetection* and its associated data using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 Storable::dclone and returns a new CyclesDetection object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 DetectCycles
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 $CyclesDetection->DetectCycles();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 Detects all cycles in a graph and returns *CyclesDetection*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 DetectCyclesUsingCollapsingPathGraphMethodology
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 $CyclesDetection->DetectCyclesUsingCollapsingPathGraphMethodology();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 Detects all cycles in a graph using collapsing path graph [Ref 31]
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 methodology and returns *CyclesDetection*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 GetAllCyclicPaths
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 @AllCyclicPaths = $CyclesDetection->GetAllCyclicPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 $NumOfAllCyclicPaths = $CyclesDetection->GetAllCyclicPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 Returns an array containing references to all cyclic paths
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 identified during cycles detection. In scalar text, number of cycles
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 is returned.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 GetIndependentCyclicPaths
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 @IndependentCyclicPaths = $CyclesDetection->GetAllCyclicPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 $NumOfIndependentCyclicPaths = $CyclesDetection->GetAllCyclicPaths();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 Returns an array containing references to independent cyclic paths
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 identified during cycles detection. In scalar text, number of cycles
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 is returned.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 A set of independent cycles identified during cycles detection
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 doesn't correspond to the basis set of rings or smallest set of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 smallest rings (SSSR) [ Refs 29-30 ]; instead, set of cycles
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 indentified as independent cycles simply correpond to cycles which
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 contain no other cycle as their subcycles and can't be described as
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 a linear combination of smaller cycles. And it also happens to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 contain all the rings in basis set of rings and SSSR. In other
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 words, it's a superset of a basis set of cycles and SSSR. For
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 example, six four membered cycles are indentified for cubane, which
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 is one more than the basis set of cycles.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 StringifyCyclesDetection
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 $String = $CyclesDetection->StringifyCyclesDetection();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 Returns a string containing information about *CyclesDetection*
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 Graph.pm, Path.pm, PathGraph.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91