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

Generate the previous integer exponent expPrev for the specified input base and absolute value absx = abs(x) such that the condition base**expPrev <= absx holds. More...

Detailed Description

Generate the previous integer exponent expPrev for the specified input base and absolute value absx = abs(x) such that the condition base**expPrev <= absx holds.

See the documentation of pm_mathExp for more information.

Parameters
[in]absx: The input scalar (or array of the same rank, shape, and size as other array-like arguments), of either,
  1. type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64), or
  2. type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
representing the absolute value of the number for which the previous integer exponent in specified base must be computed.
[in]base: The input positive scalar (or array of the same rank, shape, and size as other array-like arguments), of the same type and kind as absx, representing the base of the exponentiation.
(optional, default = 2)
Returns
expPrev : The output scalar (or array of the same rank, shape, and size as other array-like arguments) of
  1. type integer of default kind IK if absx is of type real,
  2. type integer of the same kind as absx if absx is of type integer,
containing the previous integer exponent.


Possible calling interfaces

expPrev = getExpPrev(absx, base = base)
Generate the previous integer exponent expPrev for the specified input base and absolute value absx =...
Definition: pm_mathExp.F90:510
This module contains procedures and generic interfaces for computing the previous/next integer expone...
Definition: pm_mathExp.F90:44
Warning
The condition 1 < base must hold.
The condition 0 < absx must hold.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
Note that setting base very near 1 can lead to very large output exponents that overflow the default integer kind IK.
For example, 1.0000001**2147483647 = 1.836644819690732e+93.
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.
Developer Remark:
A real value of kind RK32 can represent integer values as large as huge(1_int128) = 170141183460469231731687303715884105727 = 1.70141183E+38 < huge(1._RK32) = 3.40282347E+38 << huge(1._RK64).
One can envision a distant future human society with advanced computers capable of representing higher precision integer value for which RK32 or RK64 would be insufficient.
See also
isIntPow
getExpNext
getExpPrev


Example usage

1program example
2
3 use pm_kind, only: SK, IK, LK
4 use pm_mathExp, only: getExpPrev
5 use pm_io, only: display_type
6
7 implicit none
8
9 integer(IK), allocatable :: expPrev(:)
10
11 type(display_type) :: disp
12 disp = display_type(file = "main.out.F90")
13
14 allocate(expPrev(1))
15
16 call disp%skip()
17 call disp%show("expPrev(1) = getExpPrev(.5)")
18 expPrev(1) = getExpPrev(.5)
19 call disp%show("expPrev(1)")
20 call disp%show( expPrev(1) )
21 call disp%show("2.**expPrev(1)")
22 call disp%show( 2.**expPrev(1) )
23 call disp%skip()
24
25 call disp%skip()
26 call disp%show("expPrev(1) = getExpPrev(1.5)")
27 expPrev(1) = getExpPrev(1.5)
28 call disp%show("expPrev(1)")
29 call disp%show( expPrev(1) )
30 call disp%show("2.**expPrev(1)")
31 call disp%show( 2.**expPrev(1) )
32 call disp%skip()
33
34 call disp%skip()
35 call disp%show("expPrev(1) = getExpPrev(1.)")
36 expPrev(1) = getExpPrev(1.)
37 call disp%show("expPrev(1)")
38 call disp%show( expPrev(1) )
39 call disp%show("2.**expPrev(1)")
40 call disp%show( 2.**expPrev(1) )
41 call disp%skip()
42
43 call disp%skip()
44 call disp%show("expPrev(1) = getExpPrev(1.1)")
45 expPrev(1) = getExpPrev(1.1)
46 call disp%show("expPrev(1)")
47 call disp%show( expPrev(1) )
48 call disp%show("2.**expPrev(1)")
49 call disp%show( 2.**expPrev(1) )
50 call disp%skip()
51
52 call disp%skip()
53 call disp%show("expPrev = getExpPrev(abs([1, -2, 3, -4, 5, 9, 519]))")
54 expPrev = getExpPrev(abs([1, -2, 3, -4, 5, 9, 519]))
55 call disp%show("expPrev")
56 call disp%show( expPrev )
57 call disp%show("2.**expPrev")
58 call disp%show( 2.**expPrev )
59 call disp%skip()
60
61 call disp%skip()
62 call disp%show("expPrev = getExpPrev(abs([1, -2, 3, -4, 5, 9, 519]), base = 3)")
63 expPrev = getExpPrev(abs([1, -2, 3, -4, 5, 9, 519]), base = 3)
64 call disp%show("expPrev")
65 call disp%show( expPrev )
66 call disp%show("3.**expPrev")
67 call disp%show( 3.**expPrev )
68 call disp%skip()
69
70 call disp%skip()
71 call disp%show("expPrev = getExpPrev(abs([real :: 1, -2, 3, -4, 5, 9, 519]), base = exp(1.))")
72 expPrev = getExpPrev(abs([real :: 1, -2, 3, -4, 5, 9, 519]), base = exp(1.))
73 call disp%show("expPrev")
74 call disp%show( expPrev )
75 call disp%show("exp(1.)**expPrev")
76 call disp%show( exp(1.)**expPrev )
77 call disp%skip()
78
79end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
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
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
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
2expPrev(1) = getExpPrev(.5)
3expPrev(1)
4-1
52.**expPrev(1)
6+0.500000000
7
8
9expPrev(1) = getExpPrev(1.5)
10expPrev(1)
11+0
122.**expPrev(1)
13+1.00000000
14
15
16expPrev(1) = getExpPrev(1.)
17expPrev(1)
18+0
192.**expPrev(1)
20+1.00000000
21
22
23expPrev(1) = getExpPrev(1.1)
24expPrev(1)
25+0
262.**expPrev(1)
27+1.00000000
28
29
30expPrev = getExpPrev(abs([1, -2, 3, -4, 5, 9, 519]))
31expPrev
32+0, +0, +1, +1, +2, +3, +9
332.**expPrev
34+1.00000000, +1.00000000, +2.00000000, +2.00000000, +4.00000000, +8.00000000, +512.000000
35
36
37expPrev = getExpPrev(abs([1, -2, 3, -4, 5, 9, 519]), base = 3)
38expPrev
39+0, +0, +1, +1, +1, +2, +5
403.**expPrev
41+1.00000000, +1.00000000, +3.00000000, +3.00000000, +3.00000000, +9.00000000, +243.000000
42
43
44expPrev = getExpPrev(abs([real :: 1, -2, 3, -4, 5, 9, 519]), base = exp(1.))
45expPrev
46+0, +0, +1, +1, +1, +2, +6
47exp(1.)**expPrev
48+1.00000000, +1.00000000, +2.71828175, +2.71828175, +2.71828175, +7.38905573, +403.428741
49
50
Test:
test_pm_mathExp


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.

Author:
Amir Shahmoradi, April 25, 2015, 2:21 PM, National Institute for Fusion Studies, The University of Texas Austin

Definition at line 510 of file pm_mathExp.F90.


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