diff docs/modules/txt/ConversionsUtil.txt @ 0:4816e4a8ae95 draft default tip

Uploaded

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/modules/txt/ConversionsUtil.txt	Wed Jan 20 09:23:18 2016 -0500
@@ -0,0 +1,120 @@
+NAME
+    ConversionsUtil
+
+SYNOPSIS
+    use ConversionsUtil;
+
+    use ConversionsUtil qw(:math);
+
+    use ConversionsUtil qw(:all);
+
+DESCRIPTION
+    ConversionsUtil module provides the following functions:
+
+    BinaryToDecimal, BinaryToHexadecimal, DecimalToBinary,
+    DecimalToHexadecimal, DecimalToOctal, DegreesToRadians,
+    HexadecimalToBinary, HexadecimalToDecimal, HexadecimalToOctal,
+    OctalToDecimal, OctalToHexadecimal, RadiansToDegrees, StringToBinary,
+    StringToHexadecimal
+
+  FUNCTIONS
+    BinaryToDecimal
+            $Decimal = BinaryToDecimal($Binary);
+
+        Converts a *Binary* string to Decimal string.
+
+    BinaryToHexadecimal
+            $Hexadecimal = BinaryToHexadecimal($Binary);
+
+        Converts a *Binary* string to Hexadecimal string.
+
+    DecimalToBinary
+            $Binary = DecimalToBinary($Decimal);
+
+        Converts a *Decimal* string to Binary string.
+
+    DecimalToHexadecimal
+            $Hexadecimal = DecimalToHexadecimal($Decimal);
+
+        Converts a *Decimal* string to Hexadecimal string.
+
+    DecimalToOctal
+            $Octal = DecimalToOctal($Decimal);
+
+        Converts a *Decimal* string to Octal string.
+
+    DegreesToRadians
+            $Radians = DegreesToRadians($Degrees, [$DoNotWrapValue]);
+
+        Converts degrees to radians in the range from 0 to 2PI or to
+        corresponding radians without wrapping the converted value to 0 to
+        2PI. Default is to wrap the converted value.
+
+    HexadecimalToBinary
+            $Binary = HexadecimalToBinary($Hexadecimal);
+
+        Converts a *Hexadecimal* string to Binary string.
+
+    HexadecimalToDecimal
+            $Decimal = HexadecimalToDecimal($Hexadecimal);
+
+        Converts a *Hexadecimal* string to Decimal string.
+
+    HexadecimalToOctal
+            $Octal = HexadecimalToOctal($Hexadecimal);
+
+        Converts a *Hexadecimal* string to Octal string.
+
+    OctalToDecimal
+            $Decimal = OctalToDecimal($Octal);
+
+        Converts a *Octal* string to Decimal string.
+
+    OctalToHexadecimal
+            $Hexadecimal = OctalToHexadecimal($Octal);
+
+        Converts a *Octal* string to Hexadecimal string.
+
+    RadiansToDegrees
+            $Degrees = RadiansToDegrees($Radians, [$DoNotWrapValue]);
+
+        Converts radians to degrees in the range from 0 to 360 or to
+        corresponding degrees without wrapping the converted value to 0 to
+        360. Default is to wrap the converted value.
+
+    StringToBinary
+            $BinaryString = StringToBinary($String, [$UseReverseBitOrder]);
+
+        Converts specified *String* into a Binarystring. Going from left to
+        right, two ways of arranging bits inside each byte are available:
+        Most Significat Bits (MSB) first or Least Significat Bits (LSB)
+        first. Default is MSB corresponding to descending bits order
+        (PerlSpeak) inside each each packed byte (Most singificat bits
+        first).
+
+    StringToHexadecimal
+            $HexadecimalString = StringToHexadecimal($String,
+                                 [$UseReverseBitOrder]);
+
+        Convert string into a hexadecimal string. Two ways of arranging
+        nybbles (pair of 4 bits in each byte) are available: high nybbles
+        first or low nybbles first. Default is MSB corresponding to high
+        nybbles (PerlSpeak) first. Low and high nybbles correspond to pair
+        of a low and high four bits in a byte.
+
+AUTHOR
+    Manish Sud <[e-mail]>
+
+SEE ALSO
+    Constants.pm, MathUtil.pm
+
+COPYRIGHT
+    Copyright (C) 2015 Manish Sud. All rights reserved.
+
+    This file is part of MayaChemTools.
+
+    MayaChemTools is free software; you can redistribute it and/or modify it
+    under the terms of the GNU Lesser General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or (at
+    your option) any later version.
+