Generate and return the probabilistically-rounded to the nearest integer value of the input real number.
Unlike the intrinsic Fortran nint()
function, the procedures of this generic interface round the input real number to the nearest integer value probabilistically.
The closer the input val
is to its nint(val)
result, the more likely it will be rounded to it.
See below for example usage.
- Parameters
-
[in] | val | : The input scalar or array of the same rank as other array-like arguments, of
-
type
real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128)
containing the number to be rounded probabilistically.
|
- Returns
whole
: The output scalar or array of the same rank and shape as the input arguments, of default integer
kind IK, containing the probabilistically-rounded input value to the nearest integer.
Possible calling interfaces ⛓
Generate and return the probabilistically-rounded to the nearest integer value of the input real numb...
This module contains procedures and generic interfaces for rounding real values to whole integers.
- See also
- getLog1p
get1mexp
Example usage ⛓
13 integer(IK) :: i, ival, irep
14 real(RKG),
allocatable :: val(:)
15 integer(IKG),
allocatable :: whole(:)
17 type(display_type) :: disp
24 call disp%show(
"val = (-1)**i * [5., 5.2, 5.5, 5.8, 6.]")
25 val
= (
-1)
**i
* [
5.,
5.2,
5.5,
5.8,
6.]
26 do ival
= 1,
size(val)
32 call disp%show(
"whole = pnint([(val(ival), irep = 1, 20)])")
33 whole
= pnint([(val(ival), irep
= 1,
20)])
36 call disp%show(
"call setAsserted(all(abs(val(ival) - whole) < 1))")
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
Verify the input assertion holds and if it does not, print the (optional) input message on stdout and...
Generate and return an object of type stop_type with the user-specified input attributes.
This is a generic method of the derived type display_type with pass attribute.
This module contains classes and procedures for computing various statistical quantities related to t...
This module contains classes and procedures for reporting and handling errors.
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 LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
integer, parameter IKS
The single-precision integer kind in Fortran mode. On most platforms, this is a 32-bit integer kind.
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter RKD
The double precision real kind in Fortran mode. On most platforms, this is an 64-bit real kind.
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
integer, parameter RKS
The single-precision real kind in Fortran mode. On most platforms, this is an 32-bit real kind.
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 ⛓
4val
= (
-1)
**i
* [
5.,
5.2,
5.5,
5.8,
6.]
10whole
= pnint([(val(ival), irep
= 1,
20)])
12+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+5
20whole
= pnint([(val(ival), irep
= 1,
20)])
22+5,
+5,
+5,
+6,
+6,
+5,
+5,
+5,
+5,
+5,
+5,
+5,
+6,
+5,
+5,
+5,
+5,
+5,
+5,
+5
30whole
= pnint([(val(ival), irep
= 1,
20)])
32+5,
+5,
+5,
+6,
+5,
+5,
+6,
+5,
+5,
+5,
+6,
+5,
+5,
+5,
+6,
+6,
+5,
+5,
+5,
+6
40whole
= pnint([(val(ival), irep
= 1,
20)])
42+6,
+5,
+5,
+5,
+6,
+5,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+5,
+6,
+5,
+6,
+6,
+6,
+6
50whole
= pnint([(val(ival), irep
= 1,
20)])
52+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6,
+6
58val
= (
-1)
**i
* [
5.,
5.2,
5.5,
5.8,
6.]
64whole
= pnint([(val(ival), irep
= 1,
20)])
66-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5,
-5
74whole
= pnint([(val(ival), irep
= 1,
20)])
76-5,
-6,
-5,
-5,
-5,
-6,
-5,
-5,
-5,
-6,
-6,
-5,
-6,
-5,
-5,
-6,
-5,
-5,
-5,
-5
84whole
= pnint([(val(ival), irep
= 1,
20)])
86-6,
-6,
-6,
-6,
-5,
-5,
-6,
-5,
-5,
-5,
-5,
-5,
-6,
-5,
-6,
-5,
-5,
-6,
-5,
-5
94whole
= pnint([(val(ival), irep
= 1,
20)])
96-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-5,
-6,
-6,
-6,
-6,
-6,
-6,
-5,
-6,
-6,
-6
104whole
= pnint([(val(ival), irep
= 1,
20)])
106-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6,
-6
- Test:
- test_pm_mathIntSqrt
- Todo:
- Low Priority: This generic interface can be extended to output
integer
values of non-default kind.
- Todo:
- Low Priority: This generic interface can be extended to accept custom random number generators.
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:
- Amir Shahmoradi, April 23, 2017, 1:36 AM, Institute for Computational Engineering and Sciences (ICES), University of Texas at Austin
Definition at line 99 of file pm_mathRound.F90.