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