annotate mayachemtools/lib/MolecularDescriptors/HydrogenBondsDescriptors.pm @ 5:9a001a14a022 draft

Deleted selected files
author deepakjadmin
date Thu, 15 Dec 2016 14:04:29 -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 package MolecularDescriptors::HydrogenBondsDescriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: HydrogenBondsDescriptors.pm,v $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:49:20 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.18 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 use Carp;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 use Exporter;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 use Scalar::Util ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 use TextUtil ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 use Atom;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 use Molecule;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 use MolecularDescriptors::MolecularDescriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 @ISA = qw(MolecularDescriptors::MolecularDescriptors Exporter);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 @EXPORT = qw();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 @EXPORT_OK = qw(GetDescriptorNames);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 # Setup class variables...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 my($ClassName, @DescriptorNames);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 _InitializeClass();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 # Overload Perl functions...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 use overload '""' => 'StringifyHydrogenBondsDescriptors';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 # Class constructor...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 sub new {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 my($Class, %NamesAndValues) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 # Initialize object...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 my $This = $Class->SUPER::new();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 bless $This, ref($Class) || $Class;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 $This->_InitializeHydrogenBondsDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 $This->_InitializeHydrogenBondsDescriptorsProperties(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 # Initialize class ...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 sub _InitializeClass {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 #Class name...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 $ClassName = __PACKAGE__;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 # Descriptor names...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 @DescriptorNames = ('HydrogenBondDonors', 'HydrogenBondAcceptors');
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 # Get descriptor names as an array.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 # This functionality can be either invoked as a class function or an
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 # object method.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 sub GetDescriptorNames {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 return @DescriptorNames;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 # Initialize object data...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 sub _InitializeHydrogenBondsDescriptors {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 # Type of MolecularDescriptor...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 $This->{Type} = 'HydrogenBonds';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 # The currrent release of MayaChemTools supports identification of two types of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 # hydrogen bond donor and acceptor atoms with these names:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 # HBondsType1 or HydrogenBondsType1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 # HBondsType2 or HydrogenBondsType2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 # The names of these hydrogen bond types are rather arbirary. However, their
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 # definitions have specific meaning and are as follows:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 # HydrogenBondsType1 [ Ref 60-61, Ref 65-66 ]:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 # . Donor: NH, NH2, OH - Any N and O with available H
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 # . Acceptor: N[!H], O - Any N without available H and any O
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 # HydrogenBondsType2 [ Ref 91 ]:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 # . Donor: NH, NH2, OH - N and O with availabe H
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 # . Acceptor: N, O - Add N and O
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 # Note:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 # . HydrogenBondsType2 definition corresponds to Rule of 5.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 $This->{HydrogenBondsType} = 'HBondsType2';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 # Intialize descriptor names and values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 $This->_InitializeDescriptorNamesAndValues(@DescriptorNames);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 # Initialize object properties...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 sub _InitializeHydrogenBondsDescriptorsProperties {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 my($This, %NamesAndValues) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 my($Name, $Value, $MethodName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 while (($Name, $Value) = each %NamesAndValues) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 $MethodName = "Set${Name}";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 $This->$MethodName($Value);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 # Set hydrogen bonds type...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 sub SetHydrogenBondsType {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 my($This, $HydrogenBondsType) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 if ($HydrogenBondsType !~ /^(HBondsType1|HBondsType2|HydrogenBondsType1|HydrogenBondsType2)$/i) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 croak "Error: ${ClassName}->SetHydrogenBondsType: Specified hydrogen bonds type, $HydrogenBondsType, is not supported. Valid values: HBondsType1, HBondsType2, HydrogenBondsType1, HydrogenBondsType2 ...\n ";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 $This->{HydrogenBondsType} = $HydrogenBondsType;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 # Calculate number of hydrogen bond donors and acceptors in a molecule...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 sub GenerateDescriptors {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 # Initialize descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 $This->_InitializeDescriptorValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 # Check availability of molecule...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 if (!$This->{Molecule}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 carp "Warning: ${ClassName}->GenerateDescriptors: $This->{Type} molecular descriptors generation didn't succeed: Molecule data is not available: Molecule object hasn't been set...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 return undef;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 # Calculate descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 if (!$This->_CalculateDescriptorValues()) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 carp "Warning: ${ClassName}->CalculateDescriptorValues: $This->{Type} molecular descriptors generation didn't succeed: Couldn't calculate number of hydrogen bond donor and accepror values...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 return undef;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 # Set final descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 $This->_SetFinalDescriptorValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 # Calculate number of hydrogen bond donors and acceptors...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 sub _CalculateDescriptorValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 my($HydrogenBondDonors, $HydrogenBondAcceptors, $Atom);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 $HydrogenBondDonors = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 $HydrogenBondAcceptors = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 for $Atom ($This->{Molecule}->GetAtoms()) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 if ($Atom->IsHydrogenBondDonor($This->{HydrogenBondsType})) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 $HydrogenBondDonors++;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 if ($Atom->IsHydrogenBondAcceptor($This->{HydrogenBondsType})) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 $HydrogenBondAcceptors++;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 # Track the calculated values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 $This->{HydrogenBondDonors} = $HydrogenBondDonors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 $This->{HydrogenBondAcceptors} = $HydrogenBondAcceptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 # Setup final descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 sub _SetFinalDescriptorValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 $This->{DescriptorsGenerated} = 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 $This->SetDescriptorValues($This->{HydrogenBondDonors}, $This->{HydrogenBondAcceptors});
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 # Return a string containg data for HydrogenBondsDescriptors object...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 sub StringifyHydrogenBondsDescriptors {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 my($HydrogenBondsDescriptorsString);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 $HydrogenBondsDescriptorsString = "MolecularDescriptorType: $This->{Type}; HydrogenBondsType: $This->{HydrogenBondsType}; " . $This->_StringifyDescriptorNamesAndValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 return $HydrogenBondsDescriptorsString;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 # Is it a HydrogenBondsDescriptors object?
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 sub _IsHydrogenBondsDescriptors {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 my($Object) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 return (Scalar::Util::blessed($Object) && $Object->isa($ClassName)) ? 1 : 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 __END__
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 =head1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 HydrogenBondsDescriptors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 =head1 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 use MolecularDescriptors::HydrogenBondsDescriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 use MolecularDescriptors::HydrogenBondsDescriptors qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 =head1 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 B<HydrogenBondsDescriptors> class provides the following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 new, GenerateDescriptors, GetDescriptorNames, SetHydrogenBondsType,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 StringifyHydrogenBondsDescriptors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 B<HydrogenBondsDescriptors> is derived from B<MolecularDescriptors> class which in turn
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252 is derived from B<ObjectProperty> base class that provides methods not explicitly defined
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 in B<HydrogenBondsDescriptors>, B<MolecularDescriptors> or B<ObjectProperty> classes using Perl's
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 AUTOLOAD functionality. These methods are generated on-the-fly for a specified object property:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 Set<PropertyName>(<PropertyValue>);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 $PropertyValue = Get<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258 Delete<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 The current release of MayaChemTools supports identification of two types of hydrogen bond
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 donor and acceptor atoms with these names:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 HBondsType1 or HydrogenBondsType1
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 HBondsType2 or HydrogenBondsType2
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 The names of these hydrogen bond types are rather arbitrary. However, their definitions have
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267 specific meaning and are as follows:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 HydrogenBondsType1 [ Ref 60-61, Ref 65-66 ]:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 Donor: NH, NH2, OH - Any N and O with available H
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 Acceptor: N[!H], O - Any N without available H and any O
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 HydrogenBondsType2 [ Ref 91 ]:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 Donor: NH, NH2, OH - N and O with available H
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 Acceptor: N, O - And N and O
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279 By default, I<HydrogenBondsType2> is used to calculate number hydrogen bond donor
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 and acceptor atoms. This corresponds to B<RuleOf5> definition of hydrogen bond donors
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281 and acceptors.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283 =head2 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285 =over 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287 =item B<new>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289 $HydrogenBondsDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 HydrogenBondsDescriptors(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 Using specified I<HydrogenBondsDescriptors> property names and values hash, B<new>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 method creates a new object and returns a reference to newly created B<HydrogenBondsDescriptors>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 object. By default, the following properties are initialized:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 Molecule = ''
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297 Type = 'HydrogenBonds'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 HydrogenBondsType = 'HBondsType2'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299 @DescriptorNames = ('HydrogenBondDonors', 'HydrogenBondAcceptors')
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 @DescriptorValues = ('None', 'None')
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 Examples:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304 $HydrogenBondsDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 HydrogenBondsDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 $HydrogenBondsDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308 HydrogenBondsDescriptors(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 'HydrogenBondsType' => 'HBondsType2');
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 $HydrogenBondsDescriptors->SetMolecule($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312 $HydrogenBondsDescriptors->GenerateDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 print "HydrogenBondsDescriptors: $HydrogenBondsDescriptors\n";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315 =item B<GenerateDescriptors>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 $HydrogenBondsDescriptors->GenerateDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319 Calculates number of hydrogen bond donors and acceptors a molecule and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 I<HydrogenBondsDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322 =item B<GetDescriptorNames>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 @DescriptorNames = $HydrogenBondsDescriptors->GetDescriptorNames();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325 @DescriptorNames = MolecularDescriptors::HydrogenBondsDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 GetDescriptorNames();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328 Returns all available descriptor names as an array.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330 =item B<SetHydrogenBondsType>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332 $HydrogenBondsDescriptors->SetHydrogenBondsType($HBondsType);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 Sets value of hydrogen bonds type to use during calculation of descriptors and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335 I<HydrogenBondsDescriptors>. Possible values: I<HBondsType1, HydrogenBondsType1,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 HBondsType2, HydrogenBondsType2>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 =item B<StringifyHydrogenBondsDescriptors>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 $String = $HydrogenBondsDescriptors->
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 StringifyHydrogenBondsDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 Returns a string containing information about I<HydrogenBondsDescriptors> object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 =back
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 =head1 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
350
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
351 =head1 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
352
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
353 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
354
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
355 =head1 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
356
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
357 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
358
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
359 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
360
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
361 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
362 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
363 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
364 any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
365
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
366 =cut