Struct swar::Bits1

pub struct Bits1<N>(pub N);

This is used when each bit is a number stored in parallel.

Methods

impl Bits1<u128>

pub fn from_element(e: u128) -> Self

Spread a single value out to each element. Must be able to fit.

use swar::*;

assert_eq!(Bits1::from_element(1), Bits1(0xFFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF));
assert_eq!(Bits1::from_element(0), Bits1(0x0000_0000_0000_0000_0000_0000_0000_0000));

pub fn any(self) -> Self

If any bit is set in each element, sets the element to 1, else 0.

use swar::*;

let input = Bits1(0b1010u128);
let output = Bits1(0b1010u128);
assert_eq!(input.any(), output);

pub fn union(left: Bits2<u128>, right: Bits2<u128>) -> Self

Takes two inputs that have half-sized elements and compresses them into half the space and puts them in the left and right sides of this.

use swar::*;

let input = Bits1(0xFEED_FACE_CAFE_BEEF_FEED_FACE_CAFE_BEEF);
let (left, right) = input.halve();
let output = Bits1::union(left, right);
assert_eq!(input, output);

pub fn count_ones(self) -> u32

pub fn pack_ones(self) -> Bits2<u128>

Sqishes all the bits to the right in each 2-bit segment.

use swar::*;

let input = Bits1(0b00_01_10_11);
let out = Bits2(0b00_01_01_11);
assert_eq!(input.pack_ones(), out);

pub fn sum_weight(self) -> u128

pub fn sum_weight2(self) -> Bits2<u128>

pub fn minhwd(self, other: Self) -> Self

This computes the minimum hamming weight distance from hamming weights.

For a Bits1, this is the same as computing the hamming weight from the original number and is a simple XOR.

The minimum and maximum weights are exactly the same for single bits.

pub fn maxhwd(self, other: Self) -> Self

This computes the maximum hamming weight distance from hamming weights.

For a Bits1, this is the same as computing the hamming weight from the original number and is a simple XOR.

The minimum and maximum weights are exactly the same for single bits.

pub fn split(self) -> (Bits2<u128>, Bits2<u128>)

pub fn halve(self) -> (Bits2<u128>, Bits2<u128>)

Takes the left and right sides and spreads them out so that the bits in each element are spread out into twice the amount of space.

use swar::*;

let input = Bits1(0b1101 << 64 | 0b0101u128);
let (left, right) = input.halve();
assert_eq!(left, Bits2(0b0101_0001));
assert_eq!(right, Bits2(0b0001_0001));

Trait Implementations

impl<N: PartialEq> PartialEq<Bits1<N>> for Bits1<N>

fn eq(&self, other: &Bits1<N>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Bits1<N>) -> bool

This method tests for !=.

impl<N: Eq> Eq for Bits1<N>

impl<N: Clone> Clone for Bits1<N>

fn clone(&self) -> Bits1<N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N: Copy> Copy for Bits1<N>

impl<N: Debug> Debug for Bits1<N>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Add<Bits1<u128>> for Bits1<u128>

Note that you are responsible for dealing with overflow. Try to avoid overflow or use the split() method to add in two halves. You can use split() on the result to get the carry bits.

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl BitAnd<u128> for Bits1<u128>

type Output = Self

The resulting type after applying the & operator.

fn bitand(self, rhs: u128) -> Self

Performs the & operation.

impl Shr<u32> for Bits1<u128>

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> Self

Performs the >> operation.