ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
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
This module contains procedures and generic interfaces for various operations with positive integers ...
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

1program example
2
3 use pm_kind, only: SK, IK, IKL
4 use pm_mathUnsigned, only: operator(.uadd.)
5 use pm_io, only: display_type
6
7 implicit none
8
9 type(display_type) :: disp
10 disp = display_type(file = SK_"main.out.F90")
11
12 call disp%skip
13 call disp%show("1 .uadd. 1")
14 call disp%show( 1 .uadd. 1 )
15 call disp%skip
16
17 call disp%skip
18 call disp%show("huge(1) .uadd. [huge(1), huge(1) / 2, 1, 0]")
19 call disp%show( huge(1) .uadd. [huge(1), huge(1) / 2, 1, 0] )
20 call disp%skip
21
22 call disp%skip
23 call disp%show("127_IKL .uadd. [huge(0_IKL), 127_IKL, 1_IKL]")
24 call disp%show( 127_IKL .uadd. [huge(0_IKL), 127_IKL, 1_IKL] )
25 call disp%skip
26
27end 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 IKL
The scalar integer constant of intrinsic default kind, representing the lowest range integer kind typ...
Definition: pm_kind.F90:749
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
21 .uadd. 1
3+2
4
5
6huge(1) .uadd. [huge(1), huge(1) / 2, 1, 0]
7-2, -1073741826, -2147483648, +2147483647
8
9
10127_IKL .uadd. [huge(0_IKL), 127_IKL, 1_IKL]
11-2, -2, -128
12
13
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.

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: