Trait Underlier 

pub unsafe trait Underlier:
    Copy
    + Default
    + Eq
    + Hash
    + Debug
    + Send
    + Sync
    + 'static {
    type Word: Word;

    const WORDS: usize;
    const ZERO: Self;
    const ONES: Self;
    const BITS: usize = _;

    // Required methods
    fn words(&self) -> &[Self::Word];
    fn words_mut(&mut self) -> &mut [Self::Word];
    fn from_words_fn(f: impl FnMut(usize) -> Self::Word) -> Self;
    fn random<R: Rng + ?Sized>(rng: &mut R) -> Self;

    // Provided method
    fn zip(
        self,
        other: Self,
        op: impl Fn(Self::Word, Self::Word) -> Self::Word,
    ) -> Self { ... }
}

A fixed-width block of bits, addressed as an array of words.

Word 0 holds the lowest bits of the block, and bit 0 of a word is the lowest of all.

Safety

A value must be exactly its words and nothing else:

• its size must equal the word count times the size of one word,
• its alignment must be at least a word’s.

Reinterpreting a run of values as a run of words relies on both.

Required Associated Constants

const WORDS: usize

How many words make up the block.

const ZERO: Self

Every bit clear.

const ONES: Self

Every bit set.

Provided Associated Constants

const BITS: usize = _

Bits in the whole block.

Required Associated Types

type Word: Word

The word the block is addressed in.

Required Methods

fn words(&self) -> &[Self::Word]

The words of the block, lowest bits first.

fn words_mut(&mut self) -> &mut [Self::Word]

The words of the block, lowest bits first.

fn from_words_fn(f: impl FnMut(usize) -> Self::Word) -> Self

Build a block word by word, lowest bits first.

fn random<R: Rng + ?Sized>(rng: &mut R) -> Self

A block whose bits are uniformly random and independent.

Provided Methods

fn zip( self, other: Self, op: impl Fn(Self::Word, Self::Word) -> Self::Word, ) -> Self

Combine two blocks word by word.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Underlier for u8

const WORDS: usize = 1

const ZERO: Self = 0

const ONES: Self = u8::MAX

type Word = u8

fn words(&self) -> &[Self::Word]

fn words_mut(&mut self) -> &mut [Self::Word]

fn from_words_fn(f: impl FnMut(usize) -> Self::Word) -> Self

fn random<R: Rng + ?Sized>(rng: &mut R) -> Self

impl Underlier for u16

const WORDS: usize = 1

const ZERO: Self = 0

const ONES: Self = u16::MAX

type Word = u16

fn words(&self) -> &[Self::Word]

fn words_mut(&mut self) -> &mut [Self::Word]

fn from_words_fn(f: impl FnMut(usize) -> Self::Word) -> Self

fn random<R: Rng + ?Sized>(rng: &mut R) -> Self

impl Underlier for u32

const WORDS: usize = 1

const ZERO: Self = 0

const ONES: Self = u32::MAX

type Word = u32

fn words(&self) -> &[Self::Word]

fn words_mut(&mut self) -> &mut [Self::Word]

fn from_words_fn(f: impl FnMut(usize) -> Self::Word) -> Self

fn random<R: Rng + ?Sized>(rng: &mut R) -> Self

impl Underlier for u64

const WORDS: usize = 1

const ZERO: Self = 0

const ONES: Self = u64::MAX

type Word = u64

fn words(&self) -> &[Self::Word]

fn words_mut(&mut self) -> &mut [Self::Word]

fn from_words_fn(f: impl FnMut(usize) -> Self::Word) -> Self

fn random<R: Rng + ?Sized>(rng: &mut R) -> Self

Implementors

impl Underlier for M128

const WORDS: usize = 2

const ZERO: Self

const ONES: Self

type Word = u64

impl Underlier for M256

const WORDS: usize = 4

const ZERO: Self

const ONES: Self

type Word = u64

impl Underlier for M512

const WORDS: usize = 8

const ZERO: Self

const ONES: Self

type Word = u64