Generate and return .true. if and only if the addition of the two input integer, complex , or real values causes runtime negative outflow (overflow). More...

Detailed Description

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 ⛓

: use pm_except, only: isAddOutflowNeg

use pm_kind, only: LK

logical(LK) :: outflow

outflow = isAddOutflowNeg(a, b)

pm_except::isAddOutflowNeg
Generate and return .true. if and only if the addition of the two input integer, complex ,...
Definition: pm_except.F90:347

pm_except
This module contains procedures and generic interfaces for testing for exceptional cases at runtime.
Definition: pm_except.F90:46

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541

Remarks: The procedures under discussion are pure.; The procedures under discussion are elemental.

Note: A complex addition is considered an outflow if either real or imaginary component addition causes an outflow.

See also: getFactorial

Example usage ⛓

: 1program example

2

3 use pm_kind, only: SK, IK

4 use pm_kind, only: IKS, IKD ! all processor types and kinds are supported.

5 use pm_kind, only: RKS, RKD ! all processor types and kinds are supported.

6 use pm_kind, only: CKS, CKD ! all processor types and kinds are supported.

7 use pm_except, only: isAddOutflowNeg

8 use pm_io, only: display_type

9

10 implicit none

11

12 type(display_type) :: disp

13 disp = display_type(file = SK_"main.out.F90")

14

15 call disp%skip

16 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%")

17 call disp%show("!Integer addition outflow")

18 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%")

19 call disp%skip

20

21 call disp%skip

22 call disp%show("isAddOutflowNeg(1, 1)")

23 call disp%show( isAddOutflowNeg(1, 1) )

24 call disp%skip

25

26 call disp%skip

27 call disp%show("isAddOutflowNeg(1, -1)")

28 call disp%show( isAddOutflowNeg(1, -1) )

29 call disp%skip

30

31 call disp%skip

32 call disp%show("isAddOutflowNeg([huge(1), -huge(1)], [huge(1), -huge(1)])")

33 call disp%show( isAddOutflowNeg([huge(1), -huge(1)], [huge(1), -huge(1)]) )

34 call disp%skip

35

36 call disp%skip

37 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%")

38 call disp%show("!Complex addition outflow")

39 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%")

40 call disp%skip

41

42 call disp%skip

43 call disp%show("isAddOutflowNeg((1., -1), (1., -1))")

44 call disp%show( isAddOutflowNeg((1., -1), (1., -1)) )

45 call disp%skip

46

47 call disp%skip

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))]) )

50 call disp%skip

51

52 call disp%skip

53 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%")

54 call disp%show("!Real addition outflow")

55 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%")

56 call disp%skip

57

58 call disp%skip

59 call disp%show("isAddOutflowNeg(1., 1.)")

60 call disp%show( isAddOutflowNeg(1., 1.) )

61 call disp%skip

62

63 call disp%skip

64 call disp%show("isAddOutflowNeg(1., -1.)")

65 call disp%show( isAddOutflowNeg(1., -1.) )

66 call disp%skip

67

68 call disp%skip

69 call disp%show("isAddOutflowNeg([huge(1.), huge(1.), huge(1.), -huge(1.)], [-1., 1., huge(1.), -huge(1.)])")

70 call disp%show( isAddOutflowNeg([huge(1.), huge(1.), huge(1.), -huge(1.)], [-1., 1., huge(1.), -huge(1.)]) )

71 call disp%skip

72

73end program example

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind::CKS
integer, parameter CKS
The single-precision complex kind in Fortran mode. On most platforms, this is a 32-bit real kind.
Definition: pm_kind.F90:570

pm_kind::IKS
integer, parameter IKS
The single-precision integer kind in Fortran mode. On most platforms, this is a 32-bit integer kind.
Definition: pm_kind.F90:563

pm_kind::IK
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

pm_kind::CKD
integer, parameter CKD
The double precision complex kind in Fortran mode. On most platforms, this is a 64-bit real kind.
Definition: pm_kind.F90:571

pm_kind::RKD
integer, parameter RKD
The double precision real kind in Fortran mode. On most platforms, this is an 64-bit real kind.
Definition: pm_kind.F90:568

pm_kind::IKD
integer, parameter IKD
The double precision integer kind in Fortran mode. On most platforms, this is a 64-bit integer kind.
Definition: pm_kind.F90:564

pm_kind::SK
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

pm_kind::RKS
integer, parameter RKS
The single-precision real kind in Fortran mode. On most platforms, this is an 32-bit real kind.
Definition: pm_kind.F90:567

pm_io::display_type
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

2!%%%%%%%%%%%%%%%%%%%%%%%%

3!Integer addition outflow

4!%%%%%%%%%%%%%%%%%%%%%%%%

5

6

7isAddOutflowNeg(1, 1)

8F

9

10

11isAddOutflowNeg(1, -1)

12F

13

14

15isAddOutflowNeg([huge(1), -huge(1)], [huge(1), -huge(1)])

16F, T

17

18

19!%%%%%%%%%%%%%%%%%%%%%%%%

20!Complex addition outflow

21!%%%%%%%%%%%%%%%%%%%%%%%%

22

23

24isAddOutflowNeg((1., -1), (1., -1))

25T

26

27

28isAddOutflowNeg(cmplx(1., huge(1.)), [(0., 0.), cmplx(huge(0.), 1.), cmplx(-huge(1), -huge(1))])

29F, F, F

30

31

32!%%%%%%%%%%%%%%%%%%%%%%%%

33!Real addition outflow

34!%%%%%%%%%%%%%%%%%%%%%%%%

35

36

37isAddOutflowNeg(1., 1.)

38F

39

40

41isAddOutflowNeg(1., -1.)

42F

43

44

45isAddOutflowNeg([huge(1.), huge(1.), huge(1.), -huge(1.)], [-1., 1., huge(1.), -huge(1.)])

46F, F, F, T

47

48

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.

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

src/fortran/main/pm_except.F90