Aliance\Bitmask\Bitmask

Complexity

Total Complexity

12

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	create()	0	4	1
A	__construct()	0	4	1
A	addMask()	0	5	1
A	deleteMask()	0	5	1
A	setBit()	0	4	1
A	checkBit()	0	11	2
A	unsetBit()	0	4	1
A	issetBit()	0	4	1
A	getMask()	0	4	1
A	setMask()	0	5	1
A	getSetBitsCount()	0	4	1

<?php
namespace Aliance\Bitmask;

/**
 * Simple bitmask implementation.
 * Supports only 63 bits (from 0 to 62) on x64 platforms.
 */
class Bitmask
{
    /**
     * @var int
     */
    const MAX_BIT = 62;

    /**
     * @var int
     */
    private $mask;

    /**
     * @param int $mask
     */
    public function __construct(int $mask = 0)
    {
        $this->setMask($mask);
    }

    /**
     * @param int $mask
     * @return $this
     */
    public static function create(int $mask = 0)
    {
        return new self($mask);
    }

    /**
     * @param int $bit
     * @return $this
     */
    public function setBit(int $bit)
    {
        return $this->addMask(1 << $this->checkBit($bit));
    }

    /**
     * @param int $mask
     * @return $this
     */
    public function addMask(int $mask)
    {
        $this->mask |= $mask;
        return $this;
    }

    /**
     * @param int $bit
     * @return int
     * @throws \InvalidArgumentException
     */
    private function checkBit(int $bit): int
    {
        if ($bit > self::MAX_BIT) {
            throw new \InvalidArgumentException(sprintf(
                'Bit number %d is greater than possible limit %d.',
                $bit,
                self::MAX_BIT
            ));
        }
        return $bit;
    }

    /**
     * @param int $bit
     * @return $this
     */
    public function unsetBit(int $bit)
    {
        return $this->deleteMask(1 << $this->checkBit($bit));
    }

    /**
     * @param int $mask
     * @return $this
     */
    public function deleteMask(int $mask)
    {
        $this->mask &= ~$mask;
        return $this;
    }

    /**
     * @param int $bit
     * @return bool
     */
    public function issetBit(int $bit): bool
    {
        return (bool)($this->getMask() & (1 << $this->checkBit($bit)));
    }

    /**
     * @return int
     */
    public function getMask(): int
    {
        return $this->mask;
    }

    /**
     * @param int $mask
     * @return $this
     */
    public function setMask(int $mask)
    {
        $this->mask = (int)$mask;
        return $this;
    }

    /**
     * Return set bits count.
     * Actually, counts the number of 1 in binary representation of the decimal mask integer.
     * @return int
     */
    public function getSetBitsCount(): int
    {
        return substr_count(decbin($this->mask), '1');
    }
}