Home/ Manual/ gmp / functions/ gmp_clrbit

gmp_clrbit

PHP function Edit on GitHub ✎

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

Clear bit

Description

gmp_clrbit(GMP $num, int $index): void

Clears (sets to 0) bit index in num. The index starts at 0.

Parameters

num: A GMP object.
index: The index of the bit to clear. Index 0 represents the least significant bit.

Return Values

Void

Examples

gmp_clrbit() example

php

<?php
$a = gmp_init("0xff");
gmp_clrbit($a, 0); // index starts at 0, least significant bit
echo gmp_strval($a) . "\n";
?>

The above example will output:

output

Notes

Note

Unlike most of the other GMP functions, gmp_clrbit() must be called with a GMP object that already exists (using gmp_init() for example). One will not be automatically created.