Mercurial > repos > deepakjadmin > mayatool3_test3
diff mayachemtools/docs/modules/html/PathGraph.html @ 0:73ae111cf86f draft
Uploaded
author | deepakjadmin |
---|---|
date | Wed, 20 Jan 2016 11:55:01 -0500 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mayachemtools/docs/modules/html/PathGraph.html Wed Jan 20 11:55:01 2016 -0500 @@ -0,0 +1,118 @@ +<html> +<head> +<title>MayaChemTools:Documentation:Graph::PathGraph.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="./Path.html" title="Path.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./PathsTraversal.html" title="PathsTraversal.html">Next</a></td><td width="34%" align="middle"><strong>Graph::PathGraph.pm</strong></td><td width="33%" align="right"><a href="././code/PathGraph.html" title="View source code">Code</a> | <a href="./../pdf/PathGraph.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/PathGraph.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/PathGraph.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/PathGraph.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr> +</table> +</div> +<p> +</p> +<h2>NAME</h2> +<p>PathGraph</p> +<p> +</p> +<h2>SYNOPSIS</h2> +<p>use Graph::PathGraph;</p> +<p>use Graph::PathGraph qw(:all);</p> +<p> +</p> +<h2>DESCRIPTION</h2> +<p><strong>PathGraph</strong> class provides the following methods:</p> +<p> <a href="#new">new</a>, <a href="#collapsevertexandcollectcyclicpaths">CollapseVertexAndCollectCyclicPaths</a>, <a href="#deleteverticeswithdegreelessthan">DeleteVerticesWithDegreeLessThan</a> +, <a href="#getcyclicpaths">GetCyclicPaths</a>, <a href="#getpaths">GetPaths</a>, <a href="#ispathgraph">IsPathGraph</a>, <a href="#stringifypathgraph">StringifyPathGraph</a> +</p><p><strong>PathGraph</strong> class is derived from <em>Graph</em> class.</p> +<p> +</p> +<h2>METHODS</h2> +<dl> +<dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + $NewPathGraph = new Graph::PathGraph($Graph);</div> +<p>Using specified <em>Graph</em>, <strong>new</strong> method creates a new <strong>PathGraph</strong> object and returns +newly created <strong>PathGraph</strong> object.</p> +<p><em>Graph</em> is converted into a <strong>PathGraph</strong> by copying all its vertices and edges without any +associated properties data and associating a <em>Path</em> object to each edge containing edge +vertex IDs as intial path.</p> +</dd> +<dt><strong><a name="collapsevertexandcollectcyclicpaths" class="item"><strong>CollapseVertexAndCollectCyclicPaths</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + $PathGraph->CollapseVertexAndCollectCyclicPaths($VertexID);</div> +<p>Collapses paths around a <em>VertexID</em> by updating paths around the vertex [Ref 31] and associating any +resulting cyclic paths to graph as <strong>CyclicPaths</strong> property name. And returns <em>PathGraph</em>.</p> +</dd> +<dt><strong><a name="deleteverticeswithdegreelessthan" class="item"><strong>DeleteVerticesWithDegreeLessThan</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + $Return = $PathGraph->DeleteVerticesWithDegreeLessThan($Degree);</div> +<p>Deletes vertices with degree less than <em>Degree</em> from <em>PathGraph</em> and returns <em>PathGraph</em>.</p> +</dd> +<dt><strong><a name="getcyclicpaths" class="item"><strong>GetCyclicPaths</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + @CyclicPaths = $PathGraph->GetCyclicPaths(); +<br/> $NumOfPaths = $PathGraph->GetCyclicPaths();</div> +<p>Returns an array of cyclic <em>Paths</em> associated with edges in <em>PathGraph</em>. In scalar context, number +of cyclic paths is returned.</p> +</dd> +<dt><strong><a name="getpaths" class="item"><strong>GetPaths</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + @Paths = $PathGraph->GetPaths(); +<br/> $NumOfPaths = $PathGraph->GetPaths();</div> +<p>Returns an array of <em>Paths</em> associated with edges in <em>PathGraph</em>. In scalar context, number +of paths is returned.</p> +</dd> +<dt><strong><a name="ispathgraph" class="item"><strong>IsPathGraph</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + $Status = Graph::PathGraph::IsPathGraph($Object);</div> +<p>Returns 1 or 0 based on whether <em>Object</em> is a <strong>PathGraph</strong> object.</p> +</dd> +<dt><strong><a name="stringifypathgraph" class="item"><strong>StringifyPathGraph</strong></a></strong></dt> +<dd> +<div class="OptionsBox"> + $String = $PathGraph->StringifyPathGraph();</div> +<p>Returns a string containing information about traversed paths in <em>PathGraph</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>, <a href="./Path.html">Path.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> </p><p> </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="./Path.html" title="Path.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./PathsTraversal.html" title="PathsTraversal.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>Graph::PathGraph.pm</strong></td></tr> +</table> +</div> +<br /> +<center> +<img src="../../images/h2o2.png"> +</center> +</body> +</html>