pm_mathNumSys::getDecimal Interface Reference

Generate the decimal value corresponding to the input numeral string in the requested base. More...

Detailed Description

Generate the decimal value corresponding to the input numeral string in the requested base.

Parameters

[in]	numeral	: The input scalar, or array of the same shape as other array-like arguments, of type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU), containing the input value in an arbitrary numeral system. The input numeral must be non-empty and contain only ASCII digital and the first max(base-10,0) upper-case English characters.
[in]	base	: The input scalar, or array of the same shape as other array-like arguments, of type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64) containing the base of the numeral system of the input numeral.

Returns

decimal : The output scalar, or array of the same shape as array-like input arguments, of the same type and kind as the input base containing the decimal value corresponding to the input numeral in the specified base.

Possible calling interfaces ⛓

use pm_mathNumSys, only: getDecimal
 
decimal = getDecimal(numeral, base)

Warning

The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.

Remarks

The procedures under discussion are elemental.

Warning

The input base must be a positive integer larger than 1.
The input numeral must be non-empty and contain only ASCII digital and the first max(base-10,0) upper-case English characters.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

While base can be arbitrarily large, the specific integer kind used for base may be insufficient for the returned decimal value.
This can lead to integer overflows that may remain unnoticed in non-debug library builds if numeral or base is too large for the specified kind of decimal.
Additionally, keep in mind that there are only 36 symbols for numeral system digits that can fully cover all numbers up to base 36.
It is the responsibility of the user to ensure the specified kind for the input decimal is sufficient for the output decimal value.

See also

getNumeral

Example usage ⛓

program example
 
    use pm_kind, only: SK
    use pm_kind, only: IK ! All processor integer kinds are supported.
    use pm_io, only: display_type
    use pm_mathNumSys, only: getDecimal, getNumeral
 
    implicit none
 
    integer(IK) :: i
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Generate the decimal equivalent of the input numeral in the specified `base`.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDecimal(SK_'FFFFFF', 16_IK)")
    call disp%show( getDecimal(SK_'FFFFFF', 16_IK) )
    call disp%show("getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK)")
    call disp%show( getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDecimal(SK_'1010011010', 2_IK)")
    call disp%show( getDecimal(SK_'1010011010', 2_IK) )
    call disp%show("getNumeral(getDecimal(SK_'1010011010', base = 2_IK), base = 2_IK)")
    call disp%show( getNumeral(getDecimal(SK_'1010011010', base = 2_IK), base = 2_IK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("huge(1_IK)")
    call disp%show( huge(1_IK) )
    call disp%show("getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK)")
    call disp%show( getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK) )
    call disp%show("getNumeral(huge(1_IK), base = 36_IK)")
    call disp%show( getNumeral(huge(1_IK), base = 36_IK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getDecimal([SK_'00', SK_'01', SK_'10', SK_'11'], base = 2_IK)")
    call disp%show( getDecimal([SK_'00', SK_'01', SK_'10', SK_'11'], base = 2_IK) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Generate the decimal equivalent of the input numeral in the specified `base`.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
getDecimal(SK_'FFFFFF', 16_IK)
+16777215
getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK)
"FFFFFF"
 
 
getDecimal(SK_'1010011010', 2_IK)
+666
getNumeral(getDecimal(SK_'1010011010', base = 2_IK), base = 2_IK)
"1010011010"
 
 
huge(1_IK)
+2147483647
getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK)
+2147483647
getNumeral(huge(1_IK), base = 36_IK)
"ZIK0ZJ"
 
 
getDecimal([SK_'00', SK_'01', SK_'10', SK_'11'], base = 2_IK)
+0, +1, +2, +3
 
 

Test:

test_pm_mathNumSys

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Fatemeh Bagheri, Tuesday 02:49 AM, August 10, 2021, Dallas, TX

Definition at line 96 of file pm_mathNumSys.F90.

---

The documentation for this interface was generated from the following file:

• src/fortran/main/pm_mathNumSys.F90