Generate and return .true.
if and only if the addition of the two input integer
, complex
, or real
values causes runtime negative outflow (overflow).
See the documentation of pm_except 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),
-
type
complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128),
-
type
real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
containing the number to be added to the other input argument b . |
[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 the input argument a containing the number to be added to the other input argument a . |
- Returns
outflow
: The scalar, or array of the same rank and shape as other array-like arguments, of type logical
of default kind LK that is .true.
if and only if -huge(a) < a + b
.
Possible calling interfaces ⛓
logical(LK) :: outflow
Generate and return .true. if and only if the addition of the two input integer, complex ,...
This module contains procedures and generic interfaces for testing for exceptional cases at runtime.
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(....
- Note
- A complex addition is considered an outflow if either real or imaginary component addition causes an outflow.
- See also
- getFactorial
Example usage ⛓
12 type(display_type) :: disp
16 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%")
17 call disp%show(
"!Integer addition outflow")
18 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%")
22 call disp%show(
"isAddOutflowNeg(1, 1)")
27 call disp%show(
"isAddOutflowNeg(1, -1)")
32 call disp%show(
"isAddOutflowNeg([huge(1), -huge(1)], [huge(1), -huge(1)])")
37 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%")
38 call disp%show(
"!Complex addition outflow")
39 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%")
43 call disp%show(
"isAddOutflowNeg((1., -1), (1., -1))")
48 call disp%show(
"isAddOutflowNeg(cmplx(1., huge(1.)), [(0., 0.), cmplx(huge(0.), 1.), cmplx(-huge(1), -huge(1))])")
49 call disp%show(
isAddOutflowNeg(
cmplx(
1.,
huge(
1.)), [(
0.,
0.),
cmplx(
huge(
0.),
1.),
cmplx(
-huge(
1),
-huge(
1))]) )
53 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%")
54 call disp%show(
"!Real addition outflow")
55 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%%%%")
59 call disp%show(
"isAddOutflowNeg(1., 1.)")
64 call disp%show(
"isAddOutflowNeg(1., -1.)")
69 call disp%show(
"isAddOutflowNeg([huge(1.), huge(1.), huge(1.), -huge(1.)], [-1., 1., huge(1.), -huge(1.)])")
This is a generic method of the derived type display_type with pass attribute.
This is a generic method of the derived type display_type with pass attribute.
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.
integer, parameter CKS
The single-precision complex kind in Fortran mode. On most platforms, this is a 32-bit real 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 CKD
The double precision complex kind in Fortran mode. On most platforms, this is a 64-bit real kind.
integer, parameter RKD
The double precision real kind in Fortran mode. On most platforms, this is an 64-bit real kind.
integer, parameter IKD
The double precision integer kind in Fortran mode. On most platforms, this is a 64-bit integer 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 ⛓
28isAddOutflowNeg(
cmplx(
1.,
huge(
1.)), [(
0.,
0.),
cmplx(
huge(
0.),
1.),
cmplx(
-huge(
1),
-huge(
1))])
45isAddOutflowNeg([
huge(
1.),
huge(
1.),
huge(
1.),
-huge(
1.)], [
-1.,
1.,
huge(
1.),
-huge(
1.)])
- Test:
- test_pm_except
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 347 of file pm_except.F90.