Mercurial > repos > deepakjadmin > mayatool3_test3
view mayachemtools/docs/modules/html/Fsp3CarbonsDescriptors.html @ 9:ab29fa5c8c1f draft default tip
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:MolecularDescriptors::Fsp3CarbonsDescriptors.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="./AtomsCountDescriptors.html" title="AtomsCountDescriptors.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./HydrogenBondsDescriptors.html" title="HydrogenBondsDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>MolecularDescriptors::Fsp3CarbonsDescriptors.pm</strong></td><td width="33%" align="right"><a href="././code/Fsp3CarbonsDescriptors.html" title="View source code">Code</a> | <a href="./../pdf/Fsp3CarbonsDescriptors.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/Fsp3CarbonsDescriptors.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/Fsp3CarbonsDescriptors.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/Fsp3CarbonsDescriptors.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr> </table> </div> <p> </p> <h2>NAME</h2> <p>Fsp3CarbonsDescriptors</p> <p> </p> <h2>SYNOPSIS</h2> <p>use MolecularDescriptors::Fsp3CarbonsDescriptors;</p> <p>use MolecularDescriptors::Fsp3CarbonsDescriptors qw(:all);</p> <p> </p> <h2>DESCRIPTION</h2> <p><strong>Fsp3CarbonsDescriptors</strong> class provides the following methods:</p> <p> <a href="#new">new</a>, <a href="#generatedescriptors">GenerateDescriptors</a>, <a href="#getdescriptornames">GetDescriptorNames</a>, <a href="#stringifyfsp3carbonsdescriptors">StringifyFsp3CarbonsDescriptors</a> </p><p><strong>Fsp3CarbonsDescriptors</strong> is derived from <strong>MolecularDescriptors</strong> class which in turn is derived from <strong>ObjectProperty</strong> base class that provides methods not explicitly defined in <strong>Fsp3CarbonsDescriptors</strong>, <strong>MolecularDescriptors</strong> or <strong>ObjectProperty</strong> classes using Perl's AUTOLOAD functionality. These methods are generated on-the-fly for a specified object property:</p> <div class="OptionsBox"> Set<PropertyName>(<PropertyValue>); <br/> $PropertyValue = Get<PropertyName>(); <br/> Delete<PropertyName>();</div> <p>Fraction sp3 carbons (Fsp3Carbons) [ Ref 115-116, Ref 119 ] value is calculated by dividing the number of sp3 carbons (Sp3Carbons) with the total number of carbons in a molecule.</p> <p> </p> <h2>METHODS</h2> <dl> <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt> <dd> <div class="OptionsBox"> $NewFsp3CarbonsDescriptors = new MolecularDescriptors:: Fsp3CarbonsDescriptors(%NamesAndValues);</div> <p>Using specified <em>Fsp3CarbonsDescriptors</em> property names and values hash, <strong>new</strong> method creates a new object and returns a reference to newly created <strong>Fsp3CarbonsDescriptors</strong> object. By default, the following properties are initialized:</p> <div class="OptionsBox"> Molecule = '' <br/> Type = 'Fsp3Carbons' <br/> @DescriptorNames = ('Fsp3Carbons', 'Sp3Carbons') <br/> @DescriptorValues = ('None', 'None')</div> <p>Examples:</p> <div class="OptionsBox"> $Fsp3CarbonsDescriptors = new MolecularDescriptors::Fsp3CarbonsDescriptors( 'Molecule' => $Molecule);</div> <div class="OptionsBox"> $Fsp3CarbonsDescriptors = new MolecularDescriptors::Fsp3CarbonsDescriptors();</div> <div class="OptionsBox"> $Fsp3CarbonsDescriptors->SetMolecule($Molecule); <br/> $Fsp3CarbonsDescriptors->GenerateDescriptors(); <br/> print "Fsp3CarbonsDescriptors: $Fsp3CarbonsDescriptors\n";</div> </dd> <dt><strong><a name="generatedescriptors" class="item"><strong>GenerateDescriptors</strong></a></strong></dt> <dd> <div class="OptionsBox"> $Fsp3CarbonsDescriptors->GenerateDescriptors();</div> <p>Calculates Fsp3Carbons and Sp3Carbons values for a molecule and returns <em>Fsp3CarbonsDescriptors</em>.</p> </dd> <dt><strong><a name="getdescriptornames" class="item"><strong>GetDescriptorNames</strong></a></strong></dt> <dd> <div class="OptionsBox"> @DescriptorNames = $Fsp3CarbonsDescriptors->GetDescriptorNames(); <br/> @DescriptorNames = MolecularDescriptors::Fsp3CarbonsDescriptors:: GetDescriptorNames();</div> <p>Returns all available descriptor names as an array.</p> </dd> <dt><strong><a name="stringifyfsp3carbonsdescriptors" class="item"><strong>StringifyFsp3CarbonsDescriptors</strong></a></strong></dt> <dd> <div class="OptionsBox"> $String = $Fsp3CarbonsDescriptors->StringifyFsp3CarbonsDescriptors();</div> <p>Returns a string containing information about <em>Fsp3CarbonsDescriptors</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="./MolecularDescriptors.html">MolecularDescriptors.pm</a>, <a href="./MolecularDescriptorsGenerator.html">MolecularDescriptorsGenerator.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="./AtomsCountDescriptors.html" title="AtomsCountDescriptors.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./HydrogenBondsDescriptors.html" title="HydrogenBondsDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>MolecularDescriptors::Fsp3CarbonsDescriptors.pm</strong></td></tr> </table> </div> <br /> <center> <img src="../../images/h2o2.png"> </center> </body> </html>