Struct twenty_first::shared_math::b_field_element::BFieldElement

source · [−]

pub struct BFieldElement(_);

Implementations

impl BFieldElement

pub const QUOTIENT: u64 = 18_446_744_069_414_584_321u64

pub const MAX: u64 = 18_446_744_069_414_584_320u64

pub const fn new(value: u64) -> Self

pub fn value(&self) -> u64

pub fn power_accumulator<const N: usize, const M: usize>(
base: [Self; N],
tail: [Self; N]
) -> [Self; N]

Square the base M times and multiply the result by the tail value

pub fn generator() -> Self

Get a generator for the entire field

pub fn lift(&self) -> XFieldElement

pub fn increment(&mut self)

pub fn decrement(&mut self)

pub fn mod_pow(&self, exp: u64) -> Self

pub fn legendre_symbol(&self) -> i8

pub fn from_byte_array<const N: usize>(input: [u8 ; N]) -> Vec<Self>

Convert a byte array to a vector of B field elements

Trait Implementations

impl Add<BFieldElement> for BFieldElement

type Output = BFieldElement

The resulting type after applying the + operator.

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

Performs the + operation. Read more

impl AddAssign<BFieldElement> for BFieldElement

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more

impl Clone for BFieldElement

fn clone(&self) -> BFieldElement

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 CyclicGroupGenerator for BFieldElement

fn get_cyclic_group_elements(&self, max: Option<usize>) -> Vec<Self>

impl Debug for BFieldElement

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

Formats the value using the given formatter. Read more

impl Default for BFieldElement

fn default() -> BFieldElement

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

impl<'de> Deserialize<'de> for BFieldElement

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for BFieldElement

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

Formats the value using the given formatter. Read more

impl Div<BFieldElement> for BFieldElement

type Output = BFieldElement

The resulting type after applying the / operator.

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

Performs the / operation. Read more

impl FiniteField for BFieldElement

fn batch_inversion(input: Vec<Self>) -> Vec<Self>

Montgomery Batch Inversion

fn square(self) -> Self

impl From<&BFieldElement> for u64

fn from(elem: &BFieldElement) -> Self

Converts to this type from the input type.

impl From<[u8 ; 8]> for BFieldElement

fn from(array: [u8 ; 8]) -> Self

Converts to this type from the input type.

impl From<BFieldElement> for [u8 ; 8]

Convert a B-field element to a byte array. The client uses this for its database.

fn from(bfe: BFieldElement) -> Self

Converts to this type from the input type.

impl From<BFieldElement> for u64

fn from(elem: BFieldElement) -> Self

Converts to this type from the input type.

impl From<u32> for BFieldElement

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<u64> for BFieldElement

fn from(value: u64) -> Self

Converts to this type from the input type.

impl FromVecu8 for BFieldElement

fn from_vecu8(bytes: Vec<u8>) -> Self

impl GetRandomElements for BFieldElement

fn random_elements<R: Rng>(length: usize, prng: &mut R) -> Vec<Self>

impl Hash for BFieldElement

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl Hashable<BFieldElement> for [BFieldElement ; 5]

fn to_sequence(&self) -> Vec<BFieldElement>

impl Hashable<BFieldElement> for BFieldElement

fn to_sequence(&self) -> Vec<BFieldElement>

impl Hashable<BFieldElement> for Vec<BFieldElement>

fn to_sequence(&self) -> Vec<BFieldElement>

impl Hashable<BFieldElement> for XFieldElement

fn to_sequence(&self) -> Vec<BFieldElement>

impl Hashable<BFieldElement> for u128

fn to_sequence(&self) -> Vec<BFieldElement>

impl Hashable<BFieldElement> for usize

fn to_sequence(&self) -> Vec<BFieldElement>

impl Hashable<u8> for BFieldElement

fn to_sequence(&self) -> Vec<u8>

impl Inverse for BFieldElement

fn inverse(&self) -> Self

impl ModPowU32 for BFieldElement

fn mod_pow_u32(&self, exp: u32) -> Self

impl ModPowU64 for BFieldElement

fn mod_pow_u64(&self, pow: u64) -> Self

impl Mul<BFieldElement> for BFieldElement

type Output = BFieldElement

The resulting type after applying the * operator.

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

Performs the * operation. Read more

impl MulAssign<BFieldElement> for BFieldElement

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation. Read more

impl Neg for BFieldElement

type Output = BFieldElement

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation. Read more

impl New for BFieldElement

fn new_from_usize(&self, value: usize) -> Self

impl One for BFieldElement

fn one() -> Self

Returns the multiplicative identity element of Self, 1. Read more

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity. Read more

fn set_one(&mut self)

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

impl PartialEq<BFieldElement> for BFieldElement

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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. Read more

impl PrimitiveRootOfUnity for BFieldElement

fn primitive_root_of_unity(n: u64) -> Option<BFieldElement>

impl Rem<BFieldElement> for BFieldElement

type Output = BFieldElement

The resulting type after applying the % operator.

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

Performs the % operation. Read more

impl SamplableFrom<Vec<BFieldElement, Global>> for BFieldElement

fn sample(digest: &Vec<BFieldElement>) -> Self

impl SamplableFrom<Vec<u8, Global>> for BFieldElement

Sample pseudo-uniform BFieldElement from vector of uniform bytes. Statistical distance from uniform: ~2^{-64}.

fn sample(digest: &Vec<u8>) -> Self

impl Serialize for BFieldElement

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Sub<BFieldElement> for BFieldElement

type Output = BFieldElement

The resulting type after applying the - operator.

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

Performs the - operation. Read more

impl SubAssign<BFieldElement> for BFieldElement

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more

impl Sum<BFieldElement> for BFieldElement

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

impl ToVec<BFieldElement> for [BFieldElement ; 5]

fn to_vec(&self) -> Vec<BFieldElement>

impl ToVec<BFieldElement> for Vec<BFieldElement>

fn to_vec(&self) -> Vec<BFieldElement>

impl TryFrom<BFieldElement> for u32

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: BFieldElement) -> Result<Self, Self::Error>

Performs the conversion.

impl Zero for BFieldElement

fn zero() -> Self

Returns the additive identity element of Self, 0. Read more

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for BFieldElement

impl Eq for BFieldElement

Auto Trait Implementations

impl RefUnwindSafe for BFieldElement

impl Send for BFieldElement

impl Sync for BFieldElement

impl Unpin for BFieldElement

impl UnwindSafe for BFieldElement

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

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> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for Twhere
T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,

impl<T, Rhs, Output> NumOps<Rhs, Output> for Twhere
T: Mul<Rhs, Output = Output> + Div<Rhs, Output = Output> + Rem<Rhs, Output = Output> + Add<Rhs, Output = Output> + Sub<Rhs, Output = Output>,