pm_mathUnsigned::operator(.uadd.) Interface Reference

Generate and return a (possibly overflowed) signed integer that is the result of adding the two input (non-negative) integers without runtime overflow error. More...

Detailed Description

Generate and return a (possibly overflowed) signed integer that is the result of adding the two input (non-negative) integers without runtime overflow error.

If the addition operation does not lead to overflow, then the sum matches the outcome of regular addition operation.
If the addition operation does lead to overflow, then bit pattern of the result will match that of the result of the unsigned addition of the two input integers.
See the documentation of pm_mathUnsigned for more information.

Parameters

[in]	a	: The input scalar, or array of the same rank and 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 a (non-negative) signed integer to be added to another input signed integer b without causing overflow.
[in]	b	: The input scalar, or array of the same rank and shape as other array-like arguments, of the same type and kind as a, containing a (non-negative) signed integer to be added to another input signed integer a without causing overflow.

Returns

sum : The output scalar, or array of the same rank and shape as other array-like arguments, of the same type and kind as a, containing the sum of the two input (non-negative) signed integers without causing runtime overflow error.

Possible calling interfaces ⛓

use pm_mathUnsigned, only: operator(.uadd.)
 
c = a .uadd. b

Warning

The condition 0 <= a must hold for the corresponding input arguments.
The condition 0 <= b must hold for the corresponding input arguments.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

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.

See also

pm_distUnif

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, IKL
    use pm_mathUnsigned, only: operator(.uadd.)
    use pm_io, only: display_type
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = SK_"main.out.F90")
 
    call disp%skip
    call disp%show("1 .uadd. 1")
    call disp%show( 1 .uadd. 1 )
    call disp%skip
 
    call disp%skip
    call disp%show("huge(1) .uadd. [huge(1), huge(1) / 2, 1, 0]")
    call disp%show( huge(1) .uadd. [huge(1), huge(1) / 2, 1, 0] )
    call disp%skip
 
    call disp%skip
    call disp%show("127_IKL .uadd. [huge(0_IKL), 127_IKL, 1_IKL]")
    call disp%show( 127_IKL .uadd. [huge(0_IKL), 127_IKL, 1_IKL] )
    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 ⛓

 
1 .uadd. 1
+2
 
 
huge(1) .uadd. [huge(1), huge(1) / 2, 1, 0]
-2, -1073741826, -2147483648, +2147483647
 
 
127_IKL .uadd. [huge(0_IKL), 127_IKL, 1_IKL]
-2, -2, -128
 
 

Test:

test_pm_mathUnsigned

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, 12:27 AM Tuesday, February 22, 2022, Dallas, TX Amir Shahmoradi, April 23, 2017, 1:36 AM, Institute for Computational Engineering and Sciences (ICES), University of Texas at Austin

Definition at line 129 of file pm_mathUnsigned.F90.

---

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

• src/fortran/main/pm_mathUnsigned.F90