is_nan

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

is_nan — 浮動小数点数の値が、非数かどうかを調べる

説明

is_nan(float $num): bool

指定された num が、NAN (Not A Number) であるかどうかを返します。

数学的に未定義な演算が行われると、NAN が返されます。たとえば関数に渡されるパラメータに、範囲外の値が渡されたときが該当します。平方根(sqrt()) は、正の数値の場合にのみ定義されるので、負の数を渡すと結果は NAN になります。 NAN が返される他の例としては、INF の値を INF で割った場合や、既に NAN とわかっている値と演算をした場合が挙げられます。

注意:
Not A Number という名前が付いていますが、NAN は float 型の値として正しい値です。

警告

NAN は、NAN と等しい値として比較できません。浮動小数点数の値が NAN かを判定するには is_nan() を使わなければいけません。コード $float === NAN は動作しません。

パラメータ

num: 調べる float の値。

戻り値

num が NAN の場合、true を返します。そうでない場合、false を返します。

例

例1 is_nan() の例

<?php
$nan = sqrt(-1);

var_dump($nan, is_nan($nan));
?>

上の例の出力は以下となります。

float(NAN)
bool(true)

参考

is_finite() - 浮動小数点数の値が、有限の数値であるかどうかを調べる
is_infinite() - 浮動小数点数の値が、無限大であるかどうかを調べる

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 4 notes

down

darkangel at moveinmod dot net ¶

18 years ago

nan/"not a number" is not meant to see if the data type is numeric/textual/etc..

NaN is actually a set of values which can be stored in floating-point variables, but dont actually evaluate to a proper floating point number.

The floating point system has three sections: 1 bit for the sign (+/-), an 8 bit exponent, and a 23 bit fractional part.
There are rules governing which combinations of values can be placed into each section, and some values are reserved for numbers such as infinity. This leads to certain combinations being invalid, or in other words, not a number.

down

10basetom ¶

9 years ago

I would use is_numeric() instead of ctype_digit() if you cannot be 100% sure what data type the string will be. Example from the docs:

<?php
$numeric_string = '42';
$integer        = 42;

ctype_digit($numeric_string);  // true
ctype_digit($integer);         // false (ASCII 42 is the * character)

is_numeric($numeric_string);   // true
is_numeric($integer);          // true
?>

down

ScorpioT1000 ¶

4 years ago

function is_nan2($n) {
    return $n !== $n;
}

is_nan2(NAN); // true

down

php at darkain dot com ¶

8 years ago

Starting with PHP 7, the string 'NaN' evaluates to the NaN value as well. 

Example:
var_dump( (float) 'NaN' );

PHP 5.x and HHVM:
float(0)

PHP 7.0:
float(NAN)

＋add a note