Struct XorShift16 Copy item path

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> XorShift16<BASIS, A, B, C>

pub const fn new(seed: u16) -> Self

Returns a seeded XorShift16 generator from the given 16-bit seed.

If the seed is 0, the default seed is used instead.

pub const fn new_unchecked(seed: u16) -> Self

Returns a seeded XorShift16 generator from the given 8-bit seed, unchecked.

The seed must not be 0, otherwise every result will also be 0.

pub const fn inner_state(self) -> u16

Returns the PRNG’s inner state as a raw snapshot.

pub const fn from_state(state: u16) -> Self

Restores the PRNG from the given state.

pub const fn current_u16(&self) -> u16

Returns the current random u16.

pub fn next_u16(&mut self) -> u16

Returns the next random u16.

pub const fn peek_next_state(&self) -> Self

Returns a copy of the next new random state.

pub const fn own_next_u16(self) -> Own<Self, u16>

Returns both the next random state and the u16 value.

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> XorShift16<BASIS, A, B, C>

§Extra constructors

pub const fn new1_u16(seed: u16) -> Self

Returns a seeded XorShift16 generator from the given 16-bit seed.

This is an alias of new.

pub const fn new2_u8(seeds: [u8; 2]) -> Self

Returns a seeded XorShift16 generator from the given 2 × 8-bit seeds.

The seeds will be joined in little endian order.

Trait Implementations§

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Clone for XorShift16<BASIS, A, B, C>

fn clone(&self) -> XorShift16<BASIS, A, B, C>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl ConstDefault for XorShift16

Creates a new PRNG initialized with the default fixed seed.

const DEFAULT: Self

Returns the compile-time “default value” for a type.

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Debug for XorShift16<BASIS, A, B, C>

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

Formats the value using the given formatter. Read more

impl Default for XorShift16

Creates a new PRNG initialized with the default fixed seed.

fn default() -> Self

Returns the “default value” for a type. Read more

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> PartialEq for XorShift16<BASIS, A, B, C>

fn eq(&self, other: &XorShift16<BASIS, A, B, C>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> RngCore for XorShift16<BASIS, A, B, C>

Available on crate features dep_rand_core and join only.

fn next_u32(&mut self) -> u32 ⓘ

Returns the next 2 × random u16 combined as a single u32.

fn next_u64(&mut self) -> u64

Returns the next 4 × random u16 combined as a single u64.

fn fill_bytes(&mut self, dest: &mut [u8])

Fill dest with random data. Read more

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> SeedableRng for XorShift16<BASIS, A, B, C>

Available on crate features dep_rand_core and join only.

fn from_seed(seed: Self::Seed) -> Self

When seeded with zero this implementation uses the default seed value as the cold path.

type Seed = [u8; 2]

Seed type, which is restricted to types mutably-dereferenceable as u8 arrays (we recommend [u8; N] for some N). Read more

fn seed_from_u64(state: u64) -> Self

Create a new PRNG using a u64 seed. Read more

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

Create a new PRNG seeded from an infallible Rng. Read more

fn try_from_rng<R>(rng: &mut R) -> Result<Self, <R as TryRngCore>::Error> ⓘ
where R: TryRngCore,

Create a new PRNG seeded from a potentially fallible Rng. Read more

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Copy for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Eq for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> StructuralPartialEq for XorShift16<BASIS, A, B, C>

Auto Trait Implementations§

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Freeze for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> RefUnwindSafe for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Send for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Sync for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> Unpin for XorShift16<BASIS, A, B, C>

impl<const BASIS: usize, const A: usize, const B: usize, const C: usize> UnwindSafe for XorShift16<BASIS, A, B, C>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> ExtAny for T
where T: Any + ?Sized,

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.

Returns some exclusive reference to the inner value if it is of type T. Read more

impl<T> ExtMem for T
where T: ?Sized,

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more