Struct RapidRng

pub struct RapidRng { /* private fields */ }

A random number generator that uses the rapidhash mixing algorithm.

This deterministic RNG is optimised for speed and throughput. This is not a cryptographic random number generator.

This RNG is compatible with [rand_core::RngCore] and [rand_core::SeedableRng].

Example

use rapidhash::RapidRng;

let mut rng = RapidRng::default();
println!("{}", rng.next());

Implementations

impl RapidRng

pub fn new(seed: u64) -> Self

Create a new random number generator from a specified seed.

Also see RapidRng::default() with the std feature enabled for seed randomisation based on the current time.

pub fn state(&self) -> [u8; 8]

Export the current state of the random number generator.

pub fn next(&mut self) -> u64

Trait Implementations

impl Clone for RapidRng

fn clone(&self) -> RapidRng

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RapidRng

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

Formats the value using the given formatter.

impl Default for RapidRng

fn default() -> Self

Create a new random number generator.

With std enabled, the seed is generated using the current system time via rapidrng_time.

Without std, the seed is set to RAPID_SEED.

impl Hash for RapidRng

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RapidRng

fn cmp(&self, other: &RapidRng) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RapidRng

fn eq(&self, other: &RapidRng) -> bool

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

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 PartialOrd for RapidRng

fn partial_cmp(&self, other: &RapidRng) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for RapidRng

impl Eq for RapidRng

impl StructuralPartialEq for RapidRng