annotate docs/modules/txt/HydrogenBondsDescriptors.txt @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 HydrogenBondsDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularDescriptors::HydrogenBondsDescriptors;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularDescriptors::HydrogenBondsDescriptors qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 HydrogenBondsDescriptors class provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 new, GenerateDescriptors, GetDescriptorNames, SetHydrogenBondsType,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 StringifyHydrogenBondsDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 HydrogenBondsDescriptors is derived from MolecularDescriptors class
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 which in turn is derived from ObjectProperty base class that provides
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 methods not explicitly defined in HydrogenBondsDescriptors,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 MolecularDescriptors or ObjectProperty classes using Perl's AUTOLOAD
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 functionality. These methods are generated on-the-fly for a specified
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 object property:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 Set<PropertyName>(<PropertyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 $PropertyValue = Get<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 Delete<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 The current release of MayaChemTools supports identification of two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 types of hydrogen bond donor and acceptor atoms with these names:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 HBondsType1 or HydrogenBondsType1
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 HBondsType2 or HydrogenBondsType2
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 The names of these hydrogen bond types are rather arbitrary. However,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 their definitions have specific meaning and are as follows:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 HydrogenBondsType1 [ Ref 60-61, Ref 65-66 ]:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 Donor: NH, NH2, OH - Any N and O with available H
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 Acceptor: N[!H], O - Any N without available H and any O
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 HydrogenBondsType2 [ Ref 91 ]:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 Donor: NH, NH2, OH - N and O with available H
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 Acceptor: N, O - And N and O
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 By default, *HydrogenBondsType2* is used to calculate number hydrogen
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 bond donor and acceptor atoms. This corresponds to RuleOf5 definition of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 hydrogen bond donors and acceptors.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 $HydrogenBondsDescriptors = new MolecularDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 HydrogenBondsDescriptors(%NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 Using specified *HydrogenBondsDescriptors* property names and values
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 hash, new method creates a new object and returns a reference to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 newly created HydrogenBondsDescriptors object. By default, the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 following properties are initialized:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 Molecule = ''
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 Type = 'HydrogenBonds'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 HydrogenBondsType = 'HBondsType2'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 @DescriptorNames = ('HydrogenBondDonors', 'HydrogenBondAcceptors')
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 @DescriptorValues = ('None', 'None')
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 $HydrogenBondsDescriptors = new MolecularDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 HydrogenBondsDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 $HydrogenBondsDescriptors = new MolecularDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 HydrogenBondsDescriptors(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 'HydrogenBondsType' => 'HBondsType2');
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 $HydrogenBondsDescriptors->SetMolecule($Molecule);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 $HydrogenBondsDescriptors->GenerateDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 print "HydrogenBondsDescriptors: $HydrogenBondsDescriptors\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 GenerateDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 $HydrogenBondsDescriptors->GenerateDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 Calculates number of hydrogen bond donors and acceptors a molecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 and returns *HydrogenBondsDescriptors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 GetDescriptorNames
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 @DescriptorNames = $HydrogenBondsDescriptors->GetDescriptorNames();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 @DescriptorNames = MolecularDescriptors::HydrogenBondsDescriptors::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 GetDescriptorNames();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 Returns all available descriptor names as an array.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 SetHydrogenBondsType
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 $HydrogenBondsDescriptors->SetHydrogenBondsType($HBondsType);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 Sets value of hydrogen bonds type to use during calculation of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 descriptors and returns *HydrogenBondsDescriptors*. Possible values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 *HBondsType1, HydrogenBondsType1, HBondsType2, HydrogenBondsType2*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 StringifyHydrogenBondsDescriptors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 $String = $HydrogenBondsDescriptors->
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 StringifyHydrogenBondsDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 Returns a string containing information about
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 *HydrogenBondsDescriptors* object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120