Mercurial > repos > deepakjadmin > mayatool3_test3

view mayachemtools/docs/modules/html/CyclesDetection.html @ 9:ab29fa5c8c1f draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
line wrap: on
line source

<html>
<head>
<title>MayaChemTools:Documentation:Graph::CyclesDetection.pm</title>
<meta http-equiv="content-type" content="text/html;charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
</head>
<body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
<br/>
<center>
<a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
</center>
<br/>
<div class="DocNav">
<table width="100%" border=0 cellpadding=0 cellspacing=2>
<tr align="left" valign="top"><td width="33%" align="left"><a href="./TopologicalPharmacophoreAtomTripletsFingerprints.html" title="TopologicalPharmacophoreAtomTripletsFingerprints.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./GraphMatrix.html" title="GraphMatrix.html">Next</a></td><td width="34%" align="middle"><strong>Graph::CyclesDetection.pm</strong></td><td width="33%" align="right"><a href="././code/CyclesDetection.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/CyclesDetection.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/CyclesDetection.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/CyclesDetection.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/CyclesDetection.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
</table>
</div>
<p>
</p>
<h2>NAME</h2>
<p>CyclesDetection</p>
<p>
</p>
<h2>SYNOPSIS</h2>
<p>use Graph::CyclesDetection;</p>
<p>use Graph::CyclesDetection qw(:all);</p>
<p>
</p>
<h2>DESCRIPTION</h2>
<p><strong>CyclesDetection</strong> class provides the following methods:</p>
<p> <a href="#new">new</a>, <a href="#copy">Copy</a>, <a href="#detectcycles">DetectCycles</a>, <a href="#detectcyclesusingcollapsingpathgraphmethodology">DetectCyclesUsingCollapsingPathGraphMethodology</a>
, <a href="#getallcyclicpaths">GetAllCyclicPaths</a>, <a href="#getindependentcyclicpaths">GetIndependentCyclicPaths</a>, <a href="#stringifycyclesdetection">StringifyCyclesDetection</a>
</p><p>Cycles in a <strong>Graph</strong> are detected using collapsing path graph [Ref 31]
methodology.</p>
<p>
</p>
<h2>METHODS</h2>
<dl>
<dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    $NewCyclesDetection = new Graph::CyclesDetection($Graph);</div>
<p>Using specified <em>Graph</em>, <strong>new</strong> method creates a new <strong>CyclesDetection</strong> object and returns
newly created <strong>CyclesDetection</strong> object.</p>
</dd>
<dt><strong><a name="copy" class="item"><strong>Copy</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    $NewCyclesDetection = $CyclesDetection-&gt;Copy();</div>
<p>Copies <em>CyclesDetection</em> and its associated data using <strong>Storable::dclone</strong> and returns a new
<strong>CyclesDetection</strong> object.</p>
</dd>
<dt><strong><a name="detectcycles" class="item"><strong>DetectCycles</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    $CyclesDetection-&gt;DetectCycles();</div>
<p>Detects all cycles in a graph and returns <em>CyclesDetection</em>.</p>
</dd>
<dt><strong><a name="detectcyclesusingcollapsingpathgraphmethodology" class="item"><strong>DetectCyclesUsingCollapsingPathGraphMethodology</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    $CyclesDetection-&gt;DetectCyclesUsingCollapsingPathGraphMethodology();</div>
<p>Detects all cycles in a graph using collapsing path graph [Ref 31] methodology
and returns <em>CyclesDetection</em>.</p>
</dd>
<dt><strong><a name="getallcyclicpaths" class="item"><strong>GetAllCyclicPaths</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    @AllCyclicPaths = $CyclesDetection-&gt;GetAllCyclicPaths();
<br/>    $NumOfAllCyclicPaths = $CyclesDetection-&gt;GetAllCyclicPaths();</div>
<p>Returns an array containing references to all cyclic paths identified during cycles
detection. In scalar text, number of cycles is returned.</p>
</dd>
<dt><strong><a name="getindependentcyclicpaths" class="item"><strong>GetIndependentCyclicPaths</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    @IndependentCyclicPaths = $CyclesDetection-&gt;GetAllCyclicPaths();
<br/>    $NumOfIndependentCyclicPaths = $CyclesDetection-&gt;GetAllCyclicPaths();</div>
<p>Returns an array containing references to independent cyclic paths identified during cycles
detection. In scalar text, number of cycles is returned.</p>
<p>A set of independent cycles identified during cycles detection doesn't correspond to the basis set of
rings or smallest set of smallest rings (SSSR) [ Refs 29-30 ]; instead, set of cycles indentified
as independent cycles simply correpond to cycles which contain no other cycle as their
subcycles and can't be described as a linear combination of smaller cycles. And it also happens
to contain all the rings in basis set of rings and SSSR. In other words, it's a superset of a basis set
of cycles and SSSR. For example, six four membered cycles are indentified for cubane, which is one
more than the basis set of cycles.</p>
</dd>
<dt><strong><a name="stringifycyclesdetection" class="item"><strong>StringifyCyclesDetection</strong></a></strong></dt>
<dd>
<div class="OptionsBox">
    $String = $CyclesDetection-&gt;StringifyCyclesDetection();</div>
<p>Returns a string containing information about <em>CyclesDetection</em> object.</p>
</dd>
</dl>
<p>
</p>
<h2>AUTHOR</h2>
<p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
<p>
</p>
<h2>SEE ALSO</h2>
<p><a href="./Graph.html">Graph.pm</a>,&nbsp<a href="./Path.html">Path.pm</a>,&nbsp<a href="./PathGraph.html">PathGraph.pm</a>
</p>
<p>
</p>
<h2>COPYRIGHT</h2>
<p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
<p>This file is part of MayaChemTools.</p>
<p>MayaChemTools is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your option)
any later version.</p>
<p>&nbsp</p><p>&nbsp</p><div class="DocNav">
<table width="100%" border=0 cellpadding=0 cellspacing=2>
<tr align="left" valign="top"><td width="33%" align="left"><a href="./TopologicalPharmacophoreAtomTripletsFingerprints.html" title="TopologicalPharmacophoreAtomTripletsFingerprints.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./GraphMatrix.html" title="GraphMatrix.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>Graph::CyclesDetection.pm</strong></td></tr>
</table>
</div>
<br />
<center>
<img src="../../images/h2o2.png">
</center>
</body>
</html>