is_inf

This function determines whether the provided value is a positive or negative infinity.

This function does not generate an event.

This function has a deprecated alias isinf which will be removed in the next minor release.

Function

is_inf(value)

Arguments

Argument Type Description
value any (required) The value to be tested.

Return value

Returns true if the given value is a positive or negative infinity, else it returns false.

Example

This code shows some return values for is_inf():

[
    is_inf( -inf ),
    is_inf( inf ),
    is_inf( 0 ),
    is_inf( nan ),
];

Return value in JSON format

[
    true,
    true,
    false,
    false
]