TEST_IEEE_EXCEPTION(3I) Last changed: 1-6-98
NAME
TEST_IEEE_EXCEPTION - Returns the state of a floating-point exception
SYNOPSIS
TEST_IEEE_EXCEPTION ([EXCEPTION=]exception)
IMPLEMENTATION
UNICOS/mk and IRIX systems
CRAY T90 systems that support IEEE floating-point arithmetic
STANDARDS
CF90 and MIPSpro 7 Fortran 90 compiler extension to Fortran 90
IEEE Standard for Binary Floating-point Arithmetic
DESCRIPTION
The TEST_IEEE_EXCEPTION intrinsic function returns the state of a
specified floating-point exception. It accepts the following
argument:
exception Must be of an integer type that occupies a full word.
If exception is an array, it must be 1-dimensional.
The single value, in the scalar argument case, or each
element, in the array argument case, must be set to one
of the values represented by the following named
constants:
* IEEE_XPTN_CRI_INVALID_OPND (valid only on CRAY T90
systems that support IEEE floating-point arithmetic)
* IEEE_XPTN_INEXACT_RESULT
* IEEE_XPTN_UNDERFLOW
* IEEE_XPTN_OVERFLOW
* IEEE_XPTN_DIV_BY_ZERO
* IEEE_XPTN_INVALID_OPR
* IEEE_XPTN_ALL
TEST_IEEE_EXCEPTION is an elemental function. The name of this
intrinsic cannot be passed as an argument.
NOTES
The IEEE intrinsic procedures use the named constants contained in a
system module, so you must include one of the following statements in
your program:
* On UNICOS and UNICOS/mk systems: USE CRI_IEEE_DEFINITIONS
* On UNICOS, UNICOS/mk, and IRIX systems: USE FTN_IEEE_DEFINITIONS
The CRI_IEEE_DEFINITIONS module is obsolescent. It will be removed
for the CF90 4.0 release.
RETURN VALUES
The result type and type parameter is default logical. If exception
is an array, the result is an array of the same size.
If exception is scalar, the result is a default logical scalar that
has the value TRUE if the specified floating-point exception has
occurred. It has the value FALSE if the specified floating-point
exception has not occurred.
If exception is an array, the result is a default logical
1-dimensional array of the same size as exception in which an element
has the value TRUE if the exception specified by the corresponding
element of exception has occurred. It has the value FALSE if the
exception specified by the corresponding element of exception has not
occurred.
EXAMPLES
See the example on CLEAR_IEEE_EXCEPTION(3I).
SEE ALSOCLEAR_IEEE_EXCEPTION(3I), GET_IEEE_EXCEPTIONS(3I),
SET_IEEE_EXCEPTION(3I)
Intrinsic Procedures Reference Manual, publication SR-2138, for the
printed version of this man page.
