Mercurial > repos > deepakjadmin > mayatool3_test2

comparison docs/modules/html/code/ConversionsUtil.html @ 0:4816e4a8ae95 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4816e4a8ae95
1 <html>
2 <head>
3 <title>MayaChemTools:Code:ConversionsUtil.pm</title>
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
5 <link rel="stylesheet" type="text/css" href="../../../css/MayaChemToolsCode.css">
6 </head>
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
8 <br/>
9 <center>
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
11 </center>
12 <br/>
13 <pre>
14 <a name="package-ConversionsUtil-"></a> 1 <span class="k">package </span><span class="i">ConversionsUtil</span><span class="sc">;</span>
15 2 <span class="c">#</span>
16 3 <span class="c"># $RCSfile: ConversionsUtil.pm,v $</span>
17 4 <span class="c"># $Date: 2015/02/28 20:47:02 $</span>
18 5 <span class="c"># $Revision: 1.22 $</span>
19 6 <span class="c">#</span>
20 7 <span class="c"># Author: Manish Sud &lt;msud@san.rr.com&gt;</span>
21 8 <span class="c">#</span>
22 9 <span class="c"># Copyright (C) 2015 Manish Sud. All rights reserved.</span>
23 10 <span class="c">#</span>
24 11 <span class="c"># This file is part of MayaChemTools.</span>
25 12 <span class="c">#</span>
26 13 <span class="c"># MayaChemTools is free software; you can redistribute it and/or modify it under</span>
27 14 <span class="c"># the terms of the GNU Lesser General Public License as published by the Free</span>
28 15 <span class="c"># Software Foundation; either version 3 of the License, or (at your option) any</span>
29 16 <span class="c"># later version.</span>
30 17 <span class="c">#</span>
31 18 <span class="c"># MayaChemTools is distributed in the hope that it will be useful, but without</span>
32 19 <span class="c"># any warranty; without even the implied warranty of merchantability of fitness</span>
33 20 <span class="c"># for a particular purpose. See the GNU Lesser General Public License for more</span>
34 21 <span class="c"># details.</span>
35 22 <span class="c">#</span>
36 23 <span class="c"># You should have received a copy of the GNU Lesser General Public License</span>
37 24 <span class="c"># along with MayaChemTools; if not, see &lt;http://www.gnu.org/licenses/&gt; or</span>
38 25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span>
39 26 <span class="c"># Boston, MA, 02111-1307, USA.</span>
40 27 <span class="c">#</span>
41 28
42 29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span>
43 30 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span>
44 31 <span class="k">use</span> <span class="w">Constants</span><span class="sc">;</span>
45 32
46 33 <span class="k">use</span> <span class="w">vars</span> <span class="q">qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS)</span><span class="sc">;</span>
47 34
48 35 <span class="i">@ISA</span> = <span class="q">qw(Exporter)</span><span class="sc">;</span>
49 36
50 37 <span class="c"># Groups of conversion functions...</span>
51 38 <span class="k">my</span><span class="s">(</span><span class="i">@MathConversions</span><span class="s">)</span> = <span class="q">qw(DegreesToRadians RadiansToDegrees)</span><span class="sc">;</span>
52 39 <span class="k">my</span><span class="s">(</span><span class="i">@NumericBaseConversions</span><span class="s">)</span> = <span class="q">qw(BinaryToDecimal DecimalToBinary HexadecimalToDecimal DecimalToHexadecimal OctalToDecimal DecimalToOctal BinaryToHexadecimal HexadecimalToBinary HexadecimalToOctal OctalToHexadecimal StringToBinary StringToHexadecimal)</span><span class="sc">;</span>
53 40
54 41 <span class="c"># Export all conversion functions...</span>
55 42 <span class="i">@EXPORT</span> = <span class="s">(</span><span class="i">@MathConversions</span><span class="cm">,</span> <span class="i">@NumericBaseConversions</span><span class="s">)</span><span class="sc">;</span>
56 43 <span class="i">@EXPORT_OK</span> = <span class="q">qw()</span><span class="sc">;</span>
57 44
58 45 <span class="i">%EXPORT_TAGS</span> = <span class="s">(</span>
59 46 <span class="w">math</span> <span class="cm">=&gt;</span> <span class="s">[</span><span class="i">@MathConversions</span><span class="s">]</span><span class="cm">,</span>
60 47 <span class="w">all</span> <span class="cm">=&gt;</span> <span class="s">[</span><span class="i">@EXPORT</span><span class="cm">,</span> <span class="i">@EXPORT_OK</span><span class="s">]</span>
61 48 <span class="s">)</span><span class="sc">;</span>
62 49
63 50
64 51 <span class="c"># Degrees to radians...</span>
65 <a name="DegreesToRadians-"></a> 52 <span class="k">sub </span><span class="m">DegreesToRadians ($;$)</span> <span class="s">{</span>
66 53 <span class="k">my</span><span class="s">(</span><span class="i">$Degrees</span><span class="cm">,</span> <span class="i">$IgnoreWrap</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
67 54 <span class="k">my</span><span class="s">(</span><span class="i">$Radians</span><span class="cm">,</span> <span class="i">$WrapValue</span><span class="s">)</span><span class="sc">;</span>
68 55
69 56 <span class="i">$WrapValue</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$IgnoreWrap</span><span class="s">)</span> &amp;&amp; <span class="i">$IgnoreWrap</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span>
70 57 <span class="k">if</span> <span class="s">(</span><span class="i">$Degrees</span> &gt; <span class="n">360</span> &amp;&amp; <span class="i">$WrapValue</span><span class="s">)</span> <span class="s">{</span>
71 58 <span class="i">$Degrees</span> = <span class="i">$Degrees</span> % <span class="n">360</span><span class="sc">;</span>
72 59 <span class="s">}</span>
73 60 <span class="i">$Radians</span> = <span class="s">(</span><span class="i">$Degrees</span> * <span class="w">TwoPi</span><span class="s">)</span> / <span class="n">360</span><span class="sc">;</span>
74 61
75 62 <span class="k">return</span> <span class="i">$Radians</span><span class="sc">;</span>
76 63 <span class="s">}</span>
77 64
78 65 <span class="c"># Radians to degrees...</span>
79 <a name="RadiansToDegrees-"></a> 66 <span class="k">sub </span><span class="m">RadiansToDegrees ($;$)</span> <span class="s">{</span>
80 67 <span class="k">my</span><span class="s">(</span><span class="i">$Radians</span><span class="cm">,</span> <span class="i">$IgnoreWrap</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
81 68 <span class="k">my</span><span class="s">(</span><span class="i">$Degrees</span><span class="cm">,</span> <span class="i">$WrapValue</span><span class="s">)</span><span class="sc">;</span>
82 69
83 70 <span class="i">$WrapValue</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$IgnoreWrap</span><span class="s">)</span> &amp;&amp; <span class="i">$IgnoreWrap</span><span class="s">)</span> ? <span class="n">0</span> <span class="co">:</span> <span class="n">1</span><span class="sc">;</span>
84 71 <span class="i">$Degrees</span> = <span class="s">(</span><span class="i">$Radians</span> * <span class="n">360</span><span class="s">)</span> / <span class="w">TwoPi</span><span class="sc">;</span>
85 72 <span class="k">if</span> <span class="s">(</span><span class="i">$Degrees</span> &gt; <span class="n">360</span> &amp;&amp; <span class="i">$WrapValue</span><span class="s">)</span> <span class="s">{</span>
86 73 <span class="i">$Degrees</span> = <span class="i">$Degrees</span> % <span class="n">360</span><span class="sc">;</span>
87 74 <span class="s">}</span>
88 75
89 76 <span class="k">return</span> <span class="i">$Degrees</span><span class="sc">;</span>
90 77 <span class="s">}</span>
91 78
92 79 <span class="c"># Convert a binary string to a decimal number...</span>
93 <a name="BinaryToDecimal-"></a> 80 <span class="k">sub </span><span class="m">BinaryToDecimal ($)</span> <span class="s">{</span>
94 81 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
95 82
96 83 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^0b/</span><span class="s">)</span> <span class="s">{</span>
97 84 <span class="i">$Value</span> = <span class="q">&quot;0b${Value}&quot;</span><span class="sc">;</span>
98 85 <span class="s">}</span>
99 86 <span class="k">return</span> <span class="i">_ConvertToDecimal</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
100 87 <span class="s">}</span>
101 88
102 89 <span class="c"># Convert a decimal number into a binary string...</span>
103 <a name="DecimalToBinary-"></a> 90 <span class="k">sub </span><span class="m">DecimalToBinary ($)</span> <span class="s">{</span>
104 91 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
105 92
106 93 <span class="k">return</span> <span class="k">sprintf</span><span class="s">(</span><span class="q">&quot;%b&quot;</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
107 94 <span class="s">}</span>
108 95
109 96 <span class="c"># Convert a hexadecimal string to a decimal number...</span>
110 <a name="HexadecimalToDecimal-"></a> 97 <span class="k">sub </span><span class="m">HexadecimalToDecimal ($)</span> <span class="s">{</span>
111 98 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
112 99
113 100 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^0x/</span><span class="s">)</span> <span class="s">{</span>
114 101 <span class="i">$Value</span> = <span class="q">&quot;0x${Value}&quot;</span><span class="sc">;</span>
115 102 <span class="s">}</span>
116 103 <span class="k">return</span> <span class="i">_ConvertToDecimal</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
117 104 <span class="s">}</span>
118 105
119 106 <span class="c"># Convert a decimal number into a hexadecimal string...</span>
120 <a name="DecimalToHexadecimal-"></a> 107 <span class="k">sub </span><span class="m">DecimalToHexadecimal ($)</span> <span class="s">{</span>
121 108 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
122 109
123 110 <span class="k">return</span> <span class="k">sprintf</span><span class="s">(</span><span class="q">&quot;%x&quot;</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
124 111 <span class="s">}</span>
125 112
126 113 <span class="c"># Convert an octal string to a decimal number...</span>
127 <a name="OctalToDecimal-"></a> 114 <span class="k">sub </span><span class="m">OctalToDecimal ($)</span> <span class="s">{</span>
128 115 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
129 116
130 117 <span class="k">if</span> <span class="s">(</span><span class="i">$Value</span> !~ <span class="q">/^0/</span><span class="s">)</span> <span class="s">{</span>
131 118 <span class="i">$Value</span> = <span class="q">&quot;0${Value}&quot;</span><span class="sc">;</span>
132 119 <span class="s">}</span>
133 120 <span class="k">return</span> <span class="i">_ConvertToDecimal</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
134 121 <span class="s">}</span>
135 122
136 123 <span class="c"># Convert a decimal number into an octal string...</span>
137 <a name="DecimalToOctal-"></a> 124 <span class="k">sub </span><span class="m">DecimalToOctal ($)</span> <span class="s">{</span>
138 125 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
139 126
140 127 <span class="k">return</span> <span class="k">sprintf</span><span class="s">(</span><span class="q">&quot;%o&quot;</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
141 128 <span class="s">}</span>
142 129
143 130 <span class="c"># Convert string into a binary string. Going from left to right, two ways of arranging bits</span>
144 131 <span class="c"># inside each byte are available: Most Significat Bits (MSB) first or Least Significat Bits (LSB)</span>
145 132 <span class="c"># first. Default is MSB corresponding to descending bits order (PerlSpeak) inside each</span>
146 133 <span class="c"># each packed byte (Most singificat bits first).</span>
147 134 <span class="c">#</span>
148 <a name="StringToBinary-"></a> 135 <span class="k">sub </span><span class="m">StringToBinary ($;$)</span> <span class="s">{</span>
149 136 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="cm">,</span> <span class="i">$UseReverseBitOrder</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
150 137 <span class="k">my</span><span class="s">(</span><span class="i">$BinTemplate</span><span class="s">)</span><span class="sc">;</span>
151 138
152 139 <span class="i">$BinTemplate</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$UseReverseBitOrder</span><span class="s">)</span> &amp;&amp; <span class="i">$UseReverseBitOrder</span><span class="s">)</span> ? <span class="q">&#39;b*&#39;</span> <span class="co">:</span> <span class="q">&#39;B*&#39;</span><span class="sc">;</span>
153 140 <span class="k">return</span> <span class="k">unpack</span><span class="s">(</span><span class="i">$BinTemplate</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
154 141 <span class="s">}</span>
155 142
156 143 <span class="c"># Convert string into a hexadecimal string. Two ways of arranging nybbles (pair of 4 bits in each</span>
157 144 <span class="c"># byte) are available: high nybbles first or low nybbles first. Default is MSB corresponding to high</span>
158 145 <span class="c"># nybbles (PerlSpeak) first. Low and high nybbles correspond to pair of a low and high four bits in a byte.</span>
159 146 <span class="c">#</span>
160 <a name="StringToHexadecimal-"></a> 147 <span class="k">sub </span><span class="m">StringToHexadecimal ($;$)</span> <span class="s">{</span>
161 148 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="cm">,</span> <span class="i">$UseReverseBitOrder</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
162 149 <span class="k">my</span><span class="s">(</span><span class="i">$HexTemplate</span><span class="s">)</span><span class="sc">;</span>
163 150
164 151 <span class="i">$HexTemplate</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$UseReverseBitOrder</span><span class="s">)</span> &amp;&amp; <span class="i">$UseReverseBitOrder</span><span class="s">)</span> ? <span class="q">&#39;h*&#39;</span> <span class="co">:</span> <span class="q">&#39;H*&#39;</span><span class="sc">;</span>
165 152 <span class="k">return</span> <span class="k">unpack</span><span class="s">(</span><span class="i">$HexTemplate</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
166 153 <span class="s">}</span>
167 154
168 155 <span class="c"># Convert a binary string into a hexadecimal string...</span>
169 156 <span class="c">#</span>
170 <a name="BinaryToHexadecimal-"></a> 157 <span class="k">sub </span><span class="m">BinaryToHexadecimal ($;$)</span> <span class="s">{</span>
171 158 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="cm">,</span> <span class="i">$UseReverseBitOrder</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
172 159 <span class="k">my</span><span class="s">(</span><span class="i">$BinTemplate</span><span class="cm">,</span> <span class="i">$HexTemplate</span><span class="s">)</span><span class="sc">;</span>
173 160
174 161 <span class="i">$BinTemplate</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$UseReverseBitOrder</span><span class="s">)</span> &amp;&amp; <span class="i">$UseReverseBitOrder</span><span class="s">)</span> ? <span class="q">&#39;b*&#39;</span> <span class="co">:</span> <span class="q">&#39;B*&#39;</span><span class="sc">;</span>
175 162 <span class="i">$HexTemplate</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$UseReverseBitOrder</span><span class="s">)</span> &amp;&amp; <span class="i">$UseReverseBitOrder</span><span class="s">)</span> ? <span class="q">&#39;h*&#39;</span> <span class="co">:</span> <span class="q">&#39;H*&#39;</span><span class="sc">;</span>
176 163
177 164 <span class="k">return</span> <span class="k">unpack</span><span class="s">(</span><span class="i">$HexTemplate</span><span class="cm">,</span> <span class="k">pack</span><span class="s">(</span><span class="i">$BinTemplate</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="s">)</span><span class="sc">;</span>
178 165 <span class="s">}</span>
179 166
180 167 <span class="c"># Convert a hexadecimal string into a binary string...</span>
181 168 <span class="c">#</span>
182 <a name="HexadecimalToBinary-"></a> 169 <span class="k">sub </span><span class="m">HexadecimalToBinary ($;$)</span> <span class="s">{</span>
183 170 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="cm">,</span> <span class="i">$UseReverseBitOrder</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
184 171 <span class="k">my</span><span class="s">(</span><span class="i">$BinTemplate</span><span class="cm">,</span> <span class="i">$HexTemplate</span><span class="s">)</span><span class="sc">;</span>
185 172
186 173 <span class="i">$BinTemplate</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$UseReverseBitOrder</span><span class="s">)</span> &amp;&amp; <span class="i">$UseReverseBitOrder</span><span class="s">)</span> ? <span class="q">&#39;b*&#39;</span> <span class="co">:</span> <span class="q">&#39;B*&#39;</span><span class="sc">;</span>
187 174 <span class="i">$HexTemplate</span> = <span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$UseReverseBitOrder</span><span class="s">)</span> &amp;&amp; <span class="i">$UseReverseBitOrder</span><span class="s">)</span> ? <span class="q">&#39;h*&#39;</span> <span class="co">:</span> <span class="q">&#39;H*&#39;</span><span class="sc">;</span>
188 175
189 176 <span class="k">return</span> <span class="k">unpack</span><span class="s">(</span><span class="i">$BinTemplate</span><span class="cm">,</span> <span class="k">pack</span><span class="s">(</span><span class="i">$HexTemplate</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="s">)</span><span class="sc">;</span>
190 177 <span class="s">}</span>
191 178
192 179 <span class="c"># Convert a hexadecimal string into a octal string...</span>
193 180 <span class="c">#</span>
194 <a name="HexadecimalToOctal-"></a> 181 <span class="k">sub </span><span class="m">HexadecimalToOctal</span> <span class="s">{</span>
195 182 <span class="k">my</span><span class="s">(</span><span class="i">$Hexadecimal</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
196 183
197 184 <span class="k">return</span> <span class="i">DecimalToOctal</span><span class="s">(</span><span class="i">HexadecimalToDecimal</span><span class="s">(</span><span class="i">$Hexadecimal</span><span class="s">)</span><span class="s">)</span><span class="sc">;</span>
198 185 <span class="s">}</span>
199 186
200 187 <span class="c"># Convert a octal string into a hexadecimal string...</span>
201 188 <span class="c">#</span>
202 <a name="OctalToHexadecimal-"></a> 189 <span class="k">sub </span><span class="m">OctalToHexadecimal</span> <span class="s">{</span>
203 190 <span class="k">my</span><span class="s">(</span><span class="i">$Octal</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
204 191
205 192 <span class="k">return</span> <span class="i">DecimalToHexadecimal</span><span class="s">(</span><span class="i">OctalToDecimal</span><span class="s">(</span><span class="i">$Octal</span><span class="s">)</span><span class="s">)</span><span class="sc">;</span>
206 193 <span class="s">}</span>
207 194
208 195 <span class="c"># Use Perl oct function to convert binary, octal or hexadecimal strings into decimal numbers.</span>
209 <a name="_ConvertToDecimal-"></a> 196 <span class="k">sub </span><span class="m">_ConvertToDecimal ($)</span> <span class="s">{</span>
210 197 <span class="k">my</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
211 198
212 199 <span class="k">return</span> <span class="s">(</span><span class="i">$Value</span> =~ <span class="q">/^0/</span><span class="s">)</span> ? <span class="k">oct</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span> <span class="co">:</span> <span class="i">$Value</span><span class="sc">;</span>
213 200 <span class="s">}</span>
214 201
215 <a name="EOF-"></a></pre>
216 <p>&nbsp;</p>
217 <br />
218 <center>
219 <img src="../../../images/h2o2.png">
220 </center>
221 </body>
222 </html>