php8.5
Home/ Manual/ gmp / functions/ gmp_testbit

gmp_testbit

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

Tests if a bit is set

Description

gmp_testbit(GMP|int|string $num, int $index): bool

Tests if the specified bit is set.

Parameters

num

Parameter

index

The bit to test

Return Values

Returns true if the bit is set in num, otherwise false.

Errors/Exceptions

Throws a ValueError if index is negative or, as of PHP 8.5.0, too large.

Prior to PHP 8.0.0, an E_WARNING was raised and false was returned instead.

Examples

gmp_testbit() example

php
<?php
$n = gmp_init("1000000");
var_dump(gmp_testbit($n, 1));
gmp_setbit($n, 1);
var_dump(gmp_testbit($n, 1));
?>

The above example will output:

output
bool(false)
bool(true)

See Also

Source: reference/gmp/functions/gmp-testbit.xml · from the official PHP manual (php/doc-en)