Trait ark_std::One

source ·

pub trait One: Sized + Mul<Self, Output = Self> {
    fn one() -> Self;

    fn set_one(&mut self) { ... }
    fn is_one(&self) -> bool
    where
        Self: PartialEq<Self>,
    { ... }
}

Expand description

Defines a multiplicative identity element for Self.

Laws

a * 1 = a       ∀ a ∈ Self
1 * a = a       ∀ a ∈ Self

Required Methods§

source

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

Purity

This function should return the same result at all times regardless of external mutable state, for example values stored in TLS or in static muts.

Provided Methods§

source

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

source

fn is_one(&self) -> boolwhere
Self: PartialEq<Self>,

Returns true if self is equal to the multiplicative identity.

For performance reasons, it’s best to implement this manually. After a semver bump, this method will be required, and the where Self: PartialEq bound will be removed.