annotate mayachemtools/docs/modules/txt/ConversionsUtil.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -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 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 ConversionsUtil
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use ConversionsUtil;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 use ConversionsUtil qw(:math);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 use ConversionsUtil qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 ConversionsUtil module provides the following functions:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 BinaryToDecimal, BinaryToHexadecimal, DecimalToBinary,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 DecimalToHexadecimal, DecimalToOctal, DegreesToRadians,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 HexadecimalToBinary, HexadecimalToDecimal, HexadecimalToOctal,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 OctalToDecimal, OctalToHexadecimal, RadiansToDegrees, StringToBinary,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 StringToHexadecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 FUNCTIONS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 BinaryToDecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 $Decimal = BinaryToDecimal($Binary);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 Converts a *Binary* string to Decimal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 BinaryToHexadecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 $Hexadecimal = BinaryToHexadecimal($Binary);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 Converts a *Binary* string to Hexadecimal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 DecimalToBinary
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 $Binary = DecimalToBinary($Decimal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 Converts a *Decimal* string to Binary string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 DecimalToHexadecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 $Hexadecimal = DecimalToHexadecimal($Decimal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 Converts a *Decimal* string to Hexadecimal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 DecimalToOctal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 $Octal = DecimalToOctal($Decimal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 Converts a *Decimal* string to Octal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 DegreesToRadians
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 $Radians = DegreesToRadians($Degrees, [$DoNotWrapValue]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 Converts degrees to radians in the range from 0 to 2PI or to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 corresponding radians without wrapping the converted value to 0 to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 2PI. Default is to wrap the converted value.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 HexadecimalToBinary
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 $Binary = HexadecimalToBinary($Hexadecimal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 Converts a *Hexadecimal* string to Binary string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 HexadecimalToDecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 $Decimal = HexadecimalToDecimal($Hexadecimal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 Converts a *Hexadecimal* string to Decimal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 HexadecimalToOctal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 $Octal = HexadecimalToOctal($Hexadecimal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 Converts a *Hexadecimal* string to Octal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 OctalToDecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 $Decimal = OctalToDecimal($Octal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 Converts a *Octal* string to Decimal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 OctalToHexadecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 $Hexadecimal = OctalToHexadecimal($Octal);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 Converts a *Octal* string to Hexadecimal string.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 RadiansToDegrees
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 $Degrees = RadiansToDegrees($Radians, [$DoNotWrapValue]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 Converts radians to degrees in the range from 0 to 360 or to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 corresponding degrees without wrapping the converted value to 0 to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 360. Default is to wrap the converted value.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 StringToBinary
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 $BinaryString = StringToBinary($String, [$UseReverseBitOrder]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 Converts specified *String* into a Binarystring. Going from left to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 right, two ways of arranging bits inside each byte are available:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 Most Significat Bits (MSB) first or Least Significat Bits (LSB)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 first. Default is MSB corresponding to descending bits order
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 (PerlSpeak) inside each each packed byte (Most singificat bits
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 first).
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 StringToHexadecimal
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 $HexadecimalString = StringToHexadecimal($String,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 [$UseReverseBitOrder]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 Convert string into a hexadecimal string. Two ways of arranging
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 nybbles (pair of 4 bits in each byte) are available: high nybbles
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 first or low nybbles first. Default is MSB corresponding to high
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 nybbles (PerlSpeak) first. Low and high nybbles correspond to pair
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 of a low and high four bits in a byte.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 Constants.pm, MathUtil.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120