mxIsNaN (C and Fortran)

Determine whether input is NaN (Not-a-Number)

C Syntax

#include "matrix.h"
bool mxIsNaN(double value);

Fortran Syntax

#include "fintrf.h"
integer*4 mxIsNaN(value)
real*8 value

Arguments

value: Double-precision, floating-point number to test

Returns

Logical 1 (true) if value is NaN (Not-a-Number), and logical 0 (false) otherwise.

Description

Call mxIsNaN to determine whether value is NaN. NaN is the IEEE^® arithmetic representation for Not-a-Number. A NaN is obtained as a result of mathematically undefined operations such as

0.0/0.0
Inf-Inf

The system understands a family of bit patterns as representing NaN. NaN is not a single value; it is a family of numbers that MATLAB^® (and other IEEE-compliant applications) uses to represent an error condition or missing data.

Examples

To open an example, type:

edit([fullfile(matlabroot,"extern","examples","mx","filename")]);

where filename is:

mxisfinite.c