Struct lattice_qcd_rs::utils::FactorialStorageDyn

pub struct FactorialStorageDyn { /* private fields */ }

Dynamical size factorial storage.

Used as a lazy cache for factorial number. This is not actually used and might be removed later.

Implementations

impl FactorialStorageDyn

pub const fn new() -> Self

Create a new object with an empty storage.

pub fn build_storage(&mut self, value: usize)

Build the storage up to and including value.

#Example

let mut f = FactorialStorageDyn::new();
f.build_storage(6);
assert_eq!(*f.try_factorial(6).unwrap(), 720);

pub fn factorial(&mut self, value: usize) -> u128

Get the factorial number. If it is not already computed build internal storage

Panic

panic if value is greater than MAX_NUMBER_FACTORIAL (34) in debug, overflows otherwise.

Example

let mut f = FactorialStorageDyn::new();
assert_eq!(f.factorial(6), 720);
assert_eq!(f.factorial(4), 24);

pub fn try_factorial(&self, value: usize) -> Option<&u128>

try get factorial from storage

#Example

let mut f = FactorialStorageDyn::new();
assert_eq!(f.factorial(4), 24);
assert_eq!(*f.try_factorial(4).unwrap(), 24);
assert_eq!(f.try_factorial(6), None);

pub fn factorial_no_storage(&self, value: usize) -> u128

Get factorial but does build the storage if it is missing #Example

let mut f = FactorialStorageDyn::new();
assert_eq!(f.factorial(4), 24);
assert_eq!(f.factorial_no_storage(6), 720);
assert_eq!(f.try_factorial(6), None);

Trait Implementations

impl Clone for FactorialStorageDyn

fn clone(&self) -> FactorialStorageDyn

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FactorialStorageDyn

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

Formats the value using the given formatter.

impl Default for FactorialStorageDyn

fn default() -> Self

Returns the “default value” for a type.

impl Hash for FactorialStorageDyn

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 PartialEq<FactorialStorageDyn> for FactorialStorageDyn

fn eq(&self, other: &FactorialStorageDyn) -> 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 Eq for FactorialStorageDyn

impl StructuralEq for FactorialStorageDyn

impl StructuralPartialEq for FactorialStorageDyn