annotate docs/modules/txt/RotatableBondsDescriptors.txt @ 3:90ea638ce878 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:11:59 -0500
parents 2abf0d43254d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
2 RotatableBondsDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
3
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularDescriptors::RotatableBondsDescriptors;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
6
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularDescriptors::RotatableBondsDescriptors qw(:all);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
8
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
10 RotatableBondsDescriptors class provides the following methods:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
11
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
12 new, GenerateDescriptors, GetDescriptorNames,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
13 StringifyRotatableBondsDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
14
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
15 RotatableBondsDescriptors is derived from MolecularDescriptors class
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
16 which in turn is derived from ObjectProperty base class that provides
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
17 methods not explicitly defined in RotatableBondsDescriptors,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
18 MolecularDescriptors or ObjectProperty classes using Perl's AUTOLOAD
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
19 functionality. These methods are generated on-the-fly for a specified
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
20 object property:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
21
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
22 Set<PropertyName>(<PropertyValue>);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
23 $PropertyValue = Get<PropertyName>();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
24 Delete<PropertyName>();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
25
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
26 A rotatable bond [ Ref 92 ] is defined as any single bond which is not
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
27 in a ring and involves only non-hydrogen atoms. By default, the
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
28 following types of single bonds are not considered rotatable bonds:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
29
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
30 o Terminal bonds
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
31 o Bonds attached to triple bonds
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
32 o Amide C-N bonds
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
33 o Thioamide C-N bond bonds
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
34 o Sulfonamide S-N bonds
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
35
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
36 METHODS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
37 new
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
38 $RotatableBondsDescriptors = new MolecularDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
39 RotatableBondsDescriptors(
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
40 %NamesAndValues);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
41
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
42 Using specified *RotatableBondsDescriptors* property names and
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
43 values hash, new method creates a new object and returns a reference
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
44 to newly created RotatableBondsDescriptors object. By default, the
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
45 following properties are initialized:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
46
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
47 Molecule = ''
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
48 Type = 'RotatableBonds'
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
49 IgnoreTerminalBonds = 1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
50 IgnoreBondsToTripleBonds = 1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
51 IgnoreAmideBonds = 1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
52 IgnoreThioamideBonds = 1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
53 IgnoreSulfonamideBonds = 1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
54 @DescriptorNames = ('RotatableBonds')
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
55 @DescriptorValues = ('None')
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
56
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
57 Examples:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
58
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
59 $RotatableBondsDescriptors = new MolecularDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
60 RotatableBondsDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
61
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
62 $RotatableBondsDescriptors = new MolecularDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
63 RotatableBondsDescriptors(
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
64 'IgnoreAmideBonds' => 0,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
65 'IgnoreThioamideBonds' => 0,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
66 'IgnoreSulfonamideBonds' => 0);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
67
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
68 $RotatableBondsDescriptors->SetMolecule($Molecule);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
69 $RotatableBondsDescriptors->GenerateDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
70 print "RotatableBondsDescriptors: $RotatableBondsDescriptors\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
71
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
72 GenerateDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
73 $RotatableBondsDescriptors->GenerateDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
74
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
75 Calculates number of rotatable bonds descriptors in a molecule and
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
76 returns *RotatableBondsDescriptors*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
77
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
78 GetDescriptorNames
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
79 @DescriptorNames = $RotatableBondsDescriptors->GetDescriptorNames();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
80 @DescriptorNames = MolecularDescriptors::RotatableBondsDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
81 GetDescriptorNames();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
82
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
83 Returns all available descriptor names as an array.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
84
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
85 StringifyRotatableBondsDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
86 $String = $RotatableBondsDescriptors->StringifyRotatableBondsDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
87
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
88 Returns a string containing information about
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
89 *RotatableBondsDescriptors* object.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
90
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
91 AUTHOR
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
92 Manish Sud <msud@san.rr.com>
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
93
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
94 SEE ALSO
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
95 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
96
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
97 COPYRIGHT
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
98 Copyright (C) 2015 Manish Sud. All rights reserved.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
99
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
100 This file is part of MayaChemTools.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
101
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
102 MayaChemTools is free software; you can redistribute it and/or modify it
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
103 under the terms of the GNU Lesser General Public License as published by
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
104 the Free Software Foundation; either version 3 of the License, or (at
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
105 your option) any later version.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
106