ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_mathNumSys::getNumeral Interface Reference

Generate the numeral in the specified base corresponding to the input decimal number. More...

Detailed Description

Generate the numeral in the specified base corresponding to the input decimal number.

Parameters
[in]decimal: The input scalar of type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64), containing the input non-negative decimal number to be converted to the requested base.
Note that decimal argument must be passed as value. This is automatically done by the compiler for a Fortran user.
[in]base: The input scalar of type integer of the same kind as the integer kind of decimal, containing the base of the numeral system of the input numeral.
The input base must be larger than 1 and less than 36.
Returns
numeral : The allocatable output scalar character of default kind SK containing the numeral in the specified base, corresponding to the inputdecimal number, comprised of only ASCII digital character and, if base > 10, also possibly the first max(base-10,0) upper-case English characters.


Possible calling interfaces ⛓

use pm_kind, only: SK
use pm_mathNumSys, only: getNumeral
character(:, SK), allocatable :: numeral
numeral = getNumeral(decimal, base)
pm_mathNumSys::getNumeral
Generate the numeral in the specified base corresponding to the input decimal number.
Definition: pm_mathNumSys.F90:501
pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
pm_kind::SK
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
pm_mathNumSys
This module contains procedures and generic interfaces for converting numbers to different bases in d...
Definition: pm_mathNumSys.F90:33
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.
The input base must be a positive integer larger than 1.
The input value 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
getDecimal


Example usage ⛓

1program example
2
3 use pm_kind, only: SK
4 use pm_kind, only: IK ! All processor integer kinds are supported.
5 use pm_io, only: display_type
6 use pm_mathNumSys, only: getDecimal, getNumeral
7
8 implicit none
9
10 integer(IK) :: i
11
12 type(display_type) :: disp
13 disp = display_type(file = "main.out.F90")
14
15 call disp%skip()
16 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
17 call disp%show("! Generate the numeral equivalent of the input decimal in the specified `base`.")
18 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
19 call disp%skip()
20
21 call disp%skip()
22 call disp%show("getDecimal(SK_'FFFFFF', 16_IK)")
23 call disp%show( getDecimal(SK_'FFFFFF', 16_IK) )
24 call disp%show("getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK)")
25 call disp%show( getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK) , deliml = SK_"""" )
26 call disp%skip()
27
28 call disp%skip()
29 call disp%show("huge(1_IK)")
30 call disp%show( huge(1_IK) )
31 call disp%show("getDecimal(SK_'1010011010', 2_IK)")
32 call disp%show( getDecimal(SK_'1010011010', 2_IK) )
33 call disp%show("getNumeral(getDecimal(SK_'1010011010', 2_IK), 2_IK)")
34 call disp%show( getNumeral(getDecimal(SK_'1010011010', 2_IK), 2_IK) , deliml = SK_"""" )
35 call disp%skip()
36
37 call disp%skip()
38 call disp%show("getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK)")
39 call disp%show( getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK) )
40 call disp%show("getNumeral(huge(1_IK), base = 36_IK)")
41 call disp%show( getNumeral(huge(1_IK), base = 36_IK) , deliml = SK_"""" )
42 call disp%skip()
43
44end program example
pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
pm_mathNumSys::getDecimal
Generate the decimal value corresponding to the input numeral string in the requested base.
Definition: pm_mathNumSys.F90:96
pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
pm_kind::IK
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
pm_io::display_type
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler ⛓
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output ⛓
1
2!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3! Generate the numeral equivalent of the input decimal in the specified `base`.
4!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5
6
7getDecimal(SK_'FFFFFF', 16_IK)
8+16777215
9getNumeral(getDecimal(SK_'FFFFFF', 16_IK), 16_IK)
10"FFFFFF"
11
12
13huge(1_IK)
14+2147483647
15getDecimal(SK_'1010011010', 2_IK)
16+666
17getNumeral(getDecimal(SK_'1010011010', 2_IK), 2_IK)
18"1010011010"
19
20
21getDecimal(getNumeral(huge(1_IK), base = 36_IK), 36_IK)
22+2147483647
23getNumeral(huge(1_IK), base = 36_IK)
24"ZIK0ZJ"
25
26
Test:
test_pm_mathNumSys
Bug:

Status: Unresolved
Source: Intel Classic Fortran Compiler ifort version 2021.8.0 20221119
Description: The Intel Classic Fortran Compiler ifort version 2021.8.0 20221119 cannot run the following function call in the examples of getDecimal,
getNumeral(huge(1_IK), base = 36_IK)

yielding the following error,

forrtl: severe (174): SIGSEGV, segmentation fault occurred
image PC Routine Line Source
libc.so.6 000014F31F6D5520 Unknown Unknown Unknown
libparamonte_fort 000014F324F06B7D pm_mathnumsys_MP_ 118 pm_mathNumSys@routines.inc.F90
main.exe 000000000040B21A MAIN__ 39 main.F90
main.exe 000000000040833D Unknown Unknown Unknown
libc.so.6 000014F31F6BCD90 Unknown Unknown Unknown
libc.so.6 000014F31F6BCE40 __libc_start_main Unknown Unknown
main.exe 0000000000408255 Unknown Unknown Unknown

This segmentation fault error resembles the compiler bug observed in getFormat.
It seems to be related to the value attribute of the input argument decimal.

Remedy (as of ParaMonte Library version 2.0.0): For now, the value attribute of the input argument decimal of getNumeral is converted to intent(in) to resolve the compiler bug.

Todo:
Normal Priority: There is a dependency on the kind type parameter of the integer input arguments requiring range(0_IKG) < 1024.
The algorithm must be modified to become kind-agnostic.


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:
Amir Shahmoradi, Tuesday 03:59 AM, August 10, 2021, Dallas, TX

Definition at line 501 of file pm_mathNumSys.F90.

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