Struct rand_unique::RandomSequenceBuilder

pub struct RandomSequenceBuilder<T>where
    T: QuadraticResidue,{
    pub seed_base: T,
    pub seed_offset: T,
    pub init_base: T,
    pub init_offset: T,
    pub prime: T,
    pub intermediate_xor: T,
}

The configuration for RandomSequence, a random unique sequence generator.

These variables define the entire sequence and should not be modified with the exception of seed_base and seed_offset during initialisation.

The builder defines the internal properties of the sequence, and serialization includes all of the properties to preserve the sequence between crate versions which may change the fixed values between minor versions.

Crate versioning will bump:

• Minor version: when the hard coded parameters are updated in favour of better ones. It is safe to serialize the RandomSequenceBuilder between minor versions.
• Major version: when the sequence generation logic fundamentally changes the sequence, meaning it would be potentially unsafe to serialize the RandomSequenceBuilder between major crate version changes.

Fields

seed_base: T

The seed for the the start index.

seed_offset: T

The seed for the offsetting addition.

init_base: T

A value used as an xor during initialisation for start_index = f(seed_base, init_base) to deterministically pseudo-randomise it.

init_offset: T

A value used as an xor during initialisation for offset = f(seed_offset, init_offset) to deterministically pseudo-randomise it.

prime: T

Should be the largest prime number that fits in type T and satisfied prime = 3 mod 4.

intermediate_xor: T

A value that provides some noise from the xor to generate a pseudo-uniform distribution.

Implementations

impl<T> RandomSequenceBuilder<T>where T: QuadraticResidue,

pub unsafe fn from_spec( seed_base: T, seed_offset: T, init_base: T, init_offset: T, prime: T, intermediate_xor: T ) -> Self

Initialise a config from stored settings. Not recommended unless you know what you’re doing, or these values have been taken from an already serialized RandomSequenceBuilder.

Prefer [RandomSequenceBuilderInit::new] instead.

impl RandomSequenceBuilder<u8>

pub fn new(seed_base: u8, seed_offset: u8) -> Self

Initialise a RandomSequenceBuilder from a specific seed pair.

impl RandomSequenceBuilder<u16>

pub fn new(seed_base: u16, seed_offset: u16) -> Self

Initialise a RandomSequenceBuilder from a specific seed pair.

impl RandomSequenceBuilder<u32>

pub fn new(seed_base: u32, seed_offset: u32) -> Self

Initialise a RandomSequenceBuilder from a specific seed pair.

impl RandomSequenceBuilder<u64>

pub fn new(seed_base: u64, seed_offset: u64) -> Self

Initialise a RandomSequenceBuilder from a specific seed pair.

impl RandomSequenceBuilder<usize>

pub fn new(seed_base: usize, seed_offset: usize) -> Self

Initialise a RandomSequenceBuilder from a specific seed pair.

impl RandomSequenceBuilder<u8>

pub fn rand(rng: &mut impl RngCore) -> Self

Initialise a RandomSequenceBuilder from a random seed.

impl RandomSequenceBuilder<u16>

pub fn rand(rng: &mut impl RngCore) -> Self

Initialise a RandomSequenceBuilder from a random seed.

impl RandomSequenceBuilder<u32>

pub fn rand(rng: &mut impl RngCore) -> Self

Initialise a RandomSequenceBuilder from a random seed.

impl RandomSequenceBuilder<u64>

pub fn rand(rng: &mut impl RngCore) -> Self

Initialise a RandomSequenceBuilder from a random seed.

impl RandomSequenceBuilder<usize>

pub fn rand(rng: &mut impl RngCore) -> Self

Initialise a RandomSequenceBuilder from a random seed.

Trait Implementations

impl<T> Clone for RandomSequenceBuilder<T>where T: QuadraticResidue + Clone,

fn clone(&self) -> RandomSequenceBuilder<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for RandomSequenceBuilder<T>where T: QuadraticResidue + Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for RandomSequenceBuilder<T>where T: QuadraticResidue + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<RandomSequenceBuilder<T>> for RandomSequence<T>where T: QuadraticResidue, RandomSequence<T>: Iterator<Item = T>,

fn from(value: RandomSequenceBuilder<T>) -> Self

Converts to this type from the input type.

impl<T> IntoIterator for RandomSequenceBuilder<T>where T: QuadraticResidue, RandomSequence<T>: Iterator<Item = T>,

fn into_iter(self) -> Self::IntoIter

Build a RandomSequence iterator from this config.

type Item = T

The type of the elements being iterated over.

type IntoIter = RandomSequence<T>

Which kind of iterator are we turning this into?

impl<T> PartialEq for RandomSequenceBuilder<T>where T: QuadraticResidue + PartialEq,

fn eq(&self, other: &RandomSequenceBuilder<T>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for RandomSequenceBuilder<T>where T: QuadraticResidue + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for RandomSequenceBuilder<T>where T: QuadraticResidue + Copy,

impl<T> Eq for RandomSequenceBuilder<T>where T: QuadraticResidue + Eq,

impl<T> StructuralEq for RandomSequenceBuilder<T>where T: QuadraticResidue,

impl<T> StructuralPartialEq for RandomSequenceBuilder<T>where T: QuadraticResidue,