README

简单的bitset实现，用于紧凑地存储值集合。该库本身是无状态的，仅提供纯映射函数。

要求

PHP 7.1+

安装

$ composer require pwm/bitset

使用方法

在这个例子中，我们将使用bitset将用户放入组中。

让我们创建一个 Group 类。它包含一组组，例如G1到G5，并且通过bitset提供2的幂的组与二进制值之间的映射。最后，它包含两个将组名和位值之间映射的函数。

class Group
{
    const G1 = 'Group 1';
    const G2 = 'Group 2';
    const G3 = 'Group 3';
    const G4 = 'Group 4';
    const G5 = 'Group 5';

    private const MAP = [
        self::G1 => BitSet::B1,
        self::G2 => BitSet::B2,
        self::G3 => BitSet::B3,
        self::G4 => BitSet::B4,
        self::G5 => BitSet::B5,
    ];

    public static function fromGroups(array $groups): array
    {
        return array_values(array_intersect_key(self::MAP, array_flip($groups)));
    }

    public static function toGroups(array $bitValues): array
    {
        return array_values(array_intersect_key(array_flip(self::MAP), array_flip($bitValues)));
    }
}

让我们还创建一个 User 类。用户可以属于组。$groups属性从0开始，代表空集。它有5个方法来操作其组，对应于bitset的5个函数：get()、set()、add()、remove() 和 has()。

class User
{
    private $groups = BitSet::EMPTY;

    public function getGroups(): array
    {
        return Group::toGroups(BitSet::get($this->groups));
    }

    public function setGroups(array $groups): void
    {
        $this->groups = BitSet::set(Group::fromGroups($groups));
    }

    public function addGroups(array $groups): void
    {
        $this->groups = BitSet::add($this->groups, Group::fromGroups($groups));
    }

    public function removeGroups(array $groups): void
    {
        $this->groups = BitSet::remove($this->groups, Group::fromGroups($groups));
    }

    public function hasGroup(string $group): bool
    {
        $a = Group::fromGroups([$group]);
        return isset($a[0])
            ? BitSet::has($this->groups, $a[0])
            : false;
    }
}

现在我们可以用以下方式使用它

$user = new User();
$user->setGroups([Group::G1, Group::G2]);

assert($user->getGroups() === [Group::G1, Group::G2]);
assert($user->hasGroup(Group::G1) === true);

$user->addGroups([Group::G4, Group::G5]);
$user->removeGroups([Group::G1, Group::G4]);

assert($user->getGroups() === [Group::G2, Group::G5]);
assert($user->hasGroup(Group::G1) === false);

工作原理

以一个例子来说明，让我们取数字1、4和8。它们的和是13。到目前为止似乎没什么有趣的。但是，让我们看看它们的二进制表示：0b1、0b100和0b1000。它们的和13是0b1101。看看1、4和8在13的基-2表示中是如何“填充唯一槽位”的，只留下一个未设置的槽位？这是因为1、4和8都是2的幂，所以它们的二进制表示以1开头，后面跟着零个或多个0。0b1 = 2^0 = 1，0b100 = 2^2 = 4，0b1000 = 2^3 = 8。它们的和：2^0 + 2^2 + 2^3 = 0b1 + 0b100 + 0b1000 = 0b1101 = 13。现在，在一个游戏中，我们可以称1为“北方”，2为“南方”，4为“东方”，8为“西方”，然后13表示我们的角色可以从当前位置向所有方向移动，除了南方，因为2（0b10）不在13（0b1101）中。

bitset背后的想法是使用数字的基-2表示来通过将其位设置为1或0来表示值的出现或不存在。值本身也是数字，但必须满足的限制是它们必须是2的幂，从2^0开始，通常，根据底层系统，可以到达2^32或2^64。例如，在64位系统上，可以在bitset中存储多达64个唯一值。

本身是bitset库是一组5个纯函数，它们在值和它们的bitset之间进行映射

set(array $values): int

将一组唯一的正整数映射到一个整数，即bitset，即它们的和。输入列表中的所有整数都必须是2的幂。

get(int $bitset): array

将整数，即bitset，映射到一个列表中，其中包含唯一的正整数。输出列表中的所有整数都必须是2的幂。

add(int $bitset, array $values): int

向bitset添加一组唯一的正整数。列表中的所有整数都必须是2的幂。

remove(int $bitset, array $values): int

从bitset中减去一组唯一的正整数。列表中的所有整数都必须是2的幂。

has(int $bitset, int $value): bool

谓词，指示元素是否在bitset中。

测试

$ vendor/bin/phpunit
$ composer phpcs
$ composer phpstan

变更日志

点击这里

许可证

MIT

pwmbitset / bitset

维护者

详细信息

README

目录

要求

安装

使用方法

工作原理

测试

变更日志

许可证