Return an IEEE-compliant quiet NAN
(Not a Number).
This procedure is useful for deliberate initializations of real
or complex
numbers to NaN
without signaling the occurrence of an exception.
- Parameters
-
[out] | nan | : The output scalar or array of arbitrary rank of either
-
type
complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128), or
-
type
real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),
which will contain a NaN . |
Possible calling interfaces ⛓
Return an IEEE-compliant quiet NAN (Not a Number).
This module contains procedures and generic interfaces for testing for exceptional cases at runtime.
- Warning
- Keep in mind that
NaN
might not even be defined for non-IEEE-compliant compilers or when certain aggressive IEEE-breaking optimization flags are specified like -O3 -ffast-math
with GNU gfortran
or -fast
with Intel ifort
compilers.
- See also
- isInf
isNAN
getNAN
setNAN
isInfPos
isInfNeg
getInfPos
setInfPos
getInfNeg
setInfNeg
Example usage ⛓
14 complex(CKH) :: X_CKH(
3)
15 complex(CKD) :: X_CKD(
3)
16 complex(CKS) :: X_CKS(
3)
18 type(display_type) :: disp
22 call disp%show(
"!%%%%%%%%%%%%%%%%%%")
23 call disp%show(
"!%%%%%%%%%%%%%%%%%%")
24 call disp%show(
"!Generate real NaN.")
25 call disp%show(
"!%%%%%%%%%%%%%%%%%%")
26 call disp%show(
"!%%%%%%%%%%%%%%%%%%")
36 call disp%show(
"call setNAN(X_RKS(1))")
56 call disp%show(
"call setNAN(X_RKD(1))")
76 call disp%show(
"call setNAN(X_RKH(1))")
91 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%")
92 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%")
93 call disp%show(
"!Generate complex NaN.")
94 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%")
95 call disp%show(
"!%%%%%%%%%%%%%%%%%%%%%")
106 call disp%show(
"call setNAN(X_CKS(1))")
113 call disp%show(
"call setNAN(X_CKS)")
126 call disp%show(
"call setNAN(X_CKD(1))")
133 call disp%show(
"call setNAN(X_CKD)")
146 call disp%show(
"call setNAN(X_CKH(1))")
153 call disp%show(
"call setNAN(X_CKH)")
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.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter CKH
The scalar integer constant of intrinsic default kind, representing the highest-precision complex kin...
integer, parameter CKS
The single-precision complex kind in Fortran mode. On most platforms, this is a 32-bit real 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 SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
integer, parameter RKH
The scalar integer constant of intrinsic default kind, representing the highest-precision real kind t...
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 ⛓
73(NaN, NaN), (NaN, NaN), (NaN, NaN)
88(NaN, NaN), (NaN, NaN), (NaN, NaN)
103(NaN, NaN), (NaN, NaN), (NaN, NaN)
- 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, Friday 1:54 AM, April 21, 2017, Institute for Computational Engineering and Sciences (ICES), The University of Texas, Austin, TX
Definition at line 2593 of file pm_except.F90.