Generate the decimal value corresponding to the input numeral string in the requested base.
More...
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 ⛓
Generate the decimal value corresponding to the input numeral string in the requested base.
This module contains procedures and generic interfaces for converting numbers to different bases in d...
- 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.
- 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 ⛓
12 type(display_type) :: disp
16 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
17 call disp%show(
"! Generate the decimal equivalent of the input numeral in the specified `base`.")
18 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
22 call disp%show(
"getDecimal(SK_'FFFFFF', 16_IK)")
24 call disp%show(
"getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK)")
29 call disp%show(
"getDecimal(SK_'1010011010', 2_IK)")
31 call disp%show(
"getNumeral(getDecimal(SK_'1010011010', base = 2_IK), base = 2_IK)")
38 call disp%show(
"getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK)")
40 call disp%show(
"getNumeral(huge(1_IK), base = 36_IK)")
45 call disp%show(
"getDecimal([SK_'00', SK_'01', SK_'10', SK_'11'], base = 2_IK)")
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
Generate the numeral in the specified base corresponding to the input decimal number.
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
27getDecimal([SK_
'00', SK_
'01', SK_
'10', SK_
'11'], base
= 2_IK)
- 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.
-
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.
-
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.