gmp_testbit

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

gmp_testbit — 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

A GMP object, an int or a numeric string.

index

The bit to test

Return Values

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

Errors/Exceptions

An E_WARNING level error is issued when index is less than zero, and false is returned.

Examples

Example #1 gmp_testbit() example

<?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:

bool(false)
bool(true)

See Also