annotate mayachemtool/mayachemtools/docs/modules/txt/RotatableBondsDescriptors.txt @ 0:68300206e90d draft default tip

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