#[repr(transparent)]pub struct Frequency<T = f64>(pub T);
Expand description
The Frequency
type is a generic wrapper around type T
that implements the
RawFrequency
trait. This implementation is designed to provide a consistent interface
for dealing with frequencies within the crate, enabling conversion, arithmetic operations,
and other utilities that are common to frequency values.
Tuple Fields§
§0: T
Implementations§
Source§impl<T> Frequency<T>where
T: RawFrequency,
impl<T> Frequency<T>where
T: RawFrequency,
Sourcepub const fn new(index: T) -> Self
pub const fn new(index: T) -> Self
returns a new instance of the Frequency
wrapping the given value
Sourcepub fn create<F>(f: F) -> Selfwhere
F: FnOnce() -> T,
pub fn create<F>(f: F) -> Selfwhere
F: FnOnce() -> T,
returns a new instance of the Frequency
wrapping the output of the given
initializer function
Sourcepub const fn as_mut_ptr(&mut self) -> *mut T
pub const fn as_mut_ptr(&mut self) -> *mut T
returns a mutable pointer to the inner value
Sourcepub fn map<U, F>(self, f: F) -> Frequency<U>where
F: FnOnce(T) -> U,
pub fn map<U, F>(self, f: F) -> Frequency<U>where
F: FnOnce(T) -> U,
apply a function to the inner value and returns a new Frequency wrapping the result
Sourcepub const fn replace(&mut self, index: T) -> T
pub const fn replace(&mut self, index: T) -> T
replaces the inner value with the given one and returns the old value
Sourcepub fn with<U>(self, other: U) -> Frequency<U>
pub fn with<U>(self, other: U) -> Frequency<U>
consumes the current instance to create another with the given value
Sourcepub fn take(&mut self) -> Twhere
T: Default,
pub fn take(&mut self) -> Twhere
T: Default,
takes and returns the inner value, replacing it with the logical default
of the type T
Source§impl<T> Frequency<T>where
T: RawFrequency,
impl<T> Frequency<T>where
T: RawFrequency,
Sourcepub fn random_range<R>(range: R) -> Selfwhere
R: SampleRange<T>,
T: SampleUniform,
pub fn random_range<R>(range: R) -> Selfwhere
R: SampleRange<T>,
T: SampleUniform,
generates a new random frequency within the specified range.
Source§impl<T> Frequency<T>where
StandardUniform: Distribution<T>,
impl<T> Frequency<T>where
StandardUniform: Distribution<T>,
Trait Implementations§
Source§impl<'a, A, B> AddAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> AddAssign<&'a Frequency<B>> for Frequency<A>
Source§fn add_assign(&mut self, rhs: &'a Frequency<B>)
fn add_assign(&mut self, rhs: &'a Frequency<B>)
+=
operation. Read moreSource§impl<A, B> AddAssign<Frequency<B>> for Frequency<A>where
A: AddAssign<B>,
impl<A, B> AddAssign<Frequency<B>> for Frequency<A>where
A: AddAssign<B>,
Source§fn add_assign(&mut self, rhs: Frequency<B>)
fn add_assign(&mut self, rhs: Frequency<B>)
+=
operation. Read moreSource§impl<'a, A, B> BitAndAssign<&'a Frequency<B>> for Frequency<A>where
A: BitAndAssign<&'a B>,
impl<'a, A, B> BitAndAssign<&'a Frequency<B>> for Frequency<A>where
A: BitAndAssign<&'a B>,
Source§fn bitand_assign(&mut self, rhs: &'a Frequency<B>)
fn bitand_assign(&mut self, rhs: &'a Frequency<B>)
&=
operation. Read moreSource§impl<A, B> BitAndAssign<Frequency<B>> for Frequency<A>where
A: BitAndAssign<B>,
impl<A, B> BitAndAssign<Frequency<B>> for Frequency<A>where
A: BitAndAssign<B>,
Source§fn bitand_assign(&mut self, rhs: Frequency<B>)
fn bitand_assign(&mut self, rhs: Frequency<B>)
&=
operation. Read moreSource§impl<'a, A, B> BitOrAssign<&'a Frequency<B>> for Frequency<A>where
A: BitOrAssign<&'a B>,
impl<'a, A, B> BitOrAssign<&'a Frequency<B>> for Frequency<A>where
A: BitOrAssign<&'a B>,
Source§fn bitor_assign(&mut self, rhs: &'a Frequency<B>)
fn bitor_assign(&mut self, rhs: &'a Frequency<B>)
|=
operation. Read moreSource§impl<A, B> BitOrAssign<Frequency<B>> for Frequency<A>where
A: BitOrAssign<B>,
impl<A, B> BitOrAssign<Frequency<B>> for Frequency<A>where
A: BitOrAssign<B>,
Source§fn bitor_assign(&mut self, rhs: Frequency<B>)
fn bitor_assign(&mut self, rhs: Frequency<B>)
|=
operation. Read moreSource§impl<'a, A, B> BitXorAssign<&'a Frequency<B>> for Frequency<A>where
A: BitXorAssign<&'a B>,
impl<'a, A, B> BitXorAssign<&'a Frequency<B>> for Frequency<A>where
A: BitXorAssign<&'a B>,
Source§fn bitxor_assign(&mut self, rhs: &'a Frequency<B>)
fn bitxor_assign(&mut self, rhs: &'a Frequency<B>)
^=
operation. Read moreSource§impl<A, B> BitXorAssign<Frequency<B>> for Frequency<A>where
A: BitXorAssign<B>,
impl<A, B> BitXorAssign<Frequency<B>> for Frequency<A>where
A: BitXorAssign<B>,
Source§fn bitxor_assign(&mut self, rhs: Frequency<B>)
fn bitxor_assign(&mut self, rhs: Frequency<B>)
^=
operation. Read moreSource§impl<T> BorrowMut<T> for Frequency<T>
impl<T> BorrowMut<T> for Frequency<T>
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<'de, T> Deserialize<'de> for Frequency<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for Frequency<T>where
T: Deserialize<'de>,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<T> Distribution<Frequency<T>> for StandardUniform
impl<T> Distribution<Frequency<T>> for StandardUniform
Source§impl<'a, A, B> DivAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> DivAssign<&'a Frequency<B>> for Frequency<A>
Source§fn div_assign(&mut self, rhs: &'a Frequency<B>)
fn div_assign(&mut self, rhs: &'a Frequency<B>)
/=
operation. Read moreSource§impl<A, B> DivAssign<Frequency<B>> for Frequency<A>where
A: DivAssign<B>,
impl<A, B> DivAssign<Frequency<B>> for Frequency<A>where
A: DivAssign<B>,
Source§fn div_assign(&mut self, rhs: Frequency<B>)
fn div_assign(&mut self, rhs: Frequency<B>)
/=
operation. Read moreSource§impl<'a, A, B> MulAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> MulAssign<&'a Frequency<B>> for Frequency<A>
Source§fn mul_assign(&mut self, rhs: &'a Frequency<B>)
fn mul_assign(&mut self, rhs: &'a Frequency<B>)
*=
operation. Read moreSource§impl<A, B> MulAssign<Frequency<B>> for Frequency<A>where
A: MulAssign<B>,
impl<A, B> MulAssign<Frequency<B>> for Frequency<A>where
A: MulAssign<B>,
Source§fn mul_assign(&mut self, rhs: Frequency<B>)
fn mul_assign(&mut self, rhs: Frequency<B>)
*=
operation. Read moreSource§impl<T> Num for Frequency<T>where
T: Num,
impl<T> Num for Frequency<T>where
T: Num,
type FromStrRadixErr = <T as Num>::FromStrRadixErr
Source§fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>
fn from_str_radix(str: &str, radix: u32) -> Result<Self, Self::FromStrRadixErr>
2..=36
). Read moreSource§impl<T: Ord> Ord for Frequency<T>
impl<T: Ord> Ord for Frequency<T>
1.21.0 · Source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Source§impl<'a, T> PartialOrd<&'a T> for Frequency<T>where
T: PartialOrd,
impl<'a, T> PartialOrd<&'a T> for Frequency<T>where
T: PartialOrd,
Source§impl<'a, T> PartialOrd<&'a mut T> for Frequency<T>where
T: PartialOrd,
impl<'a, T> PartialOrd<&'a mut T> for Frequency<T>where
T: PartialOrd,
Source§impl<T> PartialOrd<T> for Frequency<T>where
T: PartialOrd,
impl<T> PartialOrd<T> for Frequency<T>where
T: PartialOrd,
Source§impl<T: PartialOrd> PartialOrd for Frequency<T>
impl<T: PartialOrd> PartialOrd for Frequency<T>
Source§impl<'a, A, B> RemAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> RemAssign<&'a Frequency<B>> for Frequency<A>
Source§fn rem_assign(&mut self, rhs: &'a Frequency<B>)
fn rem_assign(&mut self, rhs: &'a Frequency<B>)
%=
operation. Read moreSource§impl<A, B> RemAssign<Frequency<B>> for Frequency<A>where
A: RemAssign<B>,
impl<A, B> RemAssign<Frequency<B>> for Frequency<A>where
A: RemAssign<B>,
Source§fn rem_assign(&mut self, rhs: Frequency<B>)
fn rem_assign(&mut self, rhs: Frequency<B>)
%=
operation. Read moreSource§impl<'a, A, B> ShlAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> ShlAssign<&'a Frequency<B>> for Frequency<A>
Source§fn shl_assign(&mut self, rhs: &'a Frequency<B>)
fn shl_assign(&mut self, rhs: &'a Frequency<B>)
<<=
operation. Read moreSource§impl<A, B> ShlAssign<Frequency<B>> for Frequency<A>where
A: ShlAssign<B>,
impl<A, B> ShlAssign<Frequency<B>> for Frequency<A>where
A: ShlAssign<B>,
Source§fn shl_assign(&mut self, rhs: Frequency<B>)
fn shl_assign(&mut self, rhs: Frequency<B>)
<<=
operation. Read moreSource§impl<'a, A, B> ShrAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> ShrAssign<&'a Frequency<B>> for Frequency<A>
Source§fn shr_assign(&mut self, rhs: &'a Frequency<B>)
fn shr_assign(&mut self, rhs: &'a Frequency<B>)
>>=
operation. Read moreSource§impl<A, B> ShrAssign<Frequency<B>> for Frequency<A>where
A: ShrAssign<B>,
impl<A, B> ShrAssign<Frequency<B>> for Frequency<A>where
A: ShrAssign<B>,
Source§fn shr_assign(&mut self, rhs: Frequency<B>)
fn shr_assign(&mut self, rhs: Frequency<B>)
>>=
operation. Read moreSource§impl<'a, A, B> SubAssign<&'a Frequency<B>> for Frequency<A>
impl<'a, A, B> SubAssign<&'a Frequency<B>> for Frequency<A>
Source§fn sub_assign(&mut self, rhs: &'a Frequency<B>)
fn sub_assign(&mut self, rhs: &'a Frequency<B>)
-=
operation. Read moreSource§impl<A, B> SubAssign<Frequency<B>> for Frequency<A>where
A: SubAssign<B>,
impl<A, B> SubAssign<Frequency<B>> for Frequency<A>where
A: SubAssign<B>,
Source§fn sub_assign(&mut self, rhs: Frequency<B>)
fn sub_assign(&mut self, rhs: Frequency<B>)
-=
operation. Read moreimpl<T: Copy> Copy for Frequency<T>
impl<T: Eq> Eq for Frequency<T>
impl<T> StructuralPartialEq for Frequency<T>
Auto Trait Implementations§
impl<T> Freeze for Frequency<T>where
T: Freeze,
impl<T> RefUnwindSafe for Frequency<T>where
T: RefUnwindSafe,
impl<T> Send for Frequency<T>where
T: Send,
impl<T> Sync for Frequency<T>where
T: Sync,
impl<T> Unpin for Frequency<T>where
T: Unpin,
impl<T> UnwindSafe for Frequency<T>where
T: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<K, S> Identity<K> for Swhere
S: Borrow<K>,
K: Identifier,
impl<K, S> Identity<K> for Swhere
S: Borrow<K>,
K: Identifier,
Source§impl<A, B, C> PyMod<B> for Awhere
A: Rem<B, Output = C>,
B: Copy + PartialOrd + Zero,
C: PartialOrd + Zero<Output = C> + Add<B>,
impl<A, B, C> PyMod<B> for Awhere
A: Rem<B, Output = C>,
B: Copy + PartialOrd + Zero,
C: PartialOrd + Zero<Output = C> + Add<B>,
Source§impl<R> Rng for R
impl<R> Rng for R
Source§fn random<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
fn random<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
StandardUniform
distribution. Read moreSource§fn random_iter<T>(self) -> Iter<StandardUniform, Self, T>
fn random_iter<T>(self) -> Iter<StandardUniform, Self, T>
Source§fn random_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
fn random_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
Source§fn random_bool(&mut self, p: f64) -> bool
fn random_bool(&mut self, p: f64) -> bool
p
of being true. Read moreSource§fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool
fn random_ratio(&mut self, numerator: u32, denominator: u32) -> bool
numerator/denominator
of being
true. Read moreSource§fn sample<T, D>(&mut self, distr: D) -> Twhere
D: Distribution<T>,
fn sample<T, D>(&mut self, distr: D) -> Twhere
D: Distribution<T>,
Source§fn sample_iter<T, D>(self, distr: D) -> Iter<D, Self, T>where
D: Distribution<T>,
Self: Sized,
fn sample_iter<T, D>(self, distr: D) -> Iter<D, Self, T>where
D: Distribution<T>,
Self: Sized,
Source§fn gen<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
fn gen<T>(&mut self) -> Twhere
StandardUniform: Distribution<T>,
random
to avoid conflict with the new gen
keyword in Rust 2024.Rng::random
.Source§fn gen_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
fn gen_range<T, R>(&mut self, range: R) -> Twhere
T: SampleUniform,
R: SampleRange<T>,
random_range
Rng::random_range
.Source§impl<R> TryRngCore for R
impl<R> TryRngCore for R
Source§type Error = Infallible
type Error = Infallible
Source§fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>
fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>
u32
.Source§fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>
fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>
u64
.Source§fn try_fill_bytes(
&mut self,
dst: &mut [u8],
) -> Result<(), <R as TryRngCore>::Error>
fn try_fill_bytes( &mut self, dst: &mut [u8], ) -> Result<(), <R as TryRngCore>::Error>
dest
entirely with random data.Source§fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>
fn unwrap_mut(&mut self) -> UnwrapMut<'_, Self>
UnwrapMut
wrapper.Source§fn read_adapter(&mut self) -> RngReadAdapter<'_, Self>where
Self: Sized,
fn read_adapter(&mut self) -> RngReadAdapter<'_, Self>where
Self: Sized,
RngCore
to a RngReadAdapter
.