https://github.com/preciz/abit

Use :atomics as a bit array or as an array of N-bit counters
https://github.com/preciz/abit

atomics bitwise elixir

Last synced: about 2 months ago
JSON representation

Use :atomics as a bit array or as an array of N-bit counters

• Host: GitHub
• URL: https://github.com/preciz/abit
• Owner: preciz
• License: mit
• Created: 2019-09-26T13:22:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-13T07:32:18.000Z (5 months ago)
• Last Synced: 2025-03-24T09:21:19.233Z (2 months ago)
• Topics: atomics, bitwise, elixir
• Language: Elixir
• Homepage: https://hex.pm/packages/abit
• Size: 137 KB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Abit

[![test](https://github.com/preciz/abit/actions/workflows/test.yml/badge.svg)](https://github.com/preciz/abit/actions/workflows/test.yml)

Use `:atomics` as a bit array or as an array of N-bit counters.

Documentation can be found at [https://hexdocs.pm/abit](https://hexdocs.pm/abit).

## Installation

**Note**: it requires OTP-21.2.1 or later.

Add `abit` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:abit, "~> 0.3"}

  ]

end

```

## API summary

See [https://hexdocs.pm/abit](https://hexdocs.pm/abit) for full documentation.

### Abit - use `:atomics` as a bit array

* `Abit.bit_count/1` - Returns count of bits in atomics.

* `Abit.merge/2` - Merges bits of 2 atomics using Bitwise OR.

* `Abit.intersect/2` - Intersects bits of 2 atomics using Bitwise AND.

* `Abit.bit_position/1` - Returns the bit's position in an atomics array.

* `Abit.bit_at/2` - Returns the bit at a given position from atomics.

* `Abit.set_bit_at/3` - Sets the bit in atomics at the given position to the given bit (0 or 1).

* `Abit.set_bits_count/1` - Returns the number of bits set to 1 in atomics.

* `Abit.hamming_distance/2` - Returns the bitwise hamming distance between the 2 given atomics.

### Abit.Counter - use `:atomics` as an array of N-bit counters

* `Abit.Counter.new/2` - Create a new array of counters. Returns %Abit.Counter{} struct.

* `Abit.Counter.get/2` - Returns the value of counter at the given index.

* `Abit.Counter.put/3` - Puts the value into counter at the given index.

* `Abit.Counter.add/3` - Adds the increment to counter at the given index.

### Abit.Bitmask - helper functions for bitmasks

* `Abit.Bitmask.set_bits_count/1` - Returns the number of bits set to 1 in the given integer.

* `Abit.Bitmask.bit_at/2` - Returns the bit at a given position in the given integer.

* `Abit.Bitmask.set_bit_at/3` - Sets a bit in the given integer at the given position to a given bit (0 or 1).

* `Abit.hamming_distance/2` - Returns the bitwise hamming distance between the 2 given integers.

## License

Abit is [MIT licensed](LICENSE).